Skip to main content

Speaker.CreateOnPosition

Creates a speaker in a specified XYZ position.

Syntaxโ€‹

Speaker.CreateOnPosition "speaker_name" x y z volume? min_distance? max_distance? is_stereo? @target_players? update_target_players?

Argumentsโ€‹

NameRequiredTypeDescription
speaker nameYesAny text e.g. "Hello, World!"
xYesAny number
yYesAny number
zYesAny number
volumeNoA number bigger or equal 0%The volume of the audio.
min distanceNoA number bigger or equal 0The minimum distance for full-volume audio.
max distanceNoA number bigger or equal 0The maximum audible distance for the audio.
is stereoNobool (true or false) valueWhether the audio will be 3D.
target playersNoPlayer variable (e.g. @all, @classDPlayers)only these players will hear the audio.
update target playersNobool (true or false) valueWhether to constantly refresh the value provided in the 'target players' argument.

On a running serverโ€‹

Use serhelp Speaker.CreateOnPosition to inspect the reference generated by your installed SER version.