View source for Sprite

{{LanguageBar}}
{{split|This page is for sprites in general, as they apply to all Valve games.
<br>• Move Source engine-specific shader stuff to [[Sprite (shader)]] and [[$spriteorientation]]. See also [[Shaders in Sprites\]].
<br>• GoldSrc-specific engine stuff likely belongs in [[SPR]].}}

In {{gldsrc|2}} and {{source|2}}, a '''sprite''' is a rendered world object with some very special geometrickery. The sprite itself is a (static or animated) 2D image that looks 3D when viewed ''Normally'' (ie perpendicular to its surface). The trick is to make sure the player always views the sprite ''normally''; which usually means rotating the sprite about its origin so it is always facing the Player. Obviously in multiplayer this rotation in World would not work, so the sprite is rotated only in the [[Player View]].

Although their usefulness is severely limited, ''sprites'' are significantly [[cheap]]er to render than models or brushwork, and can also achieve convincing effects that would be impractical to model in 3D.
* '''Lighting:''' Sprites cannot cast or receive any kind of [[shadow]]s, nor reflect [[cubemap]]s.<!--compare [[viewmodel]]s-->
* '''Physics:''' Sprites cannot be [[Solid]] to anything {{note|In {{gldsrc|4}}, {{ent|cycler_sprite}} entities '''can''' have collision (simple bounding box), but this entity is buggy and not meant for final distributables. Use a {{mono|CLIP}} brush and/or an [[MDL (GoldSrc)|MDL]] instead.}}

{{bug|In {{src|4}}, reloading the game materials has no effect on sprite textures loaded in a game session. If a sprite material is changed after the game has already loaded the VMT on a sprite, the game must be restarted.}}

==Sprite entities==
{| <!-- class="wikitable" -->
|-
| {{gldsrc|4}}
| {{src|4}}
|-
| 
* {{ent|env_sprite|eng=goldsrc}}
* {{ent|env_glow|eng=goldsrc}}
* {{ent|env_laser|eng=goldsrc}}
* {{ent|env_beam|eng=goldsrc}}
* {{ent|env_shooter|eng=goldsrc}}
* {{ent|cycler_sprite|eng=goldsrc}}
* {{ent|env_spritetrain|eng=goldsrc}}{{only|{{hlop4}} and {{Sven}}}}
| 
* {{ent|env_sprite}}
* {{ent|env_sprite_clientside}}
* {{ent|env_sprite_oriented}}
* {{ent|prop_detail_sprite}}

|}

==Placement==
{{TODO|... general usage guidelines ... configuring sprite entities in Hammer.}}
* See [[Render Modes]].
* See [[Attachment]]s and [[Movement hierarchy]].
<!--
* see eg [[User Inputs and Outputs]]
-->

==Creation==
{{todo|guidelines/checklist for designing & implementing sprites.}}

* Design guidelines.
** the image inside the sprite already depicts a three dimensional object;
** the animation is constantly changing or depicts ''rotation'';
** the depicted object has a similar appearance from many common viewing angles (such as something spherical);
** the viewer accepts that the depicted object only has one perspective (such as small plants or leaves).
** the sprite exists only briefly, is NotSolid, ... player cannot inspect it too closely.
* [[SPR]] file format...
* If using a texture that is intended to be transparent, be sure to close Hammer and restart it before compiling.  Hammer likes to only half-load new sprite textures and won't display them as transparent.
* Sprite textures may also have any shade of gray (red, green, and blue values identical) interpreted as being transparent.  Have not extensively tested, but it has worked in at least two cases (light_glow01 and a custom one).
* VTF: [[Vtex compile parameters]] "clamps", "clampt". note: [[env_sprite_oriented]] #angles ...
* VMT: [[Shaders_in_Sprites\]]

==<tt>$spriteorientation</tt> Parameters for VMT==
The number next to these types MUST be used instead for <tt>$spriteorientation</tt> when used in any shader other than <tt>Sprite</tt>{{clarify}}.

''parallel_upright'' (0)
* Like parallel, but doesn't rotate around Z axis
! fire1, fire2, fire, fireburst, flame01, flame03, flame04, floorfire4_, floorflame2, parallel_upright, physbeam

''facing_upright'' (1)
* Like parallel upright, but rotated based on world origin, rather than camera.
! Unused (?)

''vp_parallel'' (2)
* Rotates to always face the camera.
! Most popular.

''oriented'' (3)
* Rotated in map editor to face a specific direction
! flatframe, lamphalo1, lamphalo

''vp_parallel_oriented'' (4)
* Combination of parallel and oriented.
! plasma, smoke, steam1

E.G. of Stock HL2 Sprite 
<syntaxhighlight>
"Sprite"
{
	"$spriteorientation" "vp_parallel"
	"$spriteorigin" "[ 0.50 0.50 ]"
	"$basetexture" "sprites/glow_test02"

	"Proxies"
	{
		"lampbeam"
		{
		}
	}
} 
</syntaxhighlight>

Reference: materials/sprites/glow_test02

E.G. of Custom Sprite

<syntaxhighlight>
"Sprite"
{
	"$basetexture" "sprites/turret_rebel"
	"$spriteorientation" "vp_parallel"
	"$spriteorigin" "[ 0.50 0.50 ]"
	"$translucent" "1"
	"$nocull" "1"
	"$vertexcolor" "1"
	"$vertexalpha" "1"
        "%keywords" "turret .spr"       
}
</syntaxhighlight>

Download Reference: http://forum.tsgk.com/viewtopic.php?t=4699 
*File Name Reference: gtamikes_custom_turrets_V3_Final.rar
** turret_rebel.vmt, turret_rebel.vtf
**turret_combine.vmt, turret_combine.vtf

[[File:Gtamikes_custom_sprite.jpg|thumb|left|Rebel and Combine Custom Sprite For HL2DM CTF Mode]]

[[Category:Glossary]]
[[Category:Level Design]]


{{stub}}