Sound Lua API

From Off Grid Wiki
Revision as of 12:27, 10 November 2017 by Steve (talk | contribs)
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

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: 10/11/2017 11:07