ai_addon_builder

From Valve Developer Community
Jump to: navigation, search

ai_addon_builder is a point entity available in the following Source engine games: <Counter-Strike: Global Offensive> Counter-Strike: Global Offensive, [Portal 2] Portal 2, <Alien Swarm> Alien Swarm.

Entity description

Bug: This entity is defined in the FGD but not implemented by the engine.

This entity was part of the "Directed Design Experiments" performed at Valve in November 2007, and is the base of a modular AI system, wherein enemies could collect upgrade chips to gain new abilities and drop them when dead, allowing other enemies to collect and reuse them. This code has never been released to the public or used in its entirety in a Valve title.

A related keyvalue called addon was defined in CBaseEntity, and a related input called CreateAddon was defined in CAI_BaseNPC. ([confirm] It might have been CBaseCombatCharacter.)

Keyvalues

NPC name <string>
Name to give built NPCs
Add on name <string>
Name to give built addons
NPC Points <integer>
Points available to spend for NPCs
Addon Points <integer>
Points available to spend for addons

Targetname:

Name <string>
The targetname that other entities refer to this entity by.
Entity Scripts <scriptlist> (New with 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 <string> (New with 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.

EnableDisable:

Start Disabled (StartDisabled) <boolean>
Stay dormant until activated (probably with the Enable input).

Inputs

Execute

Targetname:

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 than Kill.
AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
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. Can also be invoked by creating an output that does not specify an input.
This input is not included in Valve's FGDs.
RunScriptFile <script> (New with 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> (New with 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> (New with Left 4 Dead 2) !FGD
Execute a VScript function in the scope of the receiving entity.
SetLocalOrigin <coordinates> (New with 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> (New with Alien Swarm) !FGD
Set this entity's angles.

EnableDisable:

Enable
Disable
Enable/disable this entity from performing its task. It might also disappear from view.

Outputs

OnCreateNpc
Fires when an NPC is created.
OnFailedToCreateNpc
Fires when an NPC fails to be created.
OnCreateAddon
Fires when an Addon is created.
OnFailedToCreateAddon
Fires when an Addon fails to be created.

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 the Left 4 Dead series)
This Output fires when the entity is killed and removed from the game.