Env sprite

From Valve Developer Community

The title given to this article is incorrect due to technical limitations. The correct title is env_sprite.

This point-based entity is available in all Source games.

Table of contents
1 Entity description
2 Keyvalues
3 Flags
4 Inputs
5 Outputs
[edit]

Entity description

Creates a sprite in the world. Sprites always face the player, unless they are restricted to rotating on certain axes as specified in the VTF compile parameters. This entity should be treated as an "override" for certain sprite effects, as more specific controls already exist for fire, steam, or light glows.

The only render modes that render sprite transparency are Glow, Additive, Additive Fractional Frame and World Space Glow.

[edit]

Keyvalues

Defines the name that other entities refer to this entity by.
  • hammerid [Episode Two Update]
<integer readonly> This id is used for debugging purposes in Hammer.
Specifies the targetname of this entity's Parent in a movement hierarchy. Child entities move with their Parent.
  • renderfx
<choices>
Literal Value Description
0 Normal
1 Slow Pulse
2 Fast Pulse
3 Slow Wide Pulse
4 Fast Wide Pulse
5 Slow Fade Away
6 Fast Fade Away
7 Slow Become Solid
8 Fast Become Solid
9 Slow Strobe
10 Fast Strobe
11 Faster Strobe
12 Slow Flicker
13 Fast Flicker
14 Constant Glow
15 Distort
16 Hologram (Distort + fade)
17 Scale up
22 Spotlight FX
23 Cull By Distance (TEST)
24 Fade Wider Pulse
  • rendermode
<choices> Used to set a non-standard rendering mode on this entity. See also 'FX Amount' and 'FX Color'.
Literal Value Render Mode Description (Click for more info.)
0 Normal Default rendering.
1 Color Obsolete.
2 Texture Plain opacity.
3 Glow No Z buffer checks. Fixed size on screen.
4 Solid / Alphatest Obsolete. (Use alphatest capabilities in materials instead.)
5 Additive Obsolete. Add this entity's color to what's behind it.
7 Additive Fractional Frame Obsolete? Blend between animation frames.
8 Alpha Add (Not in FGD.) Add alpha.
9 World Space Glow No Z buffer checks. Fixed size in world (as opposed to on screen).
10 Dont Render / None Don't render.
  • renderamt
<integer> FX Amount (0 - 255) - How opaque the entity will be rendered. (0 is fully transparent, while 255 is fully opaque). Will not work if the rendermode keyvalue is set to Normal or Dont Render.
  • rendercolor
<color255> FX Color - What color the entity will be rendered in (to the degree of the opacity set with renderamt).
  • mindxlevel
<choices> Minimum DX Level
Literal Value Description
0 default (lowest)
70 dx7
  • maxdxlevel
<choices> Maximum DX Level
Literal Value Description
0 default (lowest)
60 dx6
  • HDRColorScale
<float> Float value to multiply sprite color by when running in HDR mode.
  • framerate
<float> Rate at which the sprite should animate, if at all.
  • model
<sprite> Material of the sprite to be drawn.
Image:note.png Note: When choosing a sprite from the sprite browser, the name it provides does not contain the required .spr/.vmt file extension. While the sprite preview can find the sprite, the extension needs to be typed in by hand for the engine to be able to find the sprite in-game.
  • scale
<float> Scale multiplier of the sprite.
Image:note.png Note: The sprite preview doesn't display sprites at the right scale. The sprite preview scale is preset to 0.25, while sprite scale in-game is preset to 1. To correct the preview scale, set this keyvalue (to any value).
  • GlowProxySize
<float> Size of the glow to be rendered for visibility testing. Must be larger than the distance from the sprite center to empty space. So if this glow is inside geometry (like a light bulb), set this value to be bigger than the bulb's radius. Any time a sphere of this radius would be visible (poking through any nearby geometry), the glow will be rendered.
[edit]

Flags

  • 1 : Start on
  • 2 : Play Once
[edit]

Inputs

  • Kill
Removes this entity from the world.
Removes this entity and all its children from the world.
  • AddOutput <string>
Evaluates a keyvalue/output on this entity. It can be potentially very dangerous, use with care.
Format: <key> <value>
Format: <output name> <targetname>:<inputname>:<parameter>:<delay>:<max times to fire (-1 == infinite)>
Causes this entity's OnUser1-4 outputs to be fired. See User Inputs and Outputs.
Set the rendercolor.
Set the renderamt.
Changes the entity's parent in the movement hierarchy.
Change this entity to attach to a specific attachment point on its parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment.
Change this entity to attach to a specific attachment point on it's parent. Entities must be parented before being sent this input. The parameter passed in should be the name of the attachment. The entity will maintain it's position relative to the Parent's Origin and Angles at the time it is attached.
Removes this entity from its current movement hierarchy.
  • SetScale <float>
Set the scale.
  • HideSprite
Hide the sprite. Won't be drawn until the 'ShowSprite' input is received.
  • ShowSprite
Show the sprite.
  • ToggleSprite
Toggle the sprite between hidden and shown.
  • ColorRedValue [Episode Two Update]
Change red coloration
  • ColorGreenValue [Episode Two Update]
Change green coloration
  • ColorBlueValue [Episode Two Update]
Change blue coloration
[edit]

Outputs

Fired in response to FireUser1-4 inputs. See User Inputs and Outputs.
!activator = activator
Retrieved from "http://developer.valvesoftware.com/wiki/Env_sprite"