You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: functions/Audio/playSFX.yaml
+26-5Lines changed: 26 additions & 5 deletions
Original file line number
Diff line number
Diff line change
@@ -15,12 +15,12 @@ client:
15
15
- name: containerName
16
16
type: string
17
17
description: The name of the audio container. Possible values are "feet", "genrl", "pain_a", "script", "spc_ea", "spc_fa", "spc_ga", spc_na", "spc_pa", "radio".
18
-
- name: bankId/radioStation
19
-
type: int/string
20
-
description: The audio bank id. If <b>containerName</b> is "radio", then this argument is of type [[string]] and specifies the radio station name. Possible values "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".
21
-
- name: soundId/trackId
18
+
- name: bankId
22
19
type: int
23
-
description: The sound id within the audio bank. If <b>containerName</b> is "radio", then this argument specifies the radio track id within the radio station audio file.
20
+
description: The audio bank id.
21
+
- name: soundId
22
+
type: int
23
+
description: The sound id within the audio bank.
24
24
- name: looped
25
25
type: bool
26
26
description: A [[boolean]] representing whether the sound will be looped.
@@ -30,6 +30,27 @@ client:
30
30
- type: sound
31
31
name: sound-element
32
32
description: Returns a [[sound]] element if the sound was successfully created, false otherwise.
33
+
syntaxes:
34
+
- name: playSFX
35
+
parameters:
36
+
- name: "\"radio\""
37
+
type: string
38
+
description: The string "radio" (used to differentiate to the first syntax).
39
+
- name: radioStation
40
+
type: string
41
+
description: The radio station. Possible values are "Adverts", "Ambience", "Police", "Playback FM", "K-Rose", "K-DST", "Cutscene", "Beats", "Bounce FM", "SF-UR", "Radio Los Santos", "Radio X", "CSR 103.9", "K-Jah West", "Master Sounds 98.3", "WCTR".
42
+
- name: trackId
43
+
type: int
44
+
description: The radio track id within the radio station audio file.
45
+
- name: looped
46
+
type: bool
47
+
description: A [[boolean]] representing whether the sound will be looped.
48
+
default: 'false'
49
+
returns:
50
+
values:
51
+
- type: sound
52
+
name: sound-element
53
+
description: Returns a [[sound]] element if the sound was successfully created, false otherwise.
33
54
examples:
34
55
- path: examples/playSFX-1.lua
35
56
description: The following example plays a firealarm sound (looped).
0 commit comments