Sound Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 24: 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''': 10/11/2017 11:07
'''Docs last hacked together on''': 06/09/2018 14:53
[[Category:Modding]][[Category:LuaAPI]]
[[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