Point template: Difference between revisions
(-removed irrelevant info, moved fgd enhancments down, moved tutorial for respawning items into see also) |
m (Added clr for TOC. Details.) |
||
Line 1: | Line 1: | ||
{{lang|Point_template}} | {{lang|Point_template}} | ||
{{point ent|point_template|sprite=1}} | |||
{{ | {{clr}} | ||
== Entity Description == | == Entity Description == | ||
{{ent|point_template}} turns an [[entity]] or set of entities into a single template that can be instanced anywhere and multiple times. When activated, it will spawn the entities in the template at the same positions, relative to itself, that they had when this entity was created. This will be their original positions if the <code>point_template</code> has not been moved. To spawn the template in other places, an {{ent|env_entity_maker}} can be used. | {{ent|point_template}} turns an [[entity]] or set of entities into a single template that can be instanced anywhere and multiple times. When activated (<tt>ForceSpawn</tt>), it will spawn the entities in the template at the same positions, relative to itself, that they had when this entity was created. This will be their original positions if the <code>point_template</code> has not been moved. To spawn the template in other places, an {{ent|env_entity_maker}} can be used. | ||
{{tip|Any {{ent|logic_relay}} entities within a template will fire their OnSpawn output when spawned. This behavior can be used to make templated entities do things when they spawn.}} | {{tip|Any {{ent|logic_relay}} entities within a template will fire their <tt>OnSpawn</tt> output when spawned. This behavior can be used to make templated entities do things when they spawn.}} | ||
{{bug| | {{bug|{{insurgency}}{{doi}} This entity is broken and will usually crash the game. If the gamemode is set to training in {{insurgency}}, it will work normally.}} | ||
{{bug| | {{bug|{{csgo}} Spawning a {{ent|func_breakable_surf}} with this entity will crash the game.}} | ||
{{note|Any entity from [[S_PreserveEnts]] cannot be instanced.}} | {{note|Any entity from [[S_PreserveEnts]] cannot be instanced.}} | ||
Line 22: | Line 22: | ||
== Keyvalues == | == Keyvalues == | ||
{{KV|Template 1|intn=Template01|to=Template 16|target_destination| [[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.}} | {{KV|Template 1|intn=Template01|to=Template 16|intn2=Template16|target_destination| [[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.}} | ||
{{KV Targetname}} | {{KV Targetname}} | ||
Revision as of 17:18, 28 September 2022
Entity Description
point_template turns an entity or set of entities into a single template that can be instanced anywhere and multiple times. When activated (ForceSpawn), it will spawn the entities in the template at the same positions, relative to itself, 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.








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 any interdependent 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 !activator
can 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 2
is active, will the unremoved entity have its name postfixed with&0001?

point_template
will not do any name fixing-up in the parameter override boxes of its templated entities.Keyvalues
- Template 1 (Template01) to Template 16 (Template16) <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.
- Name (targetname) <string>[ Edit ]
- The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g.
parentname
ortarget
).
Also displayed in Hammer's 2D views and Entity Report.See also: Generic Keyvalues, Inputs and Outputs available to all entities
Flags
Inputs
- ForceSpawn
- Spawn an instance of the template at the original position.
Outputs
FGD Enhancement(s)
From TeamSpen210's Hammer Addons,point_template
can be made to show connecting lines to all entities part of its template.
First, go to this line in yourbase.fgd
and 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
- tutorial for respawning items using this entity
- 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