env_sprite
class hierarchy |
---|
CSprite defined in Sprite.cpp
|
env_sprite
is a point entity available in all Source games. It creates a sprite in the world. Sprites always face the player.
Note:This is a preserved entity in .
- On a new round, its properties including its position will intentionally not reset. You can use logic_auto to emulate resetting it.
- Killing it removes it forever, as it is not respawned on a new round.
- It cannot be spawned with a point_template.
- Parenting this with non preserved entities may have undesirable effects.
Note:The only render modes that render sprite transparency are Glow, Additive, Additive Fractional Frame, World Space Glow and Alpha Add !FGD.
Bug:Although the sprite preview in Hammer can find the sprite with any or no file extension, the actual extension of the used material must be used for the engine to be able to find the sprite in-game. In engine versions before Source 2009, when choosing a sprite from the sprite browser, the name it provides does not contain the required
.spr
/.vmt
file extension, so it must be adjusted by hand.AltNames: This entity is also tied to
env_glow
. Contents
Flags
Sprite:
- [
1
] : Start on
- [
2
] : Play Once - Used for animated sprites; texture will animate once, then the sprite will turn off.
Keyvalues
Targetname:
- Name
(targetname)
<string> - The targetname that other entities refer to this entity by.
Sprite:
- Sprite Name
(model)
<string> - The material to draw.
- Scale
(scale)
<float> - Scale multiplier of the sprite.
- Note:Hammer's default sprite scale
0.25
, but the engine's is1.0
. To synchronise the values, set this keyvalue to something.
- Framerate
(framerate)
<string> - Rate at which the sprite should animate, if at all.
- Starting Frame
(frame)
<float> !FGD - If the sprite is animated, the frame it should start animating on.
- Size of Glow Proxy Geometry
(GlowProxySize)
<float> - Size of the glow to be rendered for visibility testing. Any time a sphere of this radius would be visible (poking through any nearby geometry), the glow will be rendered.
DXLevelChoice:
- Minimum / Maximum DX Level
(mindxlevel / maxdxlevel)
<choices> (removed since ) - The entity will not exist if the engine is running outside the given range of DirectX Versions.
Warning:If these are used, the object may break when the user switches their DirectX settings.
|
SystemLevelChoice:
- Minimum / Maximum Effect Details Level
(mincpulevel / maxcpulevel)
<choices> (in all games since ) - Don't render for players with Effect Details levels that exceed the minimum or maximum.[Key names are related to
cpu_level
cvar used by Effect Details.]
|
- Minimum / Maximum Shader Details Level
(mingpulevel / maxgpulevel)
<choices> (in all games since ) - Don't render for players with Shader Details levels that exceed the minimum or maximum.[Key names are related to
gpu_level
cvar used by Shader Details.]
|
RenderFields:
- Render Mode
(rendermode)
<choices> - Set a non-standard rendering mode on this entity.
- Render FX
(renderfx)
<choices> - Various somewhat legacy alpha effects.
Bug:Alpha effects from 0 to 10 are unavailable due to the bug in code in Counter-Strike: Global Offensive
|
- Render FX / Transparency (0 - 255)
(renderamt)
<integer> - Transparency amount, requires a Render Mode other than Normal. 0 is invisible, 255 is fully visible.
- Render Color (R G B)
(rendercolor)
<color255> - Color tint.
- Disable Receiving Shadows
(disablereceiveshadows)
<boolean> - Prevent the entity from receiving shadows on itself.
Inputs
Sprite:
SetScale
<float>- Sets Scale.
HideSprite
- Makes the sprite invisible.
ShowSprite
- Makes sprite visible.
ToggleSprite
- Make sprite invisible or visible depending on the current state.
ColorRedValue
<float>- Change the intensity of the red channel (0-255).
ColorGreenValue
<float>- Change the intensity of the green channel (0-255).
ColorBlueValue
<float>- 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 than0
.
Color
<color255>- Sets an RGB color for the entity.