Sound Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(removing DocStart tag)
m (Rich moved page Lua Apis/Sound Lua API to Sound Lua API without leaving a redirect: removing sub-pages)
(No difference)

Revision as of 16:57, 26 June 2017

Sound

Description

The sound API allows modders to trigger sound events in game

Functions

TriggerEvent

Sound.TriggerEvent(eventName, sourceName)

Expected parameter types

eventName string
sourceName string

Description: Triggers a sound even with name eventName

Returns: The event id, this can be used in other sound API functions (see StopAudio)

Notes: If _sourceName_ is not provided the sound will be played as a '2D' event

StopAudio

Sound.StopAudio(audioID)

Expected parameter types

audioID number

Description: Stops a playing audio track

Returns: Nothing


Docs last hacked together on: 09/05/2017 13:17