Sound Lua API: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
mNo edit summary |
||
Line 25: | Line 25: | ||
'''Docs last hacked together on''': 10/11/2017 11:07 | '''Docs last hacked together on''': 10/11/2017 11:07 | ||
[[ | [[Category:Modding]][[Category:LuaAPI]] |
Revision as of 12:27, 10 November 2017
Sound
Description
The sound API allows modders to trigger sound events in game
Functions
TriggerEvent
Sound.TriggerEvent(eventName, sourceName)
Expected parameter types
Name | Type |
---|---|
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
This file is auto generated, please don't edit manually!
Docs last hacked together on: 10/11/2017 11:07