Ai sound: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (removed {{DISPLAYTITLE}}, covered by the hl2 point template)
(updates)
Line 1: Line 1:
{{hl2 point|ai_sound}}
{{lang|Ai sound}}
[[File:ai_sound.png|left]]{{hl2 point|ai_sound}} This entity makes abstract sounds or smells that can be sensed by [[NPC]]s, but not by the player. This can be used to cause reactions in nearby NPCs. An entity called {{ent|soundent}} appears to help with managing AI sounds when the game runs.


==Entity description==
{{code class|CAISound|soundent.cpp}}
[[Image:ai_sound.png|left]]This [[entity]] makes abstract sounds or smells that can be sensed by [[NPC]]s, but not by the player. This can be used to cause reactions in nearby NPCs.{{clr}}
===Contexts===
{| class=standard-table
! Literal Value || Description
|-
| 1048576 || Sound is from Sniper
|-
| 2097152 || Sound is from Launcher
|-
| 4194304 || Mortar Explosion Here
|-
| 8388608 || Only [[Combine]] hear/smell
|-
| 33554432 || Explosion (Usually added to combat sound)
|-
| 67108864 || Exclude Combine (Combine don't hear/smell)
|}


==Keyvalues==
==Keyvalues==
{{KV Targetname}}
{{KV|Volume (volume)|int|How far away this sound can be heard. This is a radius.}}
 
{{KV|Duration (duration)|float|How long the sound persists each time it plays.}}
{{KV Parentname}}
{{KV|Sound Type (soundtype)|choices|The type of sound or smell will determine the reaction of NPCs that sense it.}}
 
{{KV|Volume|int|How far away this sound can be heard. This is a radius.}}
{{KV|Duration|float|How long the sound persists each time you insert it.}}
 
{{KV|Sound Type|choices|The type of sound or smell will determine the reaction of NPCs that sense it. The [[#Contexts|contexts above]] can be factored into the number and entered manually.}}
:{| class=standard-table
:{| class=standard-table
! Literal Value || Description
! Literal Value || Description
Line 49: Line 27:
| 128 || Garbage
| 128 || Garbage
|-
|-
| 256 || Thumper: causes antlions to run away briefly
| 256 || [[prop_thumper|Thumper]]: causes antlions to run away briefly
|-
|-
| 512 || Bugbait: get nearby antlions' attention
| 512 || [[weapon_bugbait|Bugbait]]: get nearby antlions' attention
|-
|-
| 1024 || Physics Danger: Scares off [[npc_metropolice]], [[npc_combine_s]], and [[npc_antlion]]
| 1024 || Physics Danger: Scares off {{ent|npc_metropolice}}, {{ent|npc_combine_s}}, and {{ent|npc_antlion}}
|-
|-
| 2048 || Sniper Danger: Scares [[npc_sniper]]s into their hole
| 2048 || Sniper Danger: Scares {{ent|npc_sniper}}s into their hole
|-
|-
| 4096 || Move Away: Pushes away [[npc_metropolice]], [[npc_citizen]], [[npc_combine_s]], [[npc_alyx]], and [[npc_barney]], [[npc_fisherman]]
| 4096 || Move Away: Pushes away <code>npc_metropolice</code>, {{ent|npc_citizen}}, <code>npc_combine_s</code>, {{ent|npc_alyx}}, {{ent|npc_barney}}, {{ent|npc_fisherman}}
|-
|-
| 8192 || Player Vehicle: Makes NPCs hear the player & makes [[npc_metropolice]] turn towards the sound (only used by [[prop_vehicle_airboat]]
| 8192 || Player Vehicle: Makes NPCs hear the player & makes <code>npc_metropolice</code> turn towards the sound (only used by {{ent|prop_vehicle_airboat}}
|-
|-
| 16384 || Player Comanion Readiness: Low
| 16384 || Player Companion Readiness: Low
|-
|-
| 32768 || Player Comanion Readiness: Medium
| 32768 || Player Companion Readiness: Medium
|-
|-
| 65536 || Player Comanion Readiness: High
| 65536 || Player Companion Readiness: High
|}
|}
 
{{KV|Additional sound context (optional) (soundcontext)|choices|Optional settings specifying such things as who can or cannot hear the sound. Some settings will require [[SmartEdit]] to be turned off. {{todo|Is this list complete?}}}}
{{KV|Additional sound context (optional)|choices|Optional settings specifying such things as who can or cannot hear the sound.}}
:{| class=standard-table
:* 1 : Only Combine hear
! Literal Value || Description
:* 2 : Combine cannot hear
|-
 
| 1048576 || Sound is from Sniper
{{KV|Location Proxy|target_destination|The name of an entity to use as a proxy to determine the location at which to make the sound.
|-
: If you specify an entity here, the sound will be made at that entity's location (!player included).}}
| 2097152 || Sound is from Launcher
|-
| 4194304 || Mortar Explosion Here
|-
| 8388608 || Only [[Combine]] hear/smell
|-
| 33554432 || Explosion (Usually added to combat sound)
|-
| 67108864 || Exclude Combine (Combine don't hear/smell)
|}
{{KV|Location Proxy (locationproxy)|target_destination|If you specify an entity here, the sound will be made at that entity's location ({{ent|!player}} is an option).}}
{{KV BaseEntity|base=1}}


==Inputs==
==Inputs==
{{I Targetname}}
{{IO|InsertSound|param=int|deprecated=1|Insert a sound in the AI sound list at a specified volume (1-100) which influences detection radius.}}<!--Check CAISound::InputInsertSound. I'm not sure why exactly this is deemed obsolete but it is. -Pinsplash-->
 
{{I Parentname}}
 
{{IO|InsertSound|Insert a sound in the AI sound list at a specified volume (1-100) which influences detection radius.|param=int}}
 
{{IO|EmitAISound|Make the Sound.}}
{{IO|EmitAISound|Make the Sound.}}
{{I BaseEntity|base=1}}


==Outputs==
==Outputs==
{{O Targetname}}
{{O BaseEntity}}


[[category:AI]]
[[Category:AI]]
[[category:Entities]]

Revision as of 11:37, 4 September 2018

English (en)Translate (Translate)
Ai sound.png

Template:Hl2 point This entity makes abstract sounds or smells that can be sensed by NPCs, but not by the player. This can be used to cause reactions in nearby NPCs. An entity called soundent appears to help with managing AI sounds when the game runs.

C++ In code, it is represented by theCAISoundclass, defined in thesoundent.cppfile.

Keyvalues

Volume (volume) ([todo internal name (i)]) <integer>
How far away this sound can be heard. This is a radius.
Duration (duration) ([todo internal name (i)]) <float>
How long the sound persists each time it plays.
Sound Type (soundtype) ([todo internal name (i)]) <choices>
The type of sound or smell will determine the reaction of NPCs that sense it.
Literal Value Description
1 Combat: Will cause most NPCs to become alert
2 World: Will cause most NPCs to become alert
4 Player: Feign player audible
8 Danger: Will cause most NPCs to move away from the position of the sound
16 Bullet Impact
32 Carcass
64 Meat
128 Garbage
256 Thumper: causes antlions to run away briefly
512 Bugbait: get nearby antlions' attention
1024 Physics Danger: Scares off npc_metropolice, npc_combine_s, and npc_antlion
2048 Sniper Danger: Scares npc_snipers into their hole
4096 Move Away: Pushes away npc_metropolice, npc_citizen, npc_combine_s, npc_alyx, npc_barney, npc_fisherman
8192 Player Vehicle: Makes NPCs hear the player & makes npc_metropolice turn towards the sound (only used by prop_vehicle_airboat
16384 Player Companion Readiness: Low
32768 Player Companion Readiness: Medium
65536 Player Companion Readiness: High
Additional sound context (optional) (soundcontext) ([todo internal name (i)]) <choices>
Optional settings specifying such things as who can or cannot hear the sound. Some settings will require SmartEdit to be turned off.
Todo: Is this list complete?
Literal Value Description
1048576 Sound is from Sniper
2097152 Sound is from Launcher
4194304 Mortar Explosion Here
8388608 Only Combine hear/smell
33554432 Explosion (Usually added to combat sound)
67108864 Exclude Combine (Combine don't hear/smell)
Location Proxy (locationproxy) ([todo internal name (i)]) <targetname>
If you specify an entity here, the sound will be made at that entity's location (!player is an option).


Inputs

InsertSound <integerRedirectInput/integer> Obsolete
Deprecated.
Insert a sound in the AI sound list at a specified volume (1-100) which influences detection radius.
EmitAISound
Make the Sound.


Outputs

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Ai_sound&oldid=218580"