Ai goal assault: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
(Cleanup)
Line 10: Line 10:


==Keyvalues==
==Keyvalues==
* {{KV Targetname}}
{{KV Targetname}}
* '''actor'''
 
: <target_name_or_class> Actor(s) to affect - NPCs that should perform this assault. This field supports wildcards, if they are needed.
{{KV|Actor(s) to affect|target_name_or_class|NPCs that should perform this assault. This field supports wildcards, if they are needed.{{note|Each NPC needs its own rally point, so if you use wildcards for this field, you should also use wildcards for the '''rallypoint'''.}}
{{note|Each NPC needs its own rally point, so if you use wildcards for this field, you should also use wildcards for the '''rallypoint'''.}}
}}
* '''rallypoint'''
 
: <target_destination> Rally Point Set -  The name of the [[assault_rallypoint]](s) at which this assault will begin. This field can also support wildcards, so that you can enter the root name of all rally points for this assault followed by an asterisk '*', to match all with the same root.
{{KV|Rally Point Set|target_destination|The name of the [[assault_rallypoint]](s) at which this assault will begin. This field can also support wildcards, so that you can enter the root name of all rally points for this assault followed by an asterisk '*', to match all with the same root.}}
* '''SearchType'''
 
: <choices> Search Type - How to search for the entities using the name specified in the ''actorname'' keyvalue. The ''Entity Name'' choice will make the engine search for a ''targetname'' of an entity, while the ''Classname'' choice will make it search for the name of an entity class (like ''npc_headcrab'').
{{KV|Search Type|choices|How to search for the entities using the name specified in the ''actorname'' keyvalue. The ''Entity Name'' choice will make the engine search for a ''targetname'' of an entity, while the ''Classname'' choice will make it search for the name of an entity class (like ''npc_headcrab'').}}
:{| class=standard-table
:* 0 : Entity Name
! Literal Value || Description
:* 1 : Classname
|-
 
| 0 || Entity Name
{{KV|Start Active|bool|Should this goal be active when the map begins?}}
|-
 
| 1 || Classname
{{KV|Assault Cue|choices|Chooses when the goal is going to be set after this entity has been activated.}}
|}
* '''StartActive'''
: {{boolean}} Start Active - Should this goal be active when the map begins?
* '''AssaultCue'''
: <choices> Assault Cue - Chooses when the goal is going to be set after this entity has been activated.
:{| class=standard-table
:{| class=standard-table
! Literal Value || Description || Cue...
! Literal Value || Description || Cue...
Line 38: Line 33:
| 3 || Don't wait for a cue. ||Immediately after being activated.
| 3 || Don't wait for a cue. ||Immediately after being activated.
|}
|}
* '''{{EP1 add|RallySelectMethod}}'''
 
: <choices> Rally Point Selection Method
{{KV|Rally Point Selection Method|choices|Select the Rally Point Selection Method.}}
:{| class=standard-table
:{| class=standard-table
! Literal Value || Description
! Literal Value || Description
Line 51: Line 46:


==Inputs==
==Inputs==
* {{I Targetname}}
{{I Targetname}}
* '''Activate'''
 
: If the entity is not yet active, this input will activate it.
{{IO|Activate|If the entity is not yet active, this input will activate it.}}
* '''Deactivate'''
 
: Deactivates the assault. NPCs are released from the assault behaviour and control is relinquished back to the standard AI/other triggers, as desired by the level designer.
{{IO|Deactivate|Deactivates the assault. NPCs are released from the assault behaviour and control is relinquished back to the standard AI/other triggers, as desired by the level designer.}}
* '''BeginAssault'''
 
: If the entity is active and this entity's ''Assault Cue'' keyvalue is set to ''Entity System Input'', begin the assault(s).
{{IO|BeginAssault|IIf the entity is active and this entity's ''Assault Cue'' keyvalue is set to ''Entity System Input'', begin the assault(s).}}


==Outputs==
==Outputs==
* {{O Targetname}}
{{O Targetname}}


==See Also==
==See also==
* [[Assaults]] - The assault system explained.
* [[Assaults]] - The assault system explained.
* [[npc_metrocop_assault]] and [[npc_soldier_assault]] - Two prefabs containing complete setups of a mass assault of metrocops and soldiers respectively.
* [[npc_metrocop_assault]] and [[npc_soldier_assault]] - Two prefabs containing complete setups of a mass assault of metrocops and soldiers respectively.


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

Revision as of 04:13, 4 February 2012

Template:Hl2 point

Entity description

This entity specifies which NPCs are to carry out an assault, and triggers it when any conditions given are met. One goal can handle multiple rally points. Must be active to be able to be triggered.

Upon activation, the entity will round up all its actors (specified in its actors keyvalue), and instruct them to select their assault_rallypoint(s) and move to it/them. Upon arrival at the rally point(s), each actor then begins waiting for the assault cue (specified in the AssaultCue keyvalue), unless instructed Don't wait for a cue..

Upon the cue, it will then instruct all actors to begin moving on from their current rally point to the assault_assaultpoint specified by the rally point.

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


Actor(s) to affect ([todo internal name (i)]) <target_name_or_class>
NPCs that should perform this assault. This field supports wildcards, if they are needed.
Note.pngNote:Each NPC needs its own rally point, so if you use wildcards for this field, you should also use wildcards for the rallypoint.


Rally Point Set ([todo internal name (i)]) <targetname>
The name of the assault_rallypoint(s) at which this assault will begin. This field can also support wildcards, so that you can enter the root name of all rally points for this assault followed by an asterisk '*', to match all with the same root.


Search Type ([todo internal name (i)]) <choices>
How to search for the entities using the name specified in the actorname keyvalue. The Entity Name choice will make the engine search for a targetname of an entity, while the Classname choice will make it search for the name of an entity class (like npc_headcrab).
  • 0 : Entity Name
  • 1 : Classname


Start Active ([todo internal name (i)]) <boolean>
Should this goal be active when the map begins?


Assault Cue ([todo internal name (i)]) <choices>
Chooses when the goal is going to be set after this entity has been activated.
Literal Value Description Cue...
1 Entity System Input After it has received a BeginAssault input through the I/O system.
2 Gunfire When the entity 'hears' gunfire.
3 Don't wait for a cue. Immediately after being activated.


Rally Point Selection Method ([todo internal name (i)]) <choices>
Select the Rally Point Selection Method.
Literal Value Description
0 Priority, Distance (default)
1 Random


Inputs

Activate
If the entity is not yet active, this input will activate it.


Deactivate
Deactivates the assault. NPCs are released from the assault behaviour and control is relinquished back to the standard AI/other triggers, as desired by the level designer.


BeginAssault
IIf the entity is active and this entity's Assault Cue keyvalue is set to Entity System Input, begin the assault(s).

Outputs

See also

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