Difference between revisions of "Sound Lua API"

From Off Grid Wiki
Jump to navigation Jump to search
Line 20: Line 20:
  
 
'''Notes''': If _sourceName_ is not provided the sound will be played as a '2D' event
 
'''Notes''': If _sourceName_ is not provided the sound will be played as a '2D' event
 +
=== SetRTPC ===
 +
<syntaxhighlight source lang="lua">Sound.SetRTPC(sourceName, RTPCName, value)</syntaxhighlight>
 +
'''Expected parameter types'''
 +
{| class="wikitable"
 +
|-
 +
! Name !! Type
 +
|-
 +
| sourceName || string
 +
|-
 +
| RTPCName || string
 +
|-
 +
| value || number
 +
|}
 +
'''Description''': Set Real-Time Parameter Curve for an audio event playign on this object
 +
 +
'''Returns''': Nothing
 +
 +
'''Notes''': You need to have started an audio event on this object before tryign to use SetRTPC, and that event must have RTPC control for something.
  
  
 
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''': 06/09/2018 14:53
+
'''Docs last hacked together on''': 15/11/2019 14:59
 
[[Category:Modding]][[Category:LuaAPI]]
 
[[Category:Modding]][[Category:LuaAPI]]

Revision as of 18:14, 19 November 2019

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

SetRTPC

Sound.SetRTPC(sourceName, RTPCName, value)

Expected parameter types

Name Type
sourceName string
RTPCName string
value number

Description: Set Real-Time Parameter Curve for an audio event playign on this object

Returns: Nothing

Notes: You need to have started an audio event on this object before tryign to use SetRTPC, and that event must have RTPC control for something.


This file is auto generated, please don't edit manually!

Docs last hacked together on: 15/11/2019 14:59