Revision as of 13:03, 13 September 2017

Sound

The sound API allows modders to trigger sound events in game

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

@@ Line 1: / Line 1: @@
+<!-- This file is auto generated, please don't edit manually! -->
 = Sound =
 == Description ==
@@ Line 17: / Line 18: @@
 '''Notes''': If _sourceName_ is not provided the sound will be played as a '2D' event
-=== StopAudio ===
-<syntaxhighlight source lang="lua">Sound.StopAudio(audioID)</syntaxhighlight>
-'''Expected parameter types'''
-{| class="wikitable"
-|-
-| audioID || number
-|}
-'''Description''': Stops a playing audio track
-'''Returns''': Nothing
+This file is auto generated, please don't edit manually!
-'''Docs last hacked together on''': 09/05/2017 13:17
+'''Docs last hacked together on''': 13/09/2017 14:00