Sound Lua API: Difference between revisions
Jump to navigation
Jump to search
m (Rich moved page Lua Apis/Sound Lua API to Sound Lua API without leaving a redirect: removing sub-pages) |
No edit summary |
||
| (4 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | |||
= Sound = | = Sound = | ||
== Description == | == Description == | ||
| Line 7: | Line 8: | ||
'''Expected parameter types''' | '''Expected parameter types''' | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |||
! Name !! Type | |||
|- | |- | ||
| eventName || string | | eventName || string | ||
| Line 17: | Line 20: | ||
'''Notes''': If _sourceName_ is not provided the sound will be played as a '2D' event | '''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''': 09/ | '''Docs last hacked together on''': 06/09/2018 14:53 | ||
[[Category:Modding]][[Category:LuaAPI]] | |||
Revision as of 14:20, 6 September 2018
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: 06/09/2018 14:53