Functions
function	delete_on_death_wait (ent, sounddone)

function	loop_delete (ender, ent)

function	loop_fx_sound (alias, origin, ender)

function	loop_in_space (alias, origin, ender)

function	loop_on_entity (alias, offset)

function	loop_on_tag (alias, tag, bStopSoundOnDeath)

function	play_in_space (alias, origin, master)

function	play_on_entity (alias)

function	play_on_players (sound, team)

function	play_on_tag (alias, tag, ends_on_death)

function	stop_loop_on_entity (alias)

function	wait_for_sounddone_or_death (org)

Function Documentation

◆ delete_on_death_wait()

function delete_on_death_wait	(	ent	,
		sounddone
	)

Definition at line 242 of file sound_shared.gsc.

Referenced by play_on_tag().

◆ loop_delete()

function loop_delete	(	ender	,
		ent
	)

Definition at line 19 of file sound_shared.gsc.

Referenced by loop_fx_sound().

◆ loop_fx_sound()

function loop_fx_sound	(	alias	,
		origin	,
		ender
	)

Definition at line 7 of file sound_shared.gsc.

References loop_delete(), and Spawn().

◆ loop_in_space()

function loop_in_space	(	alias	,
		origin	,
		ender
	)

Definition at line 223 of file sound_shared.gsc.

References Spawn().

Referenced by elevator_looping_sounds().

◆ loop_on_entity()

function loop_on_entity	(	alias	,
		offset
	)

Description:
"Function Name: loop_on_entity( <alias> , <offset> )"
"Summary: Play loop sound alias on an entity" "Module: Sound" "CallOn: An entity"
"Mandatory Argument(s): <alias> : Sound alias to loop"
"Optional Argument(s): <offset> : Offset for sound origin relative to the world from the models origin."
"Example:vehicle thread sound::loop_on_entity( "engine_belt_run" );"
"Single Player / Multi Player: singleplayer"

Definition at line 198 of file sound_shared.gsc.

References delete_on_death(), and Spawn().

◆ loop_on_tag()

function loop_on_tag	(	alias	,
		tag	,
		bStopSoundOnDeath
	)

Description:
"Function Name: loop_on_tag( <alias> , <tag>, bStopSoundOnDeath )"
"Summary: Play the specified looping sound alias on a tag of an entity" "Module: Sound" "CallOn: An entity"
"Mandatory Argument(s): <alias> : Sound alias to loop"
"Optional Argument(s): <tag> : Tag on the entity to play sound on. If no tag is specified the entities origin will be used."
"Optional Argument(s): <bStopSoundOnDeath> : Defaults to true. If true, will stop the looping sound when self dies"
"Example:vehicle thread loop_on_tag( "engine_belt_run", "tag_engine" );"
"Single Player / Multi Player: singleplayer"

Definition at line 66 of file sound_shared.gsc.

References delete_on_death(), and Spawn().

Referenced by death_firesound().

◆ play_in_space()

function play_in_space	(	alias	,
		origin	,
		master
	)

Description:
"Function Name: play_in_space( <alias> , <origin> )"
"Summary: Stop playing the the loop sound alias on an entity" "Module: Sound" "CallOn: Level"
"Mandatory Argument(s): <alias> : Sound alias to play"
"Mandatory Argument(s): <origin> : Origin of the sound"
"Example:sound::play_in_space( "siren", level.speaker.origin );"

Definition at line 36 of file sound_shared.gsc.

References Spawn().

◆ play_on_entity()

function play_on_entity ( alias )

Description:
"Function Name: play_on_entity( <alias> )"
"Summary: Play the specified sound alias on an entity at it's origin" "Module: Sound" "CallOn: An entity"
"Mandatory Argument(s): <alias> : Sound alias to play"
"Example:guy sound::play_on_entity( "breathing_better" );"
"Single Player / Multi Player: singleplayer"

Definition at line 161 of file sound_shared.gsc.

References play_on_tag().

◆ play_on_players()

function play_on_players	(	sound	,
		team
	)

Definition at line 257 of file sound_shared.gsc.

Referenced by announce_round_winner(), flagCapturedFromNeutral(), KothMainLoop(), onDrop(), onUsePlantObject(), onZoneCapture(), and onZoneContested().

◆ play_on_tag()

function play_on_tag	(	alias	,
		tag	,
		ends_on_death
	)

Description:
"Function Name: play_on_tag( <alias> , <tag>, <ends_on_death> )"
"Summary: Play the specified sound alias on a tag of an entity" "Module: Sound" "CallOn: An entity"
"Mandatory Argument(s): <alias> : Sound alias to play"
"Optional Argument(s): <tag> : Tag on the entity to play sound on. If no tag is specified the entities origin will be used."
"Optional Argument(s): <ends_on_death> : The sound will be cut short if the entity dies. Defaults to false."
"Example:vehicle thread sound::play_on_tag( "horn_honk", "tag_engine" );"
"Single Player / Multi Player: singleplayer"

Definition at line 109 of file sound_shared.gsc.

References delete_on_death_wait(), Spawn(), wait_for_sounddone_or_death(), and WAIT_SERVER_FRAME.

Referenced by HandleDogSoundNoteTracks(), and play_on_entity().

◆ stop_loop_on_entity()

function stop_loop_on_entity ( alias )

Description:
"Function Name: stop_loop_on_entity( <alias> )"
"Summary: Stop playing the the loop sound alias on an entity" "Module: Sound" "CallOn: An entity"
"Mandatory Argument(s): <alias> : Sound alias to stop looping"
"Example:vehicle thread sound::stop_loop_on_entity( "engine_belt_run" );"
"Single Player / Multi Player: singleplayer"

Definition at line 182 of file sound_shared.gsc.

◆ wait_for_sounddone_or_death()

function wait_for_sounddone_or_death ( org )

Definition at line 166 of file sound_shared.gsc.