Editing PlaySoundEx

From Eternity Wiki
Jump to: navigation, search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 1: Line 1:
{{codepointer|description=
+
'''PlaySoundEx''' (string ''soundname'', string ''channel'' [, bool ''loop'' [, int ''attenuation'' [, int ''volume'']]])<br>
Plays a sound, allowing various customization settings.
+
 
|usage=
+
==Usage==
'''PlaySoundEx'''(''soundname'', ''channel'' [, ''loop'' [, ''attenuation'' [, ''volume'']]])
+
 
|parameters=
+
Plays the a sound on the specified channel.  Each actor has its own set of channels to play sounds on, so sounds played by different actors will not affect each other.  This function allows sounds to be played on a specific channel, which can allow for multiple sounds generated from one actor simultaneously that would normally cut each other off, or other special effects.
*soundname: The "nice name" of the sound to play.  See the [[Sound]] EDF block documentation for how to define this.
+
 
 +
===Parameters===
 +
 
 +
*soundname: The "nice name" of the sound to play.  See [[ESOUNDS]] for how to define this.
 
*channel: The channel to play the sound on.  Sound played on separate channels will not interfere with each other.  Valid values are:
 
*channel: The channel to play the sound on.  Sound played on separate channels will not interfere with each other.  Valid values are:
 
**chan_auto, 0
 
**chan_auto, 0
Line 16: Line 19:
 
*loop: If true, the sound will play in a continuous loop.
 
*loop: If true, the sound will play in a continuous loop.
 
*attenuation: Controls how the sound falls off with distance. Legal values are:
 
*attenuation: Controls how the sound falls off with distance. Legal values are:
**attn_normal: Use the close_dist and clipping_dist fields defined in the [[sound]] definition.
+
**attn_normal: Use the close_dist and clipping_dist fields defined in the sound definition.
 
**attn_idle: Use DOOM's normal default sound attenuation behavior.
 
**attn_idle: Use DOOM's normal default sound attenuation behavior.
 
**attn_static: Fades quickly (inaudible from 512 units).
 
**attn_static: Fades quickly (inaudible from 512 units).
 
**attn_none: Plays at this ambience definition's volume level regardless of distance.
 
**attn_none: Plays at this ambience definition's volume level regardless of distance.
 
*volume: The volume to play the sound at, this can be a value from 0-127. 0, being the default, is equivalent to 127.
 
*volume: The volume to play the sound at, this can be a value from 0-127. 0, being the default, is equivalent to 127.
|examples=
+
 
Frame definition:
+
==Examples==
  frame DEMOFRAME  <nowiki>{ cmp = "TROO | A | * | -1 | PlaySoundEx(Cow_Moo, chan_body, 0, attn_idle) | @next" }</nowiki>
+
 
|notes=Each actor has its own set of channels to play sounds on, so sounds played by different actors will not affect each other.  This function allows sounds to be played on a specific channel, which can allow for multiple sounds generated from one actor simultaneously that would normally cut each other off, or other special effects.
+
  frame DEMOFRAME  { cmp = "TROO | A | * | -1 | PlaySoundEx(Cow_Moo, chan_body, 0, attn_idle) | @next" }
|seealso=
+
 
*[[PlaySound]]
+
[[Category:Codepointers]]
}}
 

Please note that all contributions to Eternity Wiki are considered to be released under the GNU Free Documentation License 1.2 (see Eternity Wiki:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

Cancel | Editing help (opens in new window)

Template used on this page: