Ai goal operator: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Robot: fixing template case.)
(-added class hierarchy, cleanup)
 
(18 intermediate revisions by 8 users not shown)
Line 1: Line 1:
{{wrongtitle|title=ai_goal_operator}}
{{LanguageBar}}
==Entity Description==
{{CD|CAI_OperatorGoal|file1=ai_behavior_operator.cpp}}
Indicates items in the world that some NPCs may operate upon
{{this is a|point entity|game=Half-Life 2 series|name=ai_goal_operator}}
==Keyvalues==
It indicates items in the world that some NPCs may operate upon.
* {{KV Targetname}}
 
* {{KV EnableDisable}}
{{stray ent|{{portal}}}}
* '''actor'''
 
: <target_name_or_class> NPC that should perform this operation
== Keyvalues ==
* '''target'''
{{KV Targetname}}
: <target_destination> Name of the entity that the NPC should move to in order to perform the operation.
{{KV|Position entity|intn=target|target_destination|Name of the entity that the NPC should move to in order to perform the operation.}}
* '''contexttarget'''
{{KV|Context target|intn=contexttarget|target_destination|(Optional) Name of an entity that the operator will use within context.}}
: <target_destination> (Optional) Name of an entity that the operator will use within context.
{{KV|Initial State|intn=state|choices|How the operated entity starts.
* '''state'''
:*1: Not ready (closed, locked, etc)
: <choices> Initial State
:*2: Ready (open and accessible)}}
:{|
{{KV|How should NPC approach?|intn=moveto|choices|{{confirm|Not implemented?}}
! Literal Value || Description
:*0: Don't approach
|-
:*1: Walk
| 0 || Not ready (closed, locked, etc)
:*2: Run}}
|-
{{KV GoalEntity}}
| 1 || Ready (open and accessible)
 
|}
* '''moveto'''
: <choices> How should NPC approach?
:{|
! Literal Value || Description
|-
| 0 || DO NOT USE 0
|-
| 1 || Walk
|-
| 2 || Run
|}
==Inputs==
==Inputs==
* {{I Targetname}}
{{I|SetStateReady|Set the object's state to ''Ready''. Fire this input when the object has been unlocked/opened or otherwise made ready for interaction.}}
* {{I EnableDisable}}
{{I|SetStateFinished|Fire this input when the NPC has completed the interaction with this object.}}
* '''Activate'''
{{I GoalEntity}}
: Begin operating on the object
 
* '''SetStateReady'''
: Set the object's state to READY. Fire this input when the object has been unlocked/opened or otherwise made ready for interaction.
* '''SetStateFinished'''
: Fire this input when the NPC has completed the interaction with this object.
==Outputs==
==Outputs==
* {{o targetname}}
{{O|OnBeginApproach|Fired when the NPC begins to approach the position.}}
* '''OnBeginApproach'''
{{O|OnMakeReady|Fired when the item is ready to operate.}}
: Fired when the NPC begins to approach the position
{{O|OnBeginOperating|Fired when the NPC is ready to operate.}}
* '''OnMakeReady'''
{{O|OnFinished|Fired when <code>SetStateFinished</code> is sent to the entity.}}
: Make the item ready to operate
 
* '''OnBeginOperating'''
[[Category:AI]]
: Fired when the NPC is ready to operate
* '''OnFinished'''
: The item is done
[[Category:Half-Life 2: Episode One Entities]]

Latest revision as of 12:34, 25 September 2024

English (en)Translate (Translate)
C++ Class hierarchy
CAI_OperatorGoal
↳CAI_GoalEntity
↳CBaseEntity
C++ ai_behavior_operator.cpp

ai_goal_operator is a point entity available in Half-Life 2 series Half-Life 2 series. It indicates items in the world that some NPCs may operate upon.

Note.pngNote:This entity is also in the code for Portal. Its functionality is not guaranteed.


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

Position entity (target) <targetname>
Name of the entity that the NPC should move to in order to perform the operation.
Context target (contexttarget) <targetname>
(Optional) Name of an entity that the operator will use within context.
Initial State (state) <choices>
How the operated entity starts.
  • 1: Not ready (closed, locked, etc)
  • 2: Ready (open and accessible)
How should NPC approach? (moveto) <choices>
Confirm:Not implemented?
  • 0: Don't approach
  • 1: Walk
  • 2: Run

AI_GoalEntity:

Actor(s) to affect (actor) <target_name_or_class>
The targetname or classname of any NPCs that will be included in this goal. Wildcards are supported.
Search Type (SearchType) <choices>
What the Actor(s) to affect keyvalue targets by.
  • 0: Entity Name
  • 1: Classname
Start Active (StartActive) <boolean>
Set if goal should be active immediately.

Inputs

SetStateReady
Set the object's state to Ready. Fire this input when the object has been unlocked/opened or otherwise made ready for interaction.
SetStateFinished
Fire this input when the NPC has completed the interaction with this object.

AI_GoalEntity:

Activate
Make the goal active if it wasn't already. NPCs will begin taking orders.
Deactivate
Make goal inactive.
UpdateActors  !FGD
Tell the goal entity to re-check Actor(s) to affect in case any disappeared, or any new NPCs spawned.[confirm]

Outputs

OnBeginApproach
Fired when the NPC begins to approach the position.
OnMakeReady
Fired when the item is ready to operate.
OnBeginOperating
Fired when the NPC is ready to operate.
OnFinished
Fired when SetStateFinished is sent to the entity.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Ai_goal_operator&oldid=454878"