Sound Lua API: Difference between revisions

From Off Grid Wiki
Jump to navigation Jump to search
(Update)
No edit summary
Line 23: Line 23:


'''Docs last hacked together on''': 13/09/2017 14:00
'''Docs last hacked together on''': 13/09/2017 14:00
[[Category:Modding]]
[[Category:LuaAPI]]

Revision as of 10:16, 3 November 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