StopSound

From Eternity Wiki
Jump to navigationJump to search

Description[edit]

This is an ACS built-in function.

Stop sounds from playing from things.

Usage[edit]

void StopSound(int tid[, int channel])

Parameters[edit]

  • tid: TID of things to stop sound sequence
  • channel: from which channel to cancel the sounds, and it can be one of the following:
  • CHAN_AUTO
  • CHAN_WEAPON
  • CHAN_VOICE
  • CHAN_ITEM
  • CHAN_BODY
  • CHAN_5
  • CHAN_6
  • CHAN_7

Return value[edit]

Examples[edit]

No examples given.

Notes[edit]

Beware that the StopSound function defaults channel (if omitted) to CHAN_BODY, but the most common channel for sounds played from EDF is CHAN_AUTO, so most of the time you'll want to specify channel as such.

This function's identification in zspecial.acs is: -62:StopSound(1,2).

See also[edit]