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

Env entity igniter: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
 
(28 intermediate revisions by 19 users not shown)
Line 1: Line 1:
{{wrongtitle|title=env_entity_igniter}}
{{LanguageBar}}
{{CD|CEntityFlame|file1=1}}
{{CD|CEnvEntityIgniter|file1=1|game={{l4d2|since}}}}


==Entity Description==
{{This is a|point entity|name=env_entity_igniter}} It catches a target entity on fire. If the target is an animating model, it will have flame [[sprite]]s attached to its [[skeleton]]. Otherwise the target will emit particle flame puffs.
An entity that catches a target entity on fire. If the entity is an animating model, it will have sprite flames attached to its skeleton. Otherwise the entity will emit particle flame puffs.


==Availability==
{{altnames|name1=entityflame|misc=See {{|Code}}}}
{{in game|point}} {{game-base}}
{{in code|class=CEntityFlame|file=EntityFlame.cpp}}


==Keyvalues==
== Keyvalues ==
*{{kv targetname}}
{{KV Targetname}}
*'''target'''
{{KV|Entity to ignite|intn=target|target_destination|Name of the entity to catch on fire.}}
:<target_destination> Name of the entity to catch on fire.
{{KV|Lifetime in seconds|intn=lifetime|float|Duration of flames.}}
*'''lifetime'''
:<float> Duration of flames.


==Inputs==
== Inputs ==
*{{i Targetname}}
{{I|Ignite|Ignite the target entity.}}
*'''Ignite'''
:Ignite the target entity.


==Outputs==
== Code ==
*{{o Targetname}}
Prior to {{l4d2|2}} <kbd>env_entity_igniter</kbd> and <kbd>entityflame</kbd> are tied to the same C++ class called <code>CEntityFlame</code>. <kbd>env_entity_igniter</kbd> is the entity available in FGD for the mapper to setup target, lifetime and then fire Ignite input. After Ignite input is fired the game creates <kbd>entityflame</kbd> setting up its FlameThinker and attaching itself to the targetted entity.


[[Category:Entities]]
Since {{l4d2|2}} the functionality exposed to mapping i.e. lifetime keyvalue and Ignite input is stripped from <code>CEntityFlame</code> and instead <code>CEnvEntityIgniter</code> is created that solely has the purpose to initiate the ignition while <kbd>entityflame</kbd> remains as <code>CEntityFlame</code> doing the burning.

Latest revision as of 06:32, 25 April 2025

English (en)中文 (zh)Translate (Translate)
C++ Class hierarchy
CEntityFlame
CBaseEntity
C++ EntityFlame.cpp
C++ Class hierarchy
(in all games since Left 4 Dead 2)
CEnvEntityIgniter
CBaseEntity
C++ EntityFlame.cpp

env_entity_igniter is a point entity available in all Source Source games. It catches a target entity on fire. If the target is an animating model, it will have flame sprites attached to its skeleton. Otherwise the target will emit particle flame puffs.

AltNames.pngAltNames: This entity is also tied to entityflame. See Code ↓

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

Entity to ignite (target) <targetname>
Name of the entity to catch on fire.
Lifetime in seconds (lifetime) <float>
Duration of flames.

Inputs

Ignite
Ignite the target entity.

Code

Prior to Left 4 Dead 2 Left 4 Dead 2 env_entity_igniter and entityflame are tied to the same C++ class called CEntityFlame. env_entity_igniter is the entity available in FGD for the mapper to setup target, lifetime and then fire Ignite input. After Ignite input is fired the game creates entityflame setting up its FlameThinker and attaching itself to the targetted entity.

Since Left 4 Dead 2 Left 4 Dead 2 the functionality exposed to mapping i.e. lifetime keyvalue and Ignite input is stripped from CEntityFlame and instead CEnvEntityIgniter is created that solely has the purpose to initiate the ignition while entityflame remains as CEntityFlame doing the burning.