Env sprite oriented: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
(cleanup)
Line 1: Line 1:
{{wrongtitle|title=env_sprite_oriented}}
{{base_point|env_sprite_oriented}} It is an [[env_sprite]] that faces in a specific angular direction (as opposed to always facing the camera). __NOTOC__
{{base_point|env_sprite_oriented}}


== Entity description ==
{{Note|This entity will only work on sprites that are <code>[[$spriteorientation]] oriented</code>.}}
A [[env_sprite]] that allows manual fixed orientation of a sprite in game in relation to the world by setting the angles property. The sprite will ignore player position, and will only face the direction you have set for the angles.


{{Note|This entity will only work on sprites that has ''$spriteorientation oriented'' as a property within the related [[VMT]] file.}}
{{note|The only [[Render Modes|render modes]] that render sprite transparency are ''Glow'', ''Additive'', ''Additive Fractional Frame'' and ''World Space Glow''.}}


* 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]].
== See also ==
 
* [[env_sprite]]
* [[env_fire]]
* [[env_steam]]
* [[env_lightglow]]


== Keyvalues ==
== Keyvalues ==
* {{KV Angles}}


*; framerate <string>
{{KV env_sprite|angles=true}}
: Rate at which the sprite should animate, if at all.
: Default value is 10.0 fps.


*; model <sprite_name>
== Flags ==
: <sprite_name> is the Material of the sprite to be drawn.
: Default is "<code>sprites/glow01.spr</code>".
{{warning|When choosing a sprite from the sprite browser, the name it provides does not contain the required <code>.spr</code>/<code>.vmt</code> 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>
{{Fl env_sprite}}
: Scale multiplier of the sprite.
{{warning|The sprite preview doesn't display sprites at the right scale. The sprite preview scale is preset to <code>0.25</code>, while sprite scale in-game is preset to <code>1.0</code>. To correct the preview scale, set this keyvalue (to any value).}}


*; GlowProxySize <float>
== Inputs ==
: 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> 
{{I env_sprite}}
: Float value to multiply sprite color by when running in HDR mode. Default is 1.0.


* {{KV DXLevelChoice}}
== Outputs ==
* {{KV RenderFields}}
{{warning|The only [[Render Modes|render modes]] that render sprite transparency are ''Glow'', ''Additive'', ''Additive Fractional Frame'' and ''World Space Glow''.}}
* {{KV Parentname}}
* {{KV Targetname}}


== Flags ==
{{O Targetname}}
* 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)
* {{I Parentname}}
* {{I RenderFields}}
* {{I Targetname}}
 
== Outputs ==
* {{O Targetname}}

Revision as of 02:30, 24 July 2009

Template:Base point It is an env_sprite that faces in a specific angular direction (as opposed to always facing the camera).

Note.pngNote:This entity will only work on sprites that are $spriteorientation oriented.
Note.pngNote:The only render modes that render sprite transparency are Glow, Additive, Additive Fractional Frame and World Space Glow.

See also

Keyvalues

Template:KV env sprite

Flags

Template:Fl env sprite

Inputs

Template:I env sprite

Outputs