aiscripted_schedule

From Valve Developer Community
Revision as of 00:38, 26 February 2015 by Maki (talk | contribs) (Added "StopSchedule" input, which is !FGD, but exists in the Valve Github code and appears to work.)

Jump to: navigation, search
Aiscripted schedule.png


aiscripted_schedule is a point entity available in all Source games. It issues a command to an NPC without suppressing its normal AI routines.

See also

Keyvalues

Target NPC <targetname>
The name or classname of an NPC to command.
Search Radius (0=everywhere) <float>
Radius to search within for an NPC to command.
All in radius <boolean>
Whether to grab all matching NPCs in the specified radius, or just the first one found.
AI state to set <choices>
Overrides the NPC's current alertness state.
  • <None>
  • Idle
  • Alert
  • Combat
Schedule to run <choices>
Which AI schedule to run.
  • <None>
  • Walk to Goal Entity
  • Run to Goal Entity
  • Set enemy to Goal Entity
  • Walk Goal Path
  • Run Goal Path
  • Set enemy to Goal Entity AND Run to Goal Entity
Interruptability <choices>
What can cause the NPC to give up on this schedule?
  • General
  • Damage or Death
  • Death
Goal entity <targetname>
Provides the name of a goal entity, used by some schedules.

Targetname:

Name (targetname) <string>
The targetname that other entities refer to this entity by.
Entity Scripts (vscripts) <scriptlist> (in all games since <Left 4 Dead 2>)
Space delimited list of VScript files (without file extension) that are executed after all entities have spawned. The scripts are all executed in the same script scope, later ones overwriting any identical variables and functions.
Script think function (thinkfunction) <string> (in all games since <Left 4 Dead 2>)
Name of a function in this entity's script which will be called automatically every 100 milliseconds (ten times a second) for the duration of the script. It can be used to create timers or to simulate autonomous behavior. The return value (if present) will set the time until the next call.
Note:Try to avoid expensive operations in this function, as it may cause performance problems.

Flags

  • Repeatable
  • Search Cyclically: If the target parameters can apply to more than one entity, the aiscripted_schedule will normally select one of these targets to affect at random each time it is triggered. Checking this flag will instead make it cycle through a list of them, affecting all the entities in order as it is triggered. This is useful for making sure that every member of the group will eventually be affected, especially when targeting the schedule to affect multiple spawns.
  • Don't Complain: the following messages will be suppressed:
    • Found <entity>, but can't play!
    • ScheduledMoveToGoalEntity to goal entity <entity> failed, can't execute script <this>
    • ScheduledFollowPath to goal entity <entity> failed, can't execute script <this>

Inputs

StartSchedule
Starts the scripted schedule. This will first locate an NPC that matches the given target, then tell the NPC to run the specified schedule.
StopSchedule !FGD
Tells NPC targets to stop running this schedule.

Targetname:

Kill
Removes this entity from the world.
KillHierarchy
Removes this entity and its children from the world.
Note:Entities already remove orphaned children upon being removed, but this input removes all children on the same frame, being marginally faster than Kill.
AddOutput <string>
Adds a keyvalue/output to this entity. It can be potentially very dangerous, use with care.
KV Format: <key> <value>
I/O Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
FireUser1 to FireUser4
Fire the OnUser outputs; see User Inputs and Outputs.
Use  !FGD
Same as a player invoking +use; may not do anything depending on the entity. Can also be invoked by firing an output that does not specify an input.
RunScriptFile <script> (in all games since <Left 4 Dead 2>)
Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
RunScriptCode <string> (in all games since <Left 4 Dead 2>)
Execute a string of VScript source code in the scope of the entity receiving the input. String quotation may be needed when fired via console.
Bug: In <Left 4 Dead 2>, the code is executed in the script scope of the entity that fires the output, not the one receiving the input.
Warning: Never try to pass string parameters to a script function with this input. It will corrupt the VMF structure because of the nested quotation marks, which then must be removed manually with a text editor.
CallScriptFunction <string> (in all games since <Left 4 Dead 2>) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (in all games since <Alien Swarm>) !FGD
Send this entity to a spot in the map. If the entity is parented to something, it will be offset from the parent by this amount.
SetLocalAngles <angles> (in all games since <Alien Swarm>) !FGD
Set this entity's angles.

Outputs

Targetname:

OnUser1 to OnUser4
These outputs each fire in response to the firing of the like-numbered FireUser1 to FireUser4 Input; see User Inputs and Outputs.
OnKilled  (only in <Left 4 Dead><Left 4 Dead 2>)
This output fires when the entity is killed and removed from the game.