Editing
PlaySound
From Eternity Wiki
Jump to navigation
Jump to 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.
Anti-spam check. Do
not
fill this in!
PlaySound exists both as an [[ACS]] function and as an [[EDF]] codepointer. Syntax differs. ==ACS function== For the [[EDF]] action pointer, look at the next section below. {{ACSFunction|description=Plays sound on a tagged thing. |usage=''void'' '''PlaySound'''(''int tid'', ''str sound'' [, ''int channel'' [, ''fixed volume'' [, ''bool looping'' [, ''fixed attenuation'']]]]) |parameters= *''tid'': tag of thing to play the sound *''sound'': name of sound to play *''channel'': optional, one of the eight channels to play sounds from. Default: '''CHAN_BODY'''. Possible values are: '''CHAN_AUTO''', '''CHAN_WEAPON''', '''CHAN_VOICE''', '''CHAN_ITEM''', '''CHAN_BODY''', '''CHAN_5''', '''CHAN_6''', '''CHAN_7'''. *''volume'': optional, default 127*512=65024 (0.9921875). Volume of sound to play. A value of 1.0 is close to the default. *''looping'': whether to loop the sound (default: FALSE). *''attenuation'': attenuation, how much to fade sound with distance, default '''ATTN_NORM'''. Note that despite this being a fixed-point number, it really only results in some specific attenuation patterns. Expected values are: '''ATTN_NONE''', '''ATTN_NORM''', '''ATTN_IDLE''' and '''ATTN_STATIC'''. |seealso= *[[ActivatorSound]] *[[AmbientSound]] *[[LocalAmbientSound]] *[[ThingSound]] |id=<code>-61:PlaySound(2,7)</code> |notes=There is also the [[ThingSound]] function, but it's older and inferior to this one. }} ==EDF codepointer== {{codepointer |description=Plays a sound. |usage= :'''action PlaySound''' :'''misc1''' ''sound_name'' :'''misc2''' ''volume'' |parameters= *'''misc1''' = Sound mnemonic or DeHackEd number to play (must be valid, no default) *'''misc2''' = Select sound volume **0 = normal (default) **1 = full volume |notes= Causes the object to emit the sound indicated by the provided sound mnemonic or DeHackEd number, at the indicated volume level. If the sound name or number is invalid, nothing will happen. Can be used with [[PlayerThunk]]. For [[DECORATE state syntax|Decorate]] availability, use [[PlaySoundEx]] instead. The '''offset'''(''misc1'', ''misc2'') specifier can also be used in Decorate for this codepointer, but you're forced to use the DeHackEd number in ''misc1'', cannot use the actual name. |seealso= *[[PlaySoundEx]] }} [[Category:ACS]] [[Category:Codepointers]] [[Category:MBF codepointers]]
Summary:
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)
Templates used on this page:
Template:ACSFunction
(
edit
)
Template:Codepointer
(
edit
)
Navigation menu
Page actions
Page
Discussion
Read
Edit
History
Page actions
Page
Discussion
More
Tools
Personal tools
Not logged in
Talk
Contributions
Log in
Navigation
Main page
Recent changes
Random page
Help about MediaWiki
Search
Tools
What links here
Related changes
Special pages
Page information