Template:I BaseActbusyGoal: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(fixed the really weird language about parameters that seems like it was written by someone who didn't quite understand the concept)
m (→‎top: Substituted IO templates)
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
{{IO|Activate|Begin acting busy. Begins ordering NPCs to actbusy.}}
{{minititle|AI_ActBusyGoal}}
{{IO|Deactivate|Cease acting busy. Ends ordering NPCs to actbusy. They will remain busy until they decide/are ordered to move, at which point they will return to normal behavior.}}
{{I|ForceNPCToActBusy|param=string|
{{IO|ForceNPCToActBusy|param=string|
:Format: <code><targetname> [hint node targetname] [teleport] [nearest] [$<custom activity or sequence>] [max time]</code>
:Format: <code><targetname> [hint node targetname] [teleport] [nearest] [$<custom activity or sequence>] [max time]</code>
:Force an NPC to act busy.
:Force an NPC to act busy.
Line 10: Line 9:
:*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 ''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. <code>$ACT_RUN</code> will make the NPC(s) run to the node. Sequence names can be used instead of activities.}}
:*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. <code>$ACT_RUN</code> will make the NPC(s) run to the node. Sequence names can be used instead of activities.}}
{{IO|ForceThisNPCToActBusy|param=targetname|Force an specified NPC to act busy. If there are multiple NPCs with the same name, only ''one'' will be ordered.}}
{{I|ForceThisNPCToActBusy|param=targetname|Force an specified NPC to act busy. If there are multiple NPCs with the same name, only ''one'' will be ordered.}}
{{IO|ForceThisNPCToLeave|param=targetname|Force an NPC to find an ''NPC exit point'' (<code>HINT_NPC_EXIT_POINT</code> hintnode) and vanish. Supports wildcards.}}
{{I|ForceThisNPCToLeave|param=targetname|Force an NPC to find an ''NPC exit point'' (<code>HINT_NPC_EXIT_POINT</code> hintnode) and vanish. Supports wildcards.}}
{{IO|SetBusySearchRange|param=float|Alters the '''Search Range for Busy Hints''' keyvalue for all actors.}}
{{I|SetBusySearchRange|param=float|Alters the '''Search Range for Busy Hints''' keyvalue for all actors.}}<noinclude>
[[Category:Input Templates|BaseActbusyGoal]]
</noinclude>

Latest revision as of 12:50, 21 April 2025

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_RUN will 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_POINT hintnode) and vanish. Supports wildcards.
SetBusySearchRange <float>
Alters the Search Range for Busy Hints keyvalue for all actors.