Sound Lua API

From Off Grid Wiki
Revision as of 12:03, 9 May 2017 by Harry (talk | contribs) (Add sound lua api documentation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

StopAudio

Sound.StopAudio(audioID)

Expected parameter types

audioID number

Description: Stops a playing audio track

Returns: Nothing


Docs last hacked together on: 09/05/2017 12:59