point_template

point_template is a point entity available in all Source games. It turns an entity, or set of entities, into a single template that can be instanced anywhere, and multiple times.

 Bug:  In , spawning a func_breakable_surf with this entity will crash the game.

If there are interdependencies (entity I/O, hierarchy, or other name references) between the entities in the template, the entities in the template will have their names changed and the interdependencies will be reconnected to the changed names. The name change format is as follows: '<original name>&0000', where the 0000 will be replaced with the current global template instance, so wildcard searches for '<original name>*' will still find them.

If you don't want the name fixup to happen, because you're only spawning the template once, or you want inputs to trigger all instances of the template, check the 'Preserve entity names' spawnflag.

When activated, this entity will spawn the entities in the template at the same positions, relative to this entity, that they had when this entity was created. This will be their original positions if the point_template has not been moved.

To spawn the template in other places, an env_entity_maker can be used.

Notes on name fixup

Name fixing is only performed on the outputs of template entities (the entities being spawned). The outputs of the point_template are not fixed, and neither are the outputs of other objects referring to template entities.

The special targetnames (see the targetname article) work on spawned objects, so a trigger_multiple with an output to !activator can be used to effect individual spawned objects. Wildcards can refer to all entities spawned by a fix-up-enabled point_template.

With fixup on, the first entity spawned will be named with &0002. If the Do not remove template spawnflag of the point_template is enabled, the unremoved template entity will have its name fixed with number &0001.

 Bug:  Spawning any entity that has its targetname ending with a number when naming fixup is enabled (for instance, a targetname weapon_mp9, ending with a 9) will prevent the entire template from spawning at all, generating multiple errors in the console instead. Don't use targetnames that end with a number. Numbers can, however, be used as long as they are not closing the targetname.

Tutorial

A tutorial has been created for respawning items using this entity.

Keyvalues

Template 1 to Template 16 <targetname>

Targetname(s) to search for entities to template. These can be exact matches, or wildcards (*). If multiple entities are matched, all entities will be included in the template.

Targetname:

Name (targetname) <string>

The targetname that other entities refer to this entity by.

Entity Scripts (vscripts) <scriptlist> (in all games since )

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 )

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

• 1 : Don't remove template entities

By default, a point_template will first remember all of its template entities, then it will kill them (remove them from the map completely). This flag overrides that, leaving the template entities in the map.

• 2 : Preserve entity names (Don't do name fixup)

Causes the spawned entities to be named exactly as their templates were (as opposed to renamed; see above).

Inputs

ForceSpawn

Spawn an instance of the template at the original position.

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 )

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 )

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 , 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 ) !FGD

Execute a VScript function in the scope of the receiving entity.

SetLocalOrigin <coordinates> (in all games since ) !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 ) !FGD

Set this entity's angles.

Outputs

OnEntitySpawned

Fired after spawning an instance of this template.

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 )

This output fires when the entity is killed and removed from the game.

See also

• env_entity_maker - automatic respawning and/or spawning at a different location - and npc_maker - an alternative spawning entity, also with optional automatic respawning.