env_spritetrail

Class hierarchy
CSpriteTrail ↳CSprite ↳CBaseEntity
SpriteTrail.cpp

env_spritetrail is a point entity available in all  Source games.

It frequently emits a sprite, intended to create a trail effect when moving.

Todo: Add applicable properties from env_sprite. Not all work, such as scale, and the alpha input appears to be a boolean, rendering it invisible for values less than 1.

Note: Killing this entity will also remove the trail even if the trail isn't fully disappeared.

Bug: Potential silent crash to desktop when looked at if the sprite material referenced is missing, misspelled, or has no .vmt extension in hammer.  [todo tested in ?]

Keyvalues

Name (targetname) <string>

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

Lifetime (lifetime) <float>

How long the beam is shown.

Start Width (startwidth) <float>

The width of the beam to the beginning.

End Width (endwidth) <float>

The width of the beam when it has full expanded.

Sprite Name (spritename) <string>

The material to draw.

Animated (animate) <boolean> !FGD

Confirm:Supposed to tell the sprite to animate if it can, however only framerate appears to control this.

RenderFields:

Render Mode (rendermode) <byte choices>

Set a non-standard rendering mode on this entity.

Render Modes

0: Normal 1: Color 2: Texture 3: Glow 4: Solid/Alphatest 5: Additive 6: Removed, does nothing 7: Additive Fractional Frame 8: Alpha Add 9: World Space Glow 10: Don't Render

Render FX (renderfx) <byte choices>

Various somewhat legacy alpha effects. See render effects.

Render Amount / Transparency (renderamt) <byte>

Default Value: 255
Translucency amount, requires a Render Mode other than Normal or Solid. 0 is invisible, 255 is fully visible.

Render Color (R G B) (rendercolor) <color255>

Default Value: 255 255 255
Color tint.

Inputs

SetScale <floatRedirectInput/float> !FGD

Set the sprites Scale (0 - 8.0).

HideSprite  !FGD

Makes the sprite invisible.

ShowSprite  !FGD

Makes sprite visible.

ToggleSprite  !FGD

Make sprite invisible or visible depending on the current state.

ColorRedValue <floatRedirectInput/float> !FGD

Change the intensity of the red channel (0-255).

ColorGreenValue <floatRedirectInput/float> !FGD

Change the intensity of the green channel (0-255).

ColorBlueValue <floatRedirectInput/float> !FGD

Change the intensity of the blue channel (0-255).

RenderFields:

Alpha <integer 0–255>

Sets the entity's transparency to a number from 0 (invisible) to 255 (fully visible). Requires the entity to have its rendermode set to a number other than 0.

Color <color255RedirectInput/color32>

Sets an RGB color for the entity.