PlayActorSound: Difference between revisions

From Eternity Wiki
Jump to navigationJump to search
No edit summary
Line 1: Line 1:
'''ACS function'''
{{ACSFunction|description=Plays a sound belonging to a [[thingtype]]'s description, such as its pain or sight sounds.
 
|usage=''void'' '''PlayActorSound'''(''int tid'', ''int sound''[, ''int channel''[, ''fixed volume''[, ''bool looping''[, ''fixed attenuation'']]]])
void PlayActorSound (int tid, int sound[, int channel[, fixed volume[, bool looping[, fixed attenuation]]]])
|parameters:
 
Plays a sound belonging to a thingtype's description, such as its pain or sight sounds.
 
==Parameters==
*''tid'': tag of thing to play sound
*''tid'': tag of thing to play sound
*''sound'': one of [[thingtype]]'s specific sounds to play. NOTE: anything not listed here is unimplemented. Valid values are: '''SOUND_See''', '''SOUND_Attack''', '''SOUND_Pain''', '''SOUND_Death''' and '''SOUND_Active'''.
*''sound'': one of [[thingtype]]'s specific sounds to play. NOTE: anything not listed here is unimplemented. Valid values are: '''SOUND_See''', '''SOUND_Attack''', '''SOUND_Pain''', '''SOUND_Death''' and '''SOUND_Active'''.
Line 12: Line 8:
*''looping'': whether to loop the sound. Default is FALSE.
*''looping'': whether to loop the sound. Default is FALSE.
*''attenuation'': how quickly to fade out the sound with distance. Default is '''ATTN_NORM'''. Valid values are: '''ATTN_NONE''', '''ATTN_NORM''', '''ATTN_IDLE''' and '''ATTN_STATIC'''.
*''attenuation'': how quickly to fade out the sound with distance. Default is '''ATTN_NORM'''. Valid values are: '''ATTN_NONE''', '''ATTN_NORM''', '''ATTN_IDLE''' and '''ATTN_STATIC'''.
 
|id=<code>-71:PlayActorSound(2,6)</code>}}
==See also==
*[[ActivatorSound]]
*[[AmbientSound]]
*[[LocalAmbientSound]]
*[[PlaySound]]
*[[ACS functions]]
 
[[Category:ACS]]

Revision as of 11:01, 21 November 2020

Description

This is an ACS built-in function.

Plays a sound belonging to a thingtype's description, such as its pain or sight sounds.

Usage

void PlayActorSound(int tid, int sound[, int channel[, fixed volume[, bool looping[, fixed attenuation]]]])

Parameters

No parameters.

Return value

Examples

No examples given.

Notes

No particular notes.

This function's identification in zspecial.acs is: -71:PlayActorSound(2,6).

See also