This article's documentation is for anything that uses the Source engine. Click here for more information.

Assault assaultpoint: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Added tip to OnArrival)
m (Substituted IO templates)
 
(23 intermediate revisions by 9 users not shown)
Line 1: Line 1:
{{DISPLAYTITLE:assault_assaultpoint}}
{{LanguageBar}}
{{hl2 point|assault_assaultpoint}}
{{CD|CAssaultPoint|file1=ai_behavior_assault.cpp}}
{{this is a|point entity|name=assault_assaultpoint|sprite=1|except=Left 4 Dead series}}
These entities form the body of an [[assault]] chain, specifying where the assault should go once it has begun. There can be any number of them in each chain. Make sure you are using ai [[node]]s, otherwise you will have to have an assaultpoint for every single corner in your path.{{clr}}


==Entity description==
{{bug|Specifying an {{ent|assault_rallypoint}} as the next assault point will crash the game!}}
[[Image:{{PAGENAME}}.png|left]]These entities form the body of an [[assault]] chain, specifying where the assault should go once it has begun. There can be any number of them in each chain.
 
{{bug|When moving to an assault point partway through a chain, the [[NPC]] will go to the standing posture for a moment before continuing. This bug is fixed in the HL2 Episodes.}}
 
{{note|Unfortunately, there's no keyvalue to define a ''range'' at which an assaultpoint can be considered cleared. This means that if you have a large group of NPCs in an assault, the fact that they will continually attempt to move directly onto an assaultpoint, even if another NPC is standing there, can also break the illusion of realistic movement. Try making a trigger around your assaultpoint (<code>[[trigger_once|once]]</code> or <code>[[trigger_multiple|multiple]]</code>) that sends your assaultpoint a <code>SetForceClear</code> input with a fair delay time to make sure everyone is still grouped together.}}


{{note|Assault points only affect the journey ''to'' them, not ''from'' them.}}
{{note|Assault points only affect the journey ''to'' them, not ''from'' them.}}


{{bug|Specifying an [[assault_rallypoint]] as the next assault point will crash the game.}}
{{note|NPCs will always turn to face in the direction the entity is set to when arriving at an assault point if they don't see an enemy before reaching the point. You can change the direction, indicated by a small yellow line, by changing the middle number of the '''Pitch Yaw Roll''' keyvalue.}}


{{tip|Naming assault points the same name will cause NPCs to randomly select the assault point that was '''not''' used last.}}
{{tip|Naming assault points the same name will cause NPCs to randomly select one.}}


=== Limitations ===
==Flags==
* When moving to an assault point partway through a chain, the [[NPC]] will go to the standing posture for a moment before continuing. This looks unnatural. {{note|This bug is fixed in [[Half-Life_2:_Episode_One|Half Life 2: Episode One]] and [[Half-Life_2:_Episode_Two|Half Life 2: Episode Two]]}}
{{fl|1|Clear this point upon arrival, UNCONDITIONALLY|Move on to the next point once reaching this one, regardless of any other influences.}}
* NPCs will always turn to face in the direction the entity is set to when arriving at an assault point '''if they don't have an enemy before they reach the point'''. This might again look unnatural in some cases.
* NPCs must stand directly on an assaultpoint to clear it without timeout if the ''clearoncontact'' keyvalue is not set and triggered. This can result in illogical backtracking and means that groups of NPCs moving together will each need their own assaultpoint to maintain the illusion. {{Todo| What are you trying to say? Why would they back track?}}


==Keyvalues==
==Keyvalues==
{{KV|Assault Hint Group|string|Constrain the movement of the NPC(s) participating in the assault to this [[info_hint|hint]] group once assault has begun.}}
{{KV|Next assault point (optional)|targetname|The assault_assaultpoint to move to next.}}
{{KV|Assault time out|float|This point is cleared when no enemies are seen for this long (specified in seconds). The NPC(s) at this assault point will scout for enemies this long before moving on.}}
{{KV|Clear on contact with enemies|bool|If the assaulting NPC meets enemies on its way to this point, it will consider the assault point cleared and target the next assault point in the chain.}}
{{KV|Allow diversion|bool|If the assault comes into contact with hostiles on the way to this assault point, divert to kill them and resume once the area appears clear.
:* If it set to ''Yes'', NPCs will chase any hostiles until they are dead or out of sight for the period set in the Assault time out.
:* If this is set to ''No'', assaulting NPCs will run non-stop to the next point, attacking enemies they can see but not chasing them.}}
{{KV|Diversion Proximity|float|If is set, NPC will only divert from assault to attack an enemy that is within this distance of the assault point. 0 means no limit.}}
{{KV|Never Timeout|bool|If set, the assault never ends for NPCs assaulting this point. Useful for forcing NPCs back to a point.}}
{{KV|Strict?|bool|If set, NPCs may not move to attack, avoid danger, or move out of the player's way.}}
{{KV|Force Crouch|bool|NPCs using this assault point are forced into crouching while holding it.{{bug|This only works for NPCs that crouch as part of their natural ai. EX: [[npc_alyx|Alyx]] and [[npc_combine_s|Combine Soldiers]].}}}}
{{KV|Urgent|bool|If set, NPCs will consider movement to this rally point as Urgent Navigation.}}
{{KV Angles}}
{{KV Parentname}}
{{KV Targetname}}
{{KV Targetname}}
 
{{KV|Assault Hint Group|intn=assaultgroup|string|Constrain the movement of the NPC(s) participating in the assault to this [[hint group]] once assault has begun.}}
==Flags==
{{KV|Next assault point (optional)|intn=nextassaultpoint|targetname|The <code>assault_assaultpoint</code> to move to next.}}
 
{{KV|Assault time out|intn=assaulttimeout|float|This point is cleared when no enemies are seen for this long (specified in seconds). The NPC(s) at this assault point will scout for enemies this long before moving on.}}
* 1 : Clear this point upon arrival, UNCONDITIONALLY
{{KV|Clear on contact with enemies|intn=clearoncontact|bool|If the assaulting NPC meets enemies on its way to this point, it will consider the assault point cleared and target the next assault point in the chain.}}
: Move on to the next point once reaching this one, regardless of any other influences.
{{KV|Allow diversion|intn=allowdiversion|bool|If the assault comes into contact with hostiles on the way to this assault point, divert to kill them and resume once the area appears clear.
:*If it set to '''Yes''', NPCs will chase any hostiles until they are dead or out of sight for the period set in the '''Assault time out'''.
:*If this is set to '''No''', assaulting NPCs will run non-stop to the next point, attacking enemies they can see but not chasing them.}}
{{KV|Diversion Proximity|intn=allowdiversionradius|float|If '''Allow diversion''' is set to '''Yes''', NPC will only divert from assault to attack an enemy that is within this distance of the assault point. 0 means no limit.}}
{{KV|Never Timeout|intn=nevertimeout|bool|If set, the assault never ends for NPCs assaulting this point. Useful for forcing NPCs back to a point.}}
{{KV|Strict?|intn=strict|bool|If set, NPCs may not move to attack, avoid danger, or move out of the player's way.}}
{{KV|Force Crouch|intn=forcecrouch|bool|NPCs using this assault point are forced into crouching while holding it.
:{{bug|This only works for NPCs that crouch as part of their natural AI, such as [[npc_alyx|Alyx]] and [[npc_combine_s|Combine Soldiers]].}}}}
{{KV|Urgent|intn=urgent|bool|If set, NPCs will consider movement to this rally point as Urgent Navigation (ignoring {{ent|prop_physics}} blockers, eventually teleporting).}}


==Inputs==
==Inputs==
{{IO|SetClearOnContact|param=boolean|Sets the ''Clear on Contact with enemies'' keyvalue. Accepts ''1''/''0'' or ''Yes''/''No'' as parameters.}}
{{I|SetClearOnContact|param=boolean|Sets the '''Clear on Contact with enemies''' keyvalue. Accepts <code>1</code>/<code>0</code> or <code>Yes</code>/<code>No</code> as parameters.}}
 
{{I|SetAllowDiversion|param=boolean|Sets the '''Allow Diversion''' keyvalue. Accepts <code>1</code>/<code>0</code> or <code>Yes</code>/<code>No</code> as parameters.}}
{{IO|SetAllowDiversion|param=boolean|Sets the ''Allow Diversion'' keyvalue. Accepts ''1''/''0'' or ''Yes''/''No'' as parameters.}}
{{I|SetForceClear|param=boolean|Set the ''Force Clear'' flag. NPCs who are currently running to the assault point will clear it immediately. NPCs who acquire it in the future will clear it automatically.}}
 
{{IO|SetForceClear|param=boolean|Set the Force Clear flag. NPCs who are currently running to the assault point will Clear it immediately. NPCs who acquire it in the future will Clear it automatically.}}
 
{{ScrollBox|
{{I Parentname}}
{{I Targetname}}
}}


==Outputs==
==Outputs==
{{O Targetname}}
{{O|OnArrival|Fires when a NPC arrives.
 
:{{note|This can fire more than once since NPCs tend to divert from assault points to reload or avoid danger.}}}}
{{IO|OnArrival|Fires when a NPC arrives. {{activator|NPC}}{{tip|This can fire more than once since NPCs tend to divert from assault points to reload or avoid danger.}}}}
{{O|OnAssaultClear|Fires when the point is cleared (arriving and clearing can happen at completely different times).}}
 
{{IO|OnAssaultClear|Fires when the point is cleared.}}


==See also==
* [[Assaults]] - Article about Assaults.


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

Latest revision as of 20:54, 19 April 2025

English (en)Translate (Translate)
C++ Class hierarchy
CAssaultPoint
↳CPointEntity
↳CBaseEntity
C++ ai_behavior_assault.cpp
Assault assaultpoint.png

assault_assaultpoint is a point entity available in all Source Source games except Left 4 Dead seriesLeft 4 Dead series Left 4 Dead series. These entities form the body of an assault chain, specifying where the assault should go once it has begun. There can be any number of them in each chain. Make sure you are using ai nodes, otherwise you will have to have an assaultpoint for every single corner in your path.

Icon-Bug.pngBug:Specifying an assault_rallypoint as the next assault point will crash the game!  [todo tested in ?]
Icon-Bug.pngBug:When moving to an assault point partway through a chain, the NPC will go to the standing posture for a moment before continuing. This bug is fixed in the HL2 Episodes.  [todo tested in ?]
Note.pngNote:Unfortunately, there's no keyvalue to define a range at which an assaultpoint can be considered cleared. This means that if you have a large group of NPCs in an assault, the fact that they will continually attempt to move directly onto an assaultpoint, even if another NPC is standing there, can also break the illusion of realistic movement. Try making a trigger around your assaultpoint (once or multiple) that sends your assaultpoint a SetForceClear input with a fair delay time to make sure everyone is still grouped together.
Note.pngNote:Assault points only affect the journey to them, not from them.
Note.pngNote:NPCs will always turn to face in the direction the entity is set to when arriving at an assault point if they don't see an enemy before reaching the point. You can change the direction, indicated by a small yellow line, by changing the middle number of the Pitch Yaw Roll keyvalue.
Tip.pngTip:Naming assault points the same name will cause NPCs to randomly select one.

Flags

Clear this point upon arrival, UNCONDITIONALLY : [1]
Move on to the next point once reaching this one, regardless of any other influences.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Assault Hint Group (assaultgroup) <string>
Constrain the movement of the NPC(s) participating in the assault to this hint group once assault has begun.
Next assault point (optional) (nextassaultpoint) <targetname>
The assault_assaultpoint to move to next.
Assault time out (assaulttimeout) <float>
This point is cleared when no enemies are seen for this long (specified in seconds). The NPC(s) at this assault point will scout for enemies this long before moving on.
Clear on contact with enemies (clearoncontact) <boolean>
If the assaulting NPC meets enemies on its way to this point, it will consider the assault point cleared and target the next assault point in the chain.
Allow diversion (allowdiversion) <boolean>
If the assault comes into contact with hostiles on the way to this assault point, divert to kill them and resume once the area appears clear.
  • If it set to Yes, NPCs will chase any hostiles until they are dead or out of sight for the period set in the Assault time out.
  • If this is set to No, assaulting NPCs will run non-stop to the next point, attacking enemies they can see but not chasing them.
Diversion Proximity (allowdiversionradius) <float>
If Allow diversion is set to Yes, NPC will only divert from assault to attack an enemy that is within this distance of the assault point. 0 means no limit.
Never Timeout (nevertimeout) <boolean>
If set, the assault never ends for NPCs assaulting this point. Useful for forcing NPCs back to a point.
Strict? (strict) <boolean>
If set, NPCs may not move to attack, avoid danger, or move out of the player's way.
Force Crouch (forcecrouch) <boolean>
NPCs using this assault point are forced into crouching while holding it.
Icon-Bug.pngBug:This only works for NPCs that crouch as part of their natural AI, such as Alyx and Combine Soldiers.  [todo tested in ?]
Urgent (urgent) <boolean>
If set, NPCs will consider movement to this rally point as Urgent Navigation (ignoring prop_physics blockers, eventually teleporting).

Inputs

SetClearOnContact <booleanRedirectInput/boolean>
Sets the Clear on Contact with enemies keyvalue. Accepts 1/0 or Yes/No as parameters.
SetAllowDiversion <booleanRedirectInput/boolean>
Sets the Allow Diversion keyvalue. Accepts 1/0 or Yes/No as parameters.
SetForceClear <booleanRedirectInput/boolean>
Set the Force Clear flag. NPCs who are currently running to the assault point will clear it immediately. NPCs who acquire it in the future will clear it automatically.

Outputs

OnArrival
Fires when a NPC arrives.
Note.pngNote:This can fire more than once since NPCs tend to divert from assault points to reload or avoid danger.
OnAssaultClear
Fires when the point is cleared (arriving and clearing can happen at completely different times).
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Assault_assaultpoint&oldid=471709"