Ai goal actbusy queue: Difference between revisions
Jump to navigation
Jump to search
Note:Actbusy hints not specified in the keyvalues will function as normal, as will NPCs who cannot join the queue.
Warning:Hint activities should not require exiting, or the queue will freeze.
mNo edit summary |
No edit summary |
||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:ai_goal_actbusy_queue}} | {{DISPLAYTITLE:ai_goal_actbusy_queue}} | ||
{{hl2 point|ai_goal_actbusy_queue}} | {{hl2 point|ai_goal_actbusy_queue}} | ||
[[Image:Ai goal actbusy queue queue.jpg|thumb|right|250px|This entity managed the food queue in ''d1_trainstation_02''.]] | |||
== Entity description == | == Entity description == | ||
Behaves the same way as an [[ai_goal_actbusy]] entity does, except that an <code>ai_goal_actbusy_queue</code> orders actbusy hints and [[NPC]]s in a queue. The queue can be moved forward, and when the first NPC in the queue leaves, it can be given orders. | Behaves the same way as an [[ai_goal_actbusy]] entity does, except that an <code>ai_goal_actbusy_queue</code> orders actbusy hints and [[NPC]]s in a queue. The queue can be moved forward, and when the first NPC in the queue leaves, it can be given orders. | ||
| Line 10: | Line 10: | ||
== Keyvalues == | == Keyvalues == | ||
{{KV BaseActbusyGoal}} | |||
{{KV|node_exit|target_destination|Exit Node - The name of the first node ([[info_node_hint]] or [[path_corner]]) the first NPC in the queue should head to when leaving the queue. Required.}} | |||
{{KV|node''01-20''|target_destination| Node ''1-20'' - The name of the ''n''th actbusy [[info_node_hint|hint node]] in the queue. (''Node 1'' is the front of the queue.) The number of defined nodes defines the maximum number of NPCs queuing.}} | |||
{{KV|mustreachfront|choices|Must Reach Front - If true, an NPC must strictly be at ''Node 1'' before being able to leave the queue.}} | |||
<!--This entity doesn't have any flags.--> | <!--This entity doesn't have any flags.--> | ||
Revision as of 16:47, 3 February 2012
Entity description
Behaves the same way as an ai_goal_actbusy entity does, except that an ai_goal_actbusy_queue orders actbusy hints and NPCs in a queue. The queue can be moved forward, and when the first NPC in the queue leaves, it can be given orders.
Note:Actbusy hints not specified in the keyvalues will function as normal, as will NPCs who cannot join the queue.Warning:Hint activities should not require exiting, or the queue will freeze.Keyvalues
AI_ActBusyGoal:
- Search Range for Busy Hints (busysearchrange) <float>
- Maximum distance between an actbusy hint and NPC for the NPC to consider it.
- Visible Busy Hints Only (visibleonly) <boolean>
- If set, an NPC will only consider actbusy hints in view when deciding which to use. Once the choice has been made it will not change, even if new hints become visible.
- Actbusy Type (type) <choices>
- Is this Actbusy part of combat? For use with Combat Safe Zone.
- 0: Default (Standard)
- 1: Combat
- Allow actor to teleport? (allowteleport) <boolean>
- Sight Entity (seeentity) <targetname>
- Optionally, if the Actor playing the ActBusy loses sight of this specified entity for an amount of time defined by Sight Entity Timeout, the specified entity will leave the ActBusy.
- Note:Only targetnames are allowed, not classnames!
- Sight Entity Timeout (seeentitytimeout) <float>
- Time in seconds to wait for an Actor to see the Sight Entity again before the entity may leave the ActBusy.
- Sight Enemy Method (sightmethod) <choices>
- How to determine if the Actor sees the Sight Entity.
- Combat Safe Zone (safezone) <targetname>
- Specify a brush entity to act as a safe zone if Actbusy Type is set to Combat. If any enemies are in the safe zone, the actbusy will break. Todo: Will actors go back to the actbusy once enemies are dead? What if they leave the safe zone but are still alive?
- node_exit ([todo internal name (i)]) <targetname>
- Exit Node - The name of the first node (info_node_hint or path_corner) the first NPC in the queue should head to when leaving the queue. Required.
- node01-20 ([todo internal name (i)]) <targetname>
- Node 1-20 - The name of the nth actbusy hint node in the queue. (Node 1 is the front of the queue.) The number of defined nodes defines the maximum number of NPCs queuing.
- mustreachfront ([todo internal name (i)]) <choices>
- Must Reach Front - If true, an NPC must strictly be at Node 1 before being able to leave the queue.
Inputs
- AI_ActBusyGoal:
- ForceNPCToActBusy <string>
- Format:
<targetname> [hint node targetname] [teleport] [nearest] [$<custom activity or sequence>] [max time] - Force an NPC to act busy.
- The targetname parameter specifies the name of the NPC(s).
- The hint node targetname parameter specifies the name of the Hint node. Used to force an NPC to act busy on a specific node. If no hint node targetname is specified, it'll search for a random one.
- If the teleport keyword is specified as a parameter, the NPC will teleport onto the actbusy node instead of navigating to it.
- If the nearest keyword is specified as a parameter, the NPC will choose the nearest valid actbusy node, instead of choosing one randomly from all valid actbusy nodes.
- The max time parameter specifies the maximum time to actbusy. If no max time is specified, it'll use the default. Specifying 0 as the max time will make the NPC(s) act busy until disturbed.
- The $customactivityorsequence parameter specifies the name of a custom activity, prepended by a "$", that the NPC(s) will preform while navigating to the node, e.g.
$ACT_RUNwill make the NPC(s) run to the node. Sequence names can be used instead of activities.
- ForceThisNPCToActBusy <targetname>
- Force an specified NPC to act busy. If there are multiple NPCs with the same name, only one will be ordered.
- ForceThisNPCToLeave <targetname>
- Force an NPC to find an NPC exit point (
HINT_NPC_EXIT_POINThintnode) and vanish. Supports wildcards.
- SetBusySearchRange <float>
- Alters the Search Range for Busy Hints keyvalue for all actors.
- MoveQueueUp
- Moves all NPCs in the queue up one position, and sends the first NPC to the Exit Node.
- PlayerStartedBlocking <float>
- Tell the queue manager that the player has started blocking the point in the queue passed as a parameter.
- PlayerStoppedBlocking <float>
- Tell the queue manager that the player has stopped blocking the point in the queue passed as a parameter.
Outputs
- AI_ActBusyGoal:
- OnNPCStartedBusy <targetname*>
- Fired when an NPC targeted by this entity starts an ActBusy animation sequence. This output automatically puts the targetname of the NPC into the parameter box for inputs, if the mapper does not override the parameter with something else.
- OnNPCFinishedBusy <targetname*>
- Fired when an NPC targeted by this entity finishes an ActBusy animation sequence. This output automatically puts the targetname of the NPC into the parameter box for inputs, if the mapper does not override the parameter with something else.
- OnNPCLeft <targetname*>
- Fired when an NPC targeted by this goal, ordered by the
ForceThisNPCToLeaveinput, finishes its forced leave. This output automatically puts the targetname of the NPC into the parameter box for inputs, if the mapper does not override the parameter with something else.
- OnNPCLostSeeEntity <targetname*>
- Fired when the NPC loses sight of the Sight Entity. This output automatically puts the targetname of the NPC into the parameter box for inputs, if the mapper does not override the parameter with something else.
- OnNPCSeeEnemy <targetname*>
- Fired when this NPC leaves their ActBusy because they saw an enemy. This output automatically puts the targetname of the NPC (that left the actbusy, not the enemy) into the parameter box for inputs, if the mapper does not override the parameter with something else.
- OnNPCStartedLeavingQueue <targetname]>
- Fired when the NPC at the head of the queue starts to leave. The activator is the NPC, and the targetname is of the NPC.
- OnNPCLeftQueue <targetname>
- Fired when the NPC at the head of the queue leaves and has reached the Exit Node. The activator is the NPC, and the targetname is of the NPC.
- OnQueueMoved <float>
- Fired when the queue moves. Outputs the number of NPCs remaining in the queue.
See also
- Actbusy Queues - description of the Actbusy queue system.