sounds

Vars
all_sounds	All valid sound files in the sound directory
channel_list	List of all channels as numbers
channel_random_low	lower iteration position - Incremented and looped to get "random" sound channels for normal sounds. The channel at this index is returned when asking for a random channel.
channel_reserve_high	higher reserve position - decremented and incremented to reserve sound channels, anything above this is reserved. The channel at this index is the highest unreserved channel.
precache_errors	Any errors from precaching.
random_channels_min	Amount of channels to reserve for random usage rather than reservations being allowed to reserve all channels. Also a nice safeguard for when someone screws up.
reserved_channels	Associative list of all reserved channels associated to their position. `"[channel_number]" =` index as number
sound_lengths	k:v list of file_path : length
sounds_to_precache	A list of sounds to cache upon initialize.
using_channels	Assoc list, `"[channel]" =` either the datum using it or TRUE for an unsafe-reserved (datumless reservation) channel
using_channels_by_datum	Assoc list datum = list(channel1, channel2, ...) for what channels something reserved.
Procs
available_channels_left	How many channels we have left.
cache_sounds	Cache a list of sound lengths.
free_channel	Frees a channel and updates the datastructure. Private proc.
free_datum_channels	Frees all the channels a datum is using.
free_datumless_channels	Frees all datumless channels
free_sound_channel	Removes a channel from using list.
get_sound_length	Cache and return a single sound.
random_available_channel	Random available channel, returns number
random_available_channel_text	Random available channel, returns text.
reserve_channel	Reserves a channel and updates the datastructure. Private proc.
reserve_sound_channel	Reserves a channel for a datum. Automatic cleanup only when the datum is deleted. Returns an integer for channel.
reserve_sound_channel_datumless	NO AUTOMATIC CLEANUP - If you use this, you better manually free it later! Returns an integer for channel.

Var Details

var
all_sounds
– /list

All valid sound files in the sound directory

var
channel_list
– /list

List of all channels as numbers

var
channel_random_low
–

lower iteration position - Incremented and looped to get "random" sound channels for normal sounds. The channel at this index is returned when asking for a random channel.

var
channel_reserve_high
–

higher reserve position - decremented and incremented to reserve sound channels, anything above this is reserved. The channel at this index is the highest unreserved channel.

var
precache_errors
– /list

Any errors from precaching.

var
random_channels_min
– /static

Amount of channels to reserve for random usage rather than reservations being allowed to reserve all channels. Also a nice safeguard for when someone screws up.

var
reserved_channels
– /list

Associative list of all reserved channels associated to their position. "[channel_number]" = index as number

var
sound_lengths
– /list

k:v list of file_path : length

var
sounds_to_precache
– /list

A list of sounds to cache upon initialize.

var
using_channels
– /list

Assoc list, "[channel]" = either the datum using it or TRUE for an unsafe-reserved (datumless reservation) channel

var
using_channels_by_datum
– /list

Assoc list datum = list(channel1, channel2, ...) for what channels something reserved.

Proc Details

proc
available_channels_left
()

How many channels we have left.

proc
cache_sounds
(/list/paths)

Cache a list of sound lengths.

proc
free_channel
(number)

Frees a channel and updates the datastructure. Private proc.

proc
free_datum_channels
(/datum/D)

Frees all the channels a datum is using.

proc
free_datumless_channels
()

Frees all datumless channels

proc
free_sound_channel
(channel)

Removes a channel from using list.

proc
get_sound_length
(file_path)

Cache and return a single sound.

proc
random_available_channel
()

Random available channel, returns number

proc
random_available_channel_text
()

Random available channel, returns text.

proc
reserve_channel
()

Reserves a channel and updates the datastructure. Private proc.

proc
reserve_sound_channel
(/datum/D)

Reserves a channel for a datum. Automatic cleanup only when the datum is deleted. Returns an integer for channel.

proc
reserve_sound_channel_datumless
()

NO AUTOMATIC CLEANUP - If you use this, you better manually free it later! Returns an integer for channel.

sounds /datum/controller/subsystem/sounds

Vars

Procs

Var Details

var all_sounds – /list

var channel_list – /list

var channel_random_low –

var channel_reserve_high –

var precache_errors – /list

var random_channels_min – /static

var reserved_channels – /list

var sound_lengths – /list

var sounds_to_precache – /list

var using_channels – /list

var using_channels_by_datum – /list

Proc Details

proc available_channels_left()

proc cache_sounds(/list/paths)

proc free_channel(number)

proc free_datum_channels(/datum/D)

proc free_datumless_channels()

proc free_sound_channel(channel)

proc get_sound_length(file_path)

proc random_available_channel()

proc random_available_channel_text()

proc reserve_channel()

proc reserve_sound_channel(/datum/D)

proc reserve_sound_channel_datumless()