This article's documentation is for anything that uses the Source engine. Click here for more information.

Env sprite: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
No edit summary
mNo edit summary
Line 1: Line 1:
{{lang|Env sprite}}
{{lang|Env sprite}}
{{CD|CSprite|file1=Sprite.cpp}}
{{CD|CSprite|file1=Sprite.cpp}}
{{entity|type=e0|env_sprite}} It creates a [[sprite]] in the world. Sprites always face the player.
{{this is a|e0|name=env_sprite}} It creates a [[sprite]] in the world. Sprites always face the player.


{{note|This entity may also use <code>env_glow</code> for the classname.}}
{{note|This entity may also use <code>env_glow</code> for the classname.}}
Line 9: Line 9:
{{note|The only [[render modes]] that render sprite transparency are ''Glow'', ''Additive'', ''Additive Fractional Frame'', ''World Space Glow'' and ''Alpha Add'' {{not in FGD}}.}}
{{note|The only [[render modes]] that render sprite transparency are ''Glow'', ''Additive'', ''Additive Fractional Frame'', ''World Space Glow'' and ''Alpha Add'' {{not in 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 {{game name|src09|name=Source 2009}}, 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, so it must be adjusted by hand.}}
{{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 {{src09|4}}, 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, so it must be adjusted by hand.}}




Revision as of 09:16, 3 October 2023

English (en)Русский (ru)Translate (Translate)
C++ Class hierarchy
CSprite
↳CBaseEntity
C++ Sprite.cpp

env_sprite is an e0 available in all Source Source games. It creates a sprite in the world. Sprites always face the player.

Note.pngNote:This entity may also use env_glow for the classname.
Icon-Important.pngImportant:This is a preserved entity in Day of Defeat: SourceTeam Fortress 2.
If the game has round restart mechanics this entity may not behave as expected:
More info
  • On a new round entities with this classname 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.pngNote:The only render modes that render sprite transparency are Glow, Additive, Additive Fractional Frame, World Space Glow and Alpha Add !FGD.
Icon-Bug.pngBug: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 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.  [todo tested in ?]


Flags

Note.pngNote:Archived page history
Icon-Important.pngImportant:These pages are linked often from page history logs so Special:WhatLinksHere will not show anything.

Keyvalues

Name (targetname) <string>[ Edit ]
The name that other entities refer to this entity by, via Inputs/Outputs or other keyvalues (e.g. parentname or target).
Also displayed in Hammer's 2D views and Entity Report.
See also:  Generic Keyvalues, Inputs and Outputs available to all entities

Note.pngNote:Archived page history
Icon-Important.pngImportant:These pages are linked often from page history logs so Special:WhatLinksHere will not show anything.

RenderFields:


Render Mode (rendermode) <byte choices>
Set a non-standard rendering mode on this entity.
Render Modes
  • 0: Normal
  • 1: Color
  • 2: Texture
  • 3: Glow
  • 4: Solid/Alphatest Obsolete
  • 5: Additive
  • 6: Removed, does nothing Obsolete
  • 7: Additive Fractional Frame
  • 8: Alpha Add
  • 9: World Space Glow
  • 10: Don't Render
Render FX (renderfx) <byte choices>
Various somewhat legacy alpha effects. See render effects.
Render Amount / Transparency (renderamt) <byte>
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.

Inputs

Note.pngNote:Archived page history. Content moved to env_sprite
Icon-Important.pngImportant:These pages are linked often from page history logs so Special:WhatLinksHere will not show anything.

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 than 0.
Color <color255RedirectInput/color32>
Sets an RGB color for the entity.

See Also

Retrieved from "https://developer.valvesoftware.com/w/index.php?title=Env_sprite&oldid=350100"