ai_goal_patrol
ai_goal_patrol is a point entity available in 
Dark Messiah of Might and Magic.
…
It is used to make NPCs patrol between info_node_hints or make them wander around the map.
Keyvalues
- Movement type
(movetype)<integer> - How the NPC should move around while under the influence of this entity.
- 1: Walk
- 2: Run
- 3: Custom Move—Use Custom Animation
- Patrol Modes
(patrolmode)<integer> - Which patrol mode the NPC should use.
- 1: Idle
- 2: Wander Around
- 3: Node to Node Cycling
- 4: Node to Node Ping-Pong
- Radius for wander state
(wanderradius)<float> - The radius for which the NPC will find nodes to move to. Only used if
Patrol Modesis set toWander Around.
- Custom Move Animation
(m_iszCustomMove)<string> - Custom move animation to use for the NPC if
Movement typeis set toCustom Move.
- Node 1
(goal1)to Node 15(goal15)<targetname> - Nodes the NPC will go to depending on the patrol mode. In
Wander Aroundmode, Node 1 is used as the center of theRadius for wander statekeyvalue.
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_constraintcan 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
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.
FireUser1toFireUser4- Fires the respective
OnUseroutputs; 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 thanKillinput.
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
Base:
OnUser1toOnUser4- These outputs each fire in response to the firing of the like-numbered
FireUser1toFireUser4Input; see User Inputs and Outputs.
