Skip to content

Commit ba63f13

Browse files
committed
Update playSFX syntax
1 parent 4d72504 commit ba63f13

File tree

1 file changed

+26
-5
lines changed

1 file changed

+26
-5
lines changed

functions/Audio/playSFX.yaml

Lines changed: 26 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,12 @@ client:
1515
- name: containerName
1616
type: string
1717
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
2219
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.
2424
- name: looped
2525
type: bool
2626
description: A [[boolean]] representing whether the sound will be looped.
@@ -30,6 +30,27 @@ client:
3030
- type: sound
3131
name: sound-element
3232
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.
3354
examples:
3455
- path: examples/playSFX-1.lua
3556
description: The following example plays a firealarm sound (looped).

0 commit comments

Comments
 (0)