sound_token

Vars
cell_tracker	Cell tracker managing spatial grid cells within range of the source. The wizards say this is the fastest.
falloff_distance	Sound falloff distance
falloff_exponent	Sound falloff
listeners	k:v list of mob : sound status
null_sound	Null sound for cancelling the sound entirely.
range	Sound maximum range
sound	The master copy of the playing sound.
sound_channel	The channel being used.
sound_duration	Duration of the current sound file in deciseconds. Used to wrap offset for looping sounds.
sound_status	Status of the playing sound
source	The atom playing the sound.
start_time	world.time when the sound started (or when the sound file was last changed). Used to calculate playback offset for new listeners.
volume	Sound volume
Procs
add_listener	Adds a listener to the sound.
add_or_update_listener	Updates the data of a listener, or adds them if they are not present.
calculate_offset	Calculates the offset to give the sound for people who start hearing it mid-play
listener_deafness_update	Respond to TRAIT_DEAF addition/removal
on_cell_client_entered	Signal handler for SPATIAL_GRID_CELL_ENTERED on tracked cells. Adds newly arriving mobs as listeners.
on_cell_client_exited	Signal handler for SPATIAL_GRID_CELL_EXITED on tracked cells. Removes mobs who have left all member cells.
on_enter_area	Update env when source is entering new area
player_login	Respond to any mob in the world being logged into. Only adds if the mob is within range.
player_logout	Respond to any cliented mob becoming uncliented
remove_listener	Remove a listener from the sound.
set_listener_status	Set the status of a listener. Does not update the sound.
set_volume	Setter for volume
source_moved	If the sound source moves, update tracked cells then refresh all listener positions.
update_sound	Lets us update the sound to a new one.
update_tracked_cells	Update tracked cells; happens on movement. We need to check if anyone is now out of cell range and kick them out.

Var Details

var
cell_tracker
– /datum/cell_tracker

Cell tracker managing spatial grid cells within range of the source. The wizards say this is the fastest.

var
falloff_distance

Sound falloff distance

var
falloff_exponent

Sound falloff

var
listeners
– /list

k:v list of mob : sound status

var
null_sound
– /sound

Null sound for cancelling the sound entirely.

var
range

Sound maximum range

var
sound
– /sound

The master copy of the playing sound.

var
sound_channel

The channel being used.

var
sound_duration

Duration of the current sound file in deciseconds. Used to wrap offset for looping sounds.

var
sound_status

Status of the playing sound

var
source
– /atom

The atom playing the sound.

var
start_time

world.time when the sound started (or when the sound file was last changed). Used to calculate playback offset for new listeners.

var
volume

Sound volume

Proc Details

proc
add_listener
(/mob/listener_mob)

Adds a listener to the sound.

proc
add_or_update_listener
(/mob/listener_mob)

Updates the data of a listener, or adds them if they are not present.

proc
calculate_offset
()

Calculates the offset to give the sound for people who start hearing it mid-play

proc
listener_deafness_update
(/atom/movable/source)

Respond to TRAIT_DEAF addition/removal

proc
on_cell_client_entered
(/datum/source, /list/entering_mobs)

Signal handler for SPATIAL_GRID_CELL_ENTERED on tracked cells. Adds newly arriving mobs as listeners.

proc
on_cell_client_exited
(/datum/source, /list/exiting_mobs)

Signal handler for SPATIAL_GRID_CELL_EXITED on tracked cells. Removes mobs who have left all member cells.

proc
on_enter_area
(/datum/source, /area/area_to_register)

Update env when source is entering new area

proc
player_login
(/datum/source, /mob/player)

Respond to any mob in the world being logged into. Only adds if the mob is within range.

proc
player_logout
(/datum/source, /mob/player)

Respond to any cliented mob becoming uncliented

proc
remove_listener
(/mob/listener_mob)

Remove a listener from the sound.

proc
set_listener_status
(/mob/listener_mob, new_status)

Set the status of a listener. Does not update the sound.

proc
set_volume
(new_volume, update_listeners)

Setter for volume

proc
source_moved
()

If the sound source moves, update tracked cells then refresh all listener positions.

proc
update_sound
(_sound, start_playing)

Lets us update the sound to a new one.

proc
update_tracked_cells
()

Update tracked cells; happens on movement. We need to check if anyone is now out of cell range and kick them out.

sound_token /datum/sound_token

Vars

Procs

Var Details

var cell_tracker – /datum/cell_tracker

var falloff_distance

var falloff_exponent

var listeners – /list

var null_sound – /sound

var range

var sound – /sound

var sound_channel

var sound_duration

var sound_status

var source – /atom

var start_time

var volume

Proc Details

proc add_listener(/mob/listener_mob)

proc add_or_update_listener(/mob/listener_mob)

proc calculate_offset()

proc listener_deafness_update(/atom/movable/source)

proc on_cell_client_entered(/datum/source, /list/entering_mobs)

proc on_cell_client_exited(/datum/source, /list/exiting_mobs)

proc on_enter_area(/datum/source, /area/area_to_register)

proc player_login(/datum/source, /mob/player)

proc player_logout(/datum/source, /mob/player)

proc remove_listener(/mob/listener_mob)

proc set_listener_status(/mob/listener_mob, new_status)

proc set_volume(new_volume, update_listeners)

proc source_moved()

proc update_sound(_sound, start_playing)

proc update_tracked_cells()