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) |
(Update) |
||
Line 1: | Line 1: | ||
<!-- This file is auto generated, please don't edit manually! --> | |||
= Sound = | = Sound = | ||
== Description == | == Description == | ||
Line 17: | Line 18: | ||
'''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''': 13/09/2017 14:00 |
Revision as of 13:03, 13 September 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
This file is auto generated, please don't edit manually!
Docs last hacked together on: 13/09/2017 14:00