ai_goal_operator
ai_goal_operator
is a point entity available in the following Source games or engine branches:
Half-Life 2, Half-Life 2: Episode One, Half-Life 2: Episode Two and Half-Life 2: Deathmatch.
It indicates items in the world that some NPCs may operate upon.
This entity is also in the code for . Its functionality is not guaranteed.
Keyvalues
- 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.
Base:
- Parent
(parentname)
<targetname> - Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (
parentname [targetname],[attachment]
)Tip:Entities transition to the next map with their parentsTip:phys_constraint
can be used as a workaround if parenting fails.
- Origin (X Y Z)
(origin)
<coordinates> - The position of this entity's center in the world. Rotating entities typically rotate around their origin.Note:Hammer does not move the entities accordingly only in the editor.
- Pitch Yaw Roll (X Y Z)
(angles)
<angle> - This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.Note:This works on brush entities, although Hammer doesn't show the new angles.
- Classname
(classname)
<string> !FGD - Determines the characteristics of the entity before it spawns. Tip:Changing this on runtime still has use, like making matching an entry in S_PreserveEnts will persist the entity on new rounds!
- Spawnflags
(spawnflags)
<flags> !FGD - Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.
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]
Base:
AddContext
<string>- Adds to the entity's list of response contexts. See Context.
AddOutput
<string>- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
// Format of changing KeyValues: "AddOutput [key] [value]"
//// Raw text:
"OnUser1" "!self,AddOutput,targetname new_name"
// Format of adding an Output: "AddOutput {targetname}:{inputname}:{parameter}:{delay}:{max times to fire, -1 means infinite}"
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:SetParent:!activator:0.0:-1"
// Arguments can be left blank, but the empty blank should still be contained.
//// Raw text:
"OnUser1" "!self,AddOutput,OnUser1:ClearParent::0.0:-1"
|
ClearContext
- Removes all contexts from this entity's list.
ClearParent
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
FireUser1
toFireUser4
- Fires the respective
OnUser
outputs; see User Inputs and Outputs.
Kill
- Removes this entity and any entities parented to it from the world.
KillHierarchy
- Functions the same as
Kill
, although this entity and any entities parented to it are killed on the same frame, being marginally faster thanKill
input.
RemoveContext
<string>- Remove a context from this entity's list. The name should match the key of an existing context.
SetParent
<string>- Move with this entity. See Entity Hierarchy (parenting).
SetParentAttachment
<string>- Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.
SetParentAttachmentMaintainOffset
<string>- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
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.
Base:
OnUser1
toOnUser4
- These outputs each fire in response to the firing of the like-numbered
FireUser1
toFireUser4
Input; see User Inputs and Outputs.