Sound Lua API: Difference between revisions
Jump to navigation
Jump to search
m (Rich moved page Sound Lua API to Lua Apis/Sound Lua API without leaving a redirect: adding sub-pages) |
(adding DocStart) |
||
Line 1: | Line 1: | ||
{{OffGridDocStart}} | |||
= Sound = | = Sound = | ||
== Description == | == Description == |
Revision as of 17:23, 22 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