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

Env embers: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(added screenshot)
 
(20 intermediate revisions by 12 users not shown)
Line 1: Line 1:
{{wrongtitle|title=env_embers}}
<!-- When this page is updated to {{langsp}} or {{langsp}} instead of {{lang}}, please move {{this is a}} to the base page, as it is automatically translated. -->{{lang|Env embers}}{{CD|CEmbers|file1=effects.cpp}}[[File:env_embers.gif|thumb|250px|<code>env_embers</code> demonstration.]]
{{this is a|brush entity|name=env_embers}} It spawns fire embers within its volume. Its state can only be changed with the {{ent|Use}} input.


{{base_brush}}
{{sfx_brush}}


==Entity Description==
==Flags==
[[Image:{{PAGENAME}}.jpg|right|thumb|300px|An example of embers in-game. The embers are difficult to see in the thumbnail]]
{{fl|1|Start On}}
A brush [[entity]] which to spawn fire embers within its volume.
{{fl|2|Toggle|If left off, only one <code>Use</code> input will ever be accepted.}}
 
{{sfx_brush}}


==Keyvalues==
==Keyvalues==
* {{KV Targetname}}
{{KV Targetname}}
* {{KV Parentname}}
{{KV|Ember type |intn=particletype|choices|deprecated=1|Not present in code. The manner in which embers should appear and disappear.
* {{KV Angles}}
:*0: Normal
* '''particletype'''
:*1: Smooth Fade
: <choices> Ember type
:*2: Pulled}}
:{| class=standard-table
{{KV|Density |intn=density|int|Number of particles spawned each second.}}
! Literal Value || Description
{{KV|Particle Lifetime |intn=lifetime|int|Number of seconds each particle lasts for. A certain amount of randomness is added proportional to the time specified here.}}
|-
{{KV|Particle Speed |intn=speed|int|Number of units moved by particles each second.}}
| 0 || Normal
{{KV|Ember Color |intn=rendercolor|color255|Color of the sprites.}}
|-
| 1 || Smooth Fade
|-
| 2 || Pulled
|}
* '''density'''
: <integer> Density (particles per second)
* '''lifetime'''
: <integer> Particle Lifetime (seconds)
* '''speed'''
: <integer> Particle Speed (units per second)
* '''rendercolor'''
: {{color}} Ember Color
 
==Flags==
* 1 : Start On
* 2 : Toggle


==Inputs==
==Inputs==
* {{I Targetname}}
{{I|[[Use]]|Toggle the state of this entity.}}
* {{I Parentname}}
{{I|Color|nofgd=1|param=color255|Changes the color that new sprites will spawn with.}}
 
==Outputs==
* {{O Targetname}}

Latest revision as of 09:13, 28 October 2025

English (en)Translate (Translate)
C++ Class hierarchy
CEmbers
↳CBaseEntity
C++ effects.cpp
env_embers demonstration.

env_embers is a brush entity available in all Source Source games. It spawns fire embers within its volume. Its state can only be changed with the Use input.

Flags

Start On : [1]
Toggle : [2]
If left off, only one Use input will ever be accepted.

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

Ember type (particletype) <choices> Obsolete
Deprecated.
Not present in code. The manner in which embers should appear and disappear.
  • 0: Normal
  • 1: Smooth Fade
  • 2: Pulled
Density (density) <integer>
Number of particles spawned each second.
Particle Lifetime (lifetime) <integer>
Number of seconds each particle lasts for. A certain amount of randomness is added proportional to the time specified here.
Particle Speed (speed) <integer>
Number of units moved by particles each second.
Ember Color (rendercolor) <color255>
Color of the sprites.

Inputs

Use
Toggle the state of this entity.
Color <color255RedirectInput/color32> !FGD
Changes the color that new sprites will spawn with.
Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_embers&oldid=491562"