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.
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.
spawnflag 2is active, will the unremoved entity have its name postfixed with
A tutorial has been created for respawning items using this entity.
- Template 1
(Template01)to Template 16
- 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.
- The classname defines the type of entity. Classnames can be changed using
AddOutput, which will influence how the engine deals with the entity in certain circumstances.
- The name that other entities refer to this entity by.
- Global Entity Name
- Name by which this entity is linked to another entity in a different map. When the player transitions to a new map, entities in the new map with globalnames matching entities in the previous map will have the previous map's state copied over their state.
- Specifies a movement parent. An entity will maintain its initial offset from its parent. An attachment point can be added to the end of the name, separated by a comma. Every entity can be parented, even point entities. Entities which are parented will be forced to transition to the next map, such as from a
trigger_transition. Some entities which aren't intended to be parented may not function correctly.
phys_constraintcan be used as a workaround to parenting.
- Origin (X Y Z)
- The position of this entity's center in the world. Rotating entities typically rotate around their origin.
- Pitch Yaw Roll (X Y Z)
- 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.
- Toggles features of an entity, its specific number is determined by the combination of flags added.
- Response Contexts
- Pre-defined response system contexts for this entity. Format is
key:value,key:value,.... Contexts may be filtered.
- Combination of effect flags to use.
- Local Time
- The local time of the entity, independent of the global clock. Used mainly for physics calculations.
- Next Think
- Amount of time before the entity thinks again.
- Hammer ID
- The entity's Hammer ID. Mainly used by plugins and debugging commands, such as
ent_keyvalue. Can be manually assigned with the "hammerid" or "id" keyvalue. Entities spawned at run-time are not assigned any Hammer ID.
- Disable for Xbox 360
- If Yes, disables this entity on the Xbox 360 version of Source.
- Entity Scripts
- 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
- 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
- Set to Yes to lag compensate this entity. Should be used very sparingly!
- Deprecated. Which Team the entity belongs / is assigned to on spawn. Doesn't do anything in .
- 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).
- Spawn an instance of the template at the original position.
- Removes this entity and any entities parented to it from the world.
- Functions the same as
Kill, although this entity and any entities parented to it are killed on the same frame, being marginally faster than
- Move with this entity. See Entity Hierarchy (parenting).
- 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.
- As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
- Evaluates a keyvalue/output on this entity.
<output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire, -1 means infinite>
- Fire the
OnUseroutputs; see User Inputs and Outputs.
- 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.
- Dispatches a special effect from the entity's origin. Removed and replaced entirely by the particle system since .
- Dispatches a response to the entity. See Response and Concept.
- Adds to the entity's list of response contexts. Format is
- Remove a context from this entity's list. The name should match the key of an existing context.
- Removes all contexts from this entity's list.
- Execute a VScript file from disk, without file extension. The script contents are merged with the script scope of the receiving entity.
- 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.
- Execute a VScript function in the scope of the receiving entity.
- Deprecated. Doesn't do anything in .
- Fired after spawning an instance of this template.
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 your
base.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: