CSoundEngine - Revision history

Outerbeast: /* Methods */

2025-10-21T14:00:20Z

Methods

← Older revision		Revision as of 16:00, 21 October 2025
Line 164:		Line 164:

	== Methods ==		== Methods ==
	Note: For the methods that support <code>edict_t@ entity</code> paramater to set an entity to emit the sound		Note: For the methods that support <code>edict_t@ entity</code> paramater to set an entity to emit the sound-
	* '''The entity must have a model''', otherwise the sound position does not get networked to clients. This is because the server knows where it is and can thus play the sound from there but clients won't know if/when the entity's position changes.		* '''The entity must have a model''', otherwise the sound position does not get networked to clients. This is because the server knows where it is and can thus play the sound from there but clients won't know if/when the entity's position changes.
	* Sounds emitted from an entity will not play if <code>EF_NODRAW</code> is set for the entity		* Sounds emitted from an entity will not play if <code>EF_NODRAW</code> is set for the entity

2025-10-21T13:59:38Z

← Older revision		Revision as of 15:59, 21 October 2025
Line 164:		Line 164:

	== Methods ==		== Methods ==
			Note: For the methods that support <code>edict_t@ entity</code> paramater to set an entity to emit the sound
			* '''The entity must have a model''', otherwise the sound position does not get networked to clients. This is because the server knows where it is and can thus play the sound from there but clients won't know if/when the entity's position changes.
			* Sounds emitted from an entity will not play if <code>EF_NODRAW</code> is set for the entity
	<span id="precachesound"></span>		<span id="precachesound"></span>
	==== PrecacheSound ====		==== PrecacheSound ====

	<pre>void PrecacheSound(const string& in szFilename)</pre>		<pre>void PrecacheSound(const string& in szFilename)</pre>
	This method allows you to precache a sound for use. Sounds must be precached in MapInit or an entity’s Precache method.		This method allows you to precache a sound for use. Sounds must be precached in MapInit or an entity’s Precache method.

2025-02-26T20:16:47Z

Constants

← Older revision		Revision as of 22:16, 26 February 2025
Line 8:		Line 8:
	<span id="constants"></span>		<span id="constants"></span>
	== Constants ==		== Constants ==
			All these constants exist in global scope.
	<span id="sound_channel"></span>		<span id="sound_channel"></span>
	==== SOUND_CHANNEL ====		==== SOUND_CHANNEL ====

	Sound channels represent a number of audio channels that can simultaneously play sounds for any given entity. Note that despite what the name of some channels might imply, none of them are intended for any particular type of sound, with the exception of CHAN_STATIC due to its special behavior in networking code.		Sound channels represent a number of audio channels that can simultaneously play sounds for any given entity. Note that despite what the name of some channels might imply, none of them are intended for any particular type of sound, with the exception of CHAN_STATIC due to its special behavior in networking code.

Line 163:		Line 162:

	<span id="methods"></span>		<span id="methods"></span>

	== Methods ==		== Methods ==

2025-02-26T20:16:28Z

← Older revision		Revision as of 22:16, 26 February 2025
Line 7:		Line 7:
	A single global instance exists: <code>CSoundEngine g_SoundSystem;</code>		A single global instance exists: <code>CSoundEngine g_SoundSystem;</code>
	<span id="constants"></span>		<span id="constants"></span>
	=== Constants ===		== Constants ==

	<span id="sound_channel"></span>		<span id="sound_channel"></span>
Line 163:		Line 163:

	<span id="methods"></span>		<span id="methods"></span>
	=== Methods ===		== Methods ==

	<span id="precachesound"></span>		<span id="precachesound"></span>

2025-02-16T18:00:11Z

EmitGroupNameSuit

← Older revision		Revision as of 20:00, 16 February 2025
Line 361:		Line 361:
	! Purpose		! Purpose
	\|-		\|-
	\| entity		\| <code>entity
	\| Entity where the suit sound will be played. Can be any entity, not just a player.		\| Entity where the suit sound will be played. Can be any entity, not just a player.
	\|-		\|-
	\| szSample		\| <code>szSample
	\| Sentence group to select a sentence from.		\| Sentence group to select a sentence from.
	\|}		\|}

	~~<span id="lookupsentenceindex"></span>~~
	==== LookupSentenceIndex ====		==== LookupSentenceIndex ====

2025-02-16T18:00:02Z

EmitGroupIdSuit

← Older revision		Revision as of 20:00, 16 February 2025
Line 344:		Line 344:
	! Purpose		! Purpose
	\|-		\|-
	\| entity		\| <code>entity
	\| Entity where the suit sound will be played. Can be any entity, not just a player.		\| Entity where the suit sound will be played. Can be any entity, not just a player.
	\|-		\|-
	\| isentencereg		\| <code>isentencereg
	\| Sentence group to play. Must be a sentence group id retrieved using the sound system’s sentence methods.		\| Sentence group to play. Must be a sentence group id retrieved using the sound system’s sentence methods.
	\|}		\|}

	~~<span id="emitgroupnamesuit"></span>~~
	==== EmitGroupNameSuit ====		==== EmitGroupNameSuit ====

2025-02-16T17:59:49Z

EmitSoundSuit

← Older revision		Revision as of 19:59, 16 February 2025
Line 325:		Line 325:
	! Purpose		! Purpose
	\|-		\|-
	\| entity		\| <code>entity
	\| Entity where the suit sound will be played. Can be any entity, not just a player.		\| Entity where the suit sound will be played. Can be any entity, not just a player.
	\|-		\|-
	\| szSample		\| <code>szSample
	\| Sentence to play.		\| Sentence to play.
	\|}		\|}

2025-02-16T17:59:19Z

LookupSentenceIndex

← Older revision		Revision as of 19:59, 16 February 2025
Line 373:		Line 373:

	<pre>int LookupSentenceIndex(const string& in sentenceName)</pre>		<pre>int LookupSentenceIndex(const string& in sentenceName)</pre>
	Looks up the sentence index of the given sentence.		Looks up the sentence index of the given sentence.<code>sentenceName</code> is the name of the sentence to find.

	~~{\| class="wikitable"~~		Return value: Sentence index if it was found, 0 otherwise.
	\|-
	~~! Argument~~
	~~! Purpose~~
	\|-
	~~\| sentenceName~~
	~~\| Name of the sentence to find.~~
	\|}

	Return value:

	Sentence index if it was found, 0 otherwise.

	~~<span id="lookupsentencegroupindex"></span>~~

	==== LookupSentenceGroupIndex ====		==== LookupSentenceGroupIndex ====

2025-02-16T17:58:15Z

LookupSentenceGroupIndex

← Older revision		Revision as of 19:58, 16 February 2025
Line 394:		Line 394:
	<pre>int LookupSentenceGroupIndex(const string& in szGroup)</pre>		<pre>int LookupSentenceGroupIndex(const string& in szGroup)</pre>
	Looks up the sentence group index of the given sentence.		Looks up the sentence group index of the given sentence.
			<code>szGroup</code> is the name of the sentence group to find.

	~~{\| class="wikitable"~~		Return value: Sentence group index if it was found, 0 otherwise.
	\|-
	~~! Argument~~
	~~! Purpose~~
	\|-
	~~\| szGroup~~
	~~\| Name of the sentence~~ group ~~to find~~.
	\|}

	~~Return value:~~

	~~Sentence group index if it was found, 0 otherwise.~~

	~~<span id="playsentencegroup"></span>~~
	==== PlaySentenceGroup ====		==== PlaySentenceGroup ====

2025-02-16T17:56:16Z

PlaySentenceGroup

← Older revision		Revision as of 19:56, 16 February 2025
Line 419:		Line 419:
	! Purpose		! Purpose
	\|-		\|-
	\| entity		\| <code>entity
	\| Entity where the sentence will be played.		\| Entity where the sentence will be played.
	\|-		\|-
	\| szGroupName		\| <code>szGroupName
	\| Group to select a sentence from.		\| Group to select a sentence from.
	\|-		\|-
	\| volume		\| <code>volume
	\| Volume.		\| Volume.
	\|-		\|-
	\| attenuation		\| <code>attenuation
	\| Attenuation.		\| Attenuation.
	\|-		\|-
	\| flags		\| <code>flags
	\| Sound flags.		\| Sound flags.
	\|-		\|-
	\| pitch		\| <code>pitch
	\| Pitch.		\| Pitch.
	\|}		\|}
Line 440:		Line 440:
	Return value: Index of the sentence that was played, or -1 if no such sentence group exists.		Return value: Index of the sentence that was played, or -1 if no such sentence group exists.

	~~<span id="playsentencegroup-1"></span>~~
	==== PlaySentenceGroup ====		==== PlaySentenceGroup ====