StartSound flags

Note: This page is meant to be included into other pages that describe sound functions, such as A_StartSound, using the {{: StartSound flags}} syntax. (This note will not be included.)

Adjusts how the sound is played. Multiple flags can be combined with |:

• CHANF_DEFAULT — No flags. Default.
• CHANF_LISTENERZ — Play the sound from the listener's Z position instead of the caller's.
• CHANF_MAYBE_LOCAL — Sound is subject to compat_silentpickup and will not play if started by an actor other than the listener when the compatibility flag is enabled.
• CHANF_UI — Sound isn't preserved in saves and will play while the game is paused.
• CHANF_NOPAUSE — Don't pause the sound.
• CHANF_LOOP — Loops the sound.
• CHANF_OVERLAP — Don't stop any sounds in the channel and instead play over them.
• CHANF_LOCAL — Only play the sound if the listener is the one doing so.
• CHANF_NOSTOP — If the channel is occupied, do not play the sound.
• CHANF_TRANSIENT — Sound isn't preserved in saves.
• CHANF_FORCE — Play the sound even if it will be immediately paused upon doing so.
• CHANF_SINGULAR — Only play the sound if it isn't already being played by something. (This flag is marked with <noinclude> in this template, because it's not fully exported. Plus there's A_StartSoundIfNotSame)
• CHANF_LOOPING — Combines CHANF_LOOP and CHANF_NOSTOP. It is equivalent to the looping parameter of A_PlaySound.