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. 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. For any logic_relay entities within a template, will fire its OnSpawn output when spawned.

 Bug: In , this entity is broken and will usually crash the game. Although if the gamemode is set to training in , it will work normally.

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

 Note: Any entity from S_PreserveEnts cannot be instanced.

Before using this entity, consider sections like Name Fix-up and FGD Enhancement(s) first.

Name Fix-up

To prevent interdependencies (entity I/O, hierarchy, or other name references) between entities, the entities in the template will have their names changed, with the interdependencies outputs reconnected to the changed names. The name change format is as follows: '<original name>&XXXX', where the '&XXXX' will be replaced with the current global template instance spawn count, so wildcard searches for '<original name>&*' will still find them. Name fixing is only for template entities spawned by output; The outputs of the point_template are not name fixed, and neither are the outputs of other objects referring to template entities.

The special targetnames (!self and such) work on spawned objects, so a trigger_multiple with an output to!activatorcan be used to affect individual spawned objects. Wildcards can refer to all entities spawned by a fix-up-enabled point_template.

Note that if '"Don't remove template entities"' flag is active, the first (batch of) entities spawned will be postfixed&0002. 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.

Confirm:Ifspawnflag 2is active, will the unremoved entity have its name postfixed with&0001?

 Warning:  Point_template will not do any name fixuppance in the parameter override boxes of its templated entities.

Tutorial

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

Keyvalues

Template 1 (Template01) 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.

Base:

Name (targetname) <string>

The name that other entities use to refer to this entity.

Parent (parentname) <targetname>

Maintain the same initial offset to this entity. An attachment point can also be used if separated by a comma at the end. (parentname [targetname],[attachment])

 Tip: Entities transition to the next map with their parents

 Tip: phys_constraintcan be used as a workaround if parenting fails.

Global Entity Name (globalname) <string>

When the player transitions to a new map, entities in the new map with matching globalnames will have their previous map's states copied over to it.

Origin (X Y Z) (origin) <coordinates>

The position of this entity's center in the world. Rotating entities typically rotate around their origin.

 Note: Hammer does not move the entities accordingly only in the editor.

Pitch Yaw Roll (X Y Z) (angles) <angle>

This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

 Note: This works on brush entities, although Hammer doesn't show the new angles.

Response Contexts (ResponseContext) <string>

Pre-defined response system contexts; Format is [key]:[value],[key]:[value],...and so on.

 Tip: Can also be filtered for or against!

Classname (classname) <string> !FGD

Determines the characteristics of the entity before it spawns.

 Tip: Changing classnames using theAddOutputinput can still influence the game's code, like making the classname match one element in the S_PreserveEnts list will make the entity persists on new rounds!

Flags (spawnflags) <integer> !FGD

Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.

Effects (effects) <integer> !FGD

Combination of effect flags to use.

Hammer ID (hammerid) <integer> !FGD

The entity's unique Hammer ID that's auto-generated on map compiles. Mainly used by plugins or debugging commands (like theent_keyvaluecommand). Run-time spawned entities don't have a Hammer ID.

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. Try to avoid expensive operations in this function, as it may cause performance problems.

Lag Compensation (LagCompensate) <boolean> (in all games since ) !FGD

Set to Yes to lag compensate this entity. Should be used very sparingly!

Disable for Xbox 360 (disableX360) <boolean> (in all games since ) !FGD

If this entity should automatically be given the 'Disable' input on the Xbox 360 version of Source.

Flags

• 1 : Don't remove template entities - Prevent template entities being removed automatically.
• 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).

Inputs

ForceSpawn

Spawn an instance of the template at the original position.

Base:

AddOutput <string>

Evaluates a keyvalue/output on this entity.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>

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 thanKillinput.

SetParent <string>

Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <string>

Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.

SetParentAttachmentMaintainOffset <string>

As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.

ClearParent

Removes this entity from the the movement hierarchy, leaving it free to move independently.

FireUser1 to FireUser4

Fire the OnUser outputs; see User Inputs and Outputs.

AddContext <string>

Adds to the entity's list of response contexts. Format is <key>:<value>.

RemoveContext <string>

Remove a context from this entity's list. The name should match the key of an existing context.

ClearContext <string>

Removes all contexts from this entity's list.

DispatchEffect <string> (removed since ) !FGD

Dispatches a special effect from the entity's origin. Removed and replaced entirely by the particle system since .

DispatchResponse <string> !FGD

Dispatches a response to the entity. See Response and Concept.

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> (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.

SetTeam  !FGD 

Deprecated. Doesn't do anything in or .

TeamNum  !FGD 

Deprecated. Doesn't do anything in or .

Outputs

OnEntitySpawned

Fired after spawning an instance of this template.

FGD Enhancement(s)

From TeamSpen210's Hammer Addons,point_templatecan be made to show connecting lines to all entities part of its template.

First, go to this line in yourbase.fgdand highlight the same characters:

@PointClass base(Targetname) iconsprite("editor/point_template.vmt") = point_template :

Then copy all of this, and paste all of this over it:

@PointClass base(BaseEntityPoint) 
	iconsprite("editor/point_template.vmt")
	line(255 255 0, targetname, Template01)
	line(255 255 0, targetname, Template09)
	line(255 255 0, targetname, Template02)
	line(255 255 0, targetname, Template10)
	line(255 255 0, targetname, Template03)
	line(255 255 0, targetname, Template11)
	line(255 255 0, targetname, Template04)
	line(255 255 0, targetname, Template12)
	line(255 255 0, targetname, Template05)
	line(255 255 0, targetname, Template13)
	line(255 255 0, targetname, Template06)
	line(255 255 0, targetname, Template14)
	line(255 255 0, targetname, Template07)
	line(255 255 0, targetname, Template15)
	line(255 255 0, targetname, Template08)
	line(255 255 0, targetname, Template16)
= point_template:

See also

• env_entity_maker - automatic respawning and/or spawning at a different location
• npc_maker - an alternative spawning entity, also with optional automatic respawning
• point_script_template - version of point_template catered to VScripting