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.
- 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 parentsTip:
phys_constraintcan be used as a workaround if parenting fails.
- Global Entity Name
- 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)
- 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)
- 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
- Pre-defined response system contexts; Format is
[key]:[value],[key]:[value],...and so on.Tip: Can also be filtered for or against!
- Toggles exclusive features of an entity, its specific number is determined by the combination of flags added.
- Hammer ID
- The entity's unique Hammer ID that's auto-generated on map compiles. Mainly used by plugins or debugging commands (like the
ent_keyvaluecommand). Run-time spawned entities don't have a Hammer ID.
- 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!
- 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.
- Assigns a new keyvalue/output on this entity. For keyvalues, some rely on extra necessary code to be ran and won't work if its simply just changed through this input. There is a strict format that must be followed:
- Removes all contexts from this entity's list.
- Removes this entity from the the movement hierarchy, leaving it free to move independently.
- Fires the respective
OnUseroutputs; see User Inputs and Outputs.
- 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
- Remove a context from this entity's list. The name should match the key of an existing context.
- 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.
- Dispatches a special effect from the entity's origin; see also List of Client Effects. Replaced by the particle system since .
- 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 Hammer, using string arguments will corrupt the VMF file's structure, making the file unviewable for the next Hammer session.
- Fix: Remove the string argument manually with a text editor.
- 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: