Env sprite oriented

Entity description

A env_sprite that allows orientation.

• Todo: This appears to be exactly the same as env_sprite except for the addition of the angles keyvalue which probably modifies or overrides the env_sprite behaviour vis: "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 env_fire, env_steam, and env_lightglow.

Keyvalues

• Template:Kv angles

• framerate <string>

Rate at which the sprite should animate, if at all.

Default value is 10.0 fps.

• model <sprite_name>

<sprite_name> is the Material of the sprite to be drawn.

Default is "sprites/glow01.spr".

Warning: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 <string>

Scale multiplier of the sprite.

Warning: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.0. 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.

Default value is 2.0.

• HDRColorScale <float>

Float value to multiply sprite color by when running in HDR mode. Default is 1.0.

• Template:Kv dxlevelchoice
• Template:Kv renderfields

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

• Template:Kv parentname
• Template:Kv targetname

Flags

• 1 : Start on
• 2 : Play Once

Inputs

• SetScale <float>

Set the scale (0 - 8.0).

• 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 <float>

Change red color channel's value (0-255)

• ColorGreenValue <float>

Change green color channel's value (0-255)

• ColorBlueValue <float>

Change blue color channel's value (0-255)

Parentname:

SetParent <stringRedirectInput/string>

Move with this entity. See Entity Hierarchy (parenting).

SetParentAttachment <stringRedirectInput/string>

Change this entity to attach to a specific attachment point on its parent. The entity will teleport so that the position of its root bone matches that of the attachment. Entities must be parented before being sent this input.

SetParentAttachmentMaintainOffset <stringRedirectInput/string>

As above, but without teleporting. The entity retains its position relative to the attachment at the time of the input being received.

ClearParent

Removes this entity from the the movement hierarchy, leaving it free to move independently.

• Template:I renderfields
• Template:I targetname

Outputs

• Template:O targetname