Sound Lua API: Difference between revisions
Jump to navigation
Jump to search
No edit summary |
No edit summary |
||
Line 8: | Line 8: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| eventName || string | | eventName || string | ||
Line 22: | Line 24: | ||
This file is auto generated, please don't edit manually! | This file is auto generated, please don't edit manually! | ||
'''Docs last hacked together on''': | '''Docs last hacked together on''': 10/11/2017 11:07 | ||
[[Catagory:Modding]][[Catagory:LuaAPI]] | |||
[[ | |||
[[ |
Revision as of 11:54, 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 Catagory:ModdingCatagory:LuaAPI