This article's documentation is for anything that uses the Source engine. Click here for more information.

Env entity maker: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(sprite)
(badly moved multipage rest of page history at Archived Page History/Env entity maker/en)
Line 1: Line 1:
{{this is a|point entity|name=env_entity_maker|sprite=1}} {{Multipage}}
{{LanguageBar}}
{{this is a|point entity|name=env_entity_maker|sprite=1}} <!-- Add the categories to the main page, not here -->
 
{{CD|CEnvEntityMaker|file1=env_entity_maker.cpp}}
It spawns a specified {{ent|point_template}} entity at the <code>env_entity_maker</code>'s [[origin]]. It can be set to spawn automatically or through inputs.
 
== Flags ==
{{fl|1|Enable AutoSpawn Spawn template whenever there's enough room to fit it, and the player is not looking.}}
{{fl|2|AutoSpawn: Wait for entity to be destroyed.}}
{{fl|4|AutoSpawn: Spawn even if the player is looking.}}
{{fl|8|ForceSpawn: Spawn only if there's enough room to fit the object.}}
{{fl|16|ForceSpawn: Spawn only if the player isn't looking.}}
 
== Keyvalues ==
{{KV Targetname}}
{{KV|Point_template To Spawn|intn=EntityTemplate|target_destination|Name of the <code>point_template</code> to spawn here. If there is an offset between the <code>point_template</code> and its spawned entities in hammer, that offset will be maintained when spawning happens relative to the <code>env_entity_maker</code>.}}
{{KV|PostSpawn Movement Speed|intn=PostSpawnSpeed|float|All entities spawned will move this many [[hammer units]] per second in the direction of '''PostSpawn Movement Direction'''.}}
{{KV|PostSpawn Movement Direction|intn=PostSpawnDirection|angle|If a PostSpawn Movement Speed is specified, this angle will be added to the movement direction of all the entities created by the template.}}
{{KV|PostSpawn Direction Variance|intn=PostSpawnDirectionVariance|float|The '''PostSpawn Movement Direction''' may vary by this many degrees. This is a radius.}}
{{KV|PostSpawn Inherit Angles|intn=PostSpawnInheritAngles|boolean|If checked, uses the parent's forward vector as the spawn direction. Otherwise uses the <code>env_entity_maker</code>'s forward.}}
 
== Inputs ==
{{IO|ForceSpawn|Spawn an instance of the template at this origin and angle.}}
{{IO|ForceSpawnAtEntityOrigin|param=target_destination|Spawn an instance of the template at the same origin and angles as a specified entity.}}
 
== Outputs ==
{{IO|OnEntitySpawned|Fired when an instance of the entity template has been spawned.}}
{{IO|OnEntityFailedSpawn|Fired when a <code>ForceSpawn</code> input failed to spawn the template, either due to lack of space or being in player's view, depending on the spawnflags.}}
 
== See Also ==
* {{ent|point_template}}

Revision as of 06:12, 14 July 2024

English (en)Русский (ru)中文 (zh)Translate (Translate)
Env entity maker.png

env_entity_maker is a point entity available in all Source Source games.

C++ Class hierarchy
CEnvEntityMaker
CPointEntity
CBaseEntity
C++ env_entity_maker.cpp

It spawns a specified point_template entity at the env_entity_maker's origin. It can be set to spawn automatically or through inputs.

Flags

Enable AutoSpawn Spawn template whenever there's enough room to fit it, and the player is not looking. : [1]
AutoSpawn
Wait for entity to be destroyed. : [2]
AutoSpawn
Spawn even if the player is looking. : [4]
ForceSpawn
Spawn only if there's enough room to fit the object. : [8]
ForceSpawn
Spawn only if the player isn't looking. : [16]

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Point_template To Spawn (EntityTemplate) <targetname>
Name of the point_template to spawn here. If there is an offset between the point_template and its spawned entities in hammer, that offset will be maintained when spawning happens relative to the env_entity_maker.
PostSpawn Movement Speed (PostSpawnSpeed) <float>
All entities spawned will move this many hammer units per second in the direction of PostSpawn Movement Direction.
PostSpawn Movement Direction (PostSpawnDirection) <angle>
If a PostSpawn Movement Speed is specified, this angle will be added to the movement direction of all the entities created by the template.
PostSpawn Direction Variance (PostSpawnDirectionVariance) <float>
The PostSpawn Movement Direction may vary by this many degrees. This is a radius.
PostSpawn Inherit Angles (PostSpawnInheritAngles) <boolean>
If checked, uses the parent's forward vector as the spawn direction. Otherwise uses the env_entity_maker's forward.

Inputs

ForceSpawn
Spawn an instance of the template at this origin and angle.
ForceSpawnAtEntityOrigin <targetnameRedirectInput/string>
Spawn an instance of the template at the same origin and angles as a specified entity.

Outputs

OnEntitySpawned
Fired when an instance of the entity template has been spawned.
OnEntityFailedSpawn
Fired when a ForceSpawn input failed to spawn the template, either due to lack of space or being in player's view, depending on the spawnflags.

See Also