env_sprite Last edited 4 years ago2019-05-13 07:35:49 UTC

env_sprite - Point Entity

Attributes

• Render FX (renderfx) - Gives the sprite certain visual effects depending on Render Mode.
  • Normal (0) - No visual effects.
  • Slow Pulse (1) - Sprite slowly pulses with transparency. Faint.
  • Fast Pulse (2) - Sprite quickly pulses with transparency. Faint.
  • Slow Wide Pulse (3) - Sprite slowly pulses with transparency. Strong.
  • Fast Wide Pulse (4) - Sprite quickly pulses with transparency. Strong.
  • Slow Fade Away (5) - Seemingly unused.
  • Fast Fade Away (6) - Seemingly unused.
  • Slow Become Solid (7) - Seemingly unused.
  • Fast Become Solid (8) - Seemingly unused.
  • Slow Strobe (9) - A very slow strobe effect between visible and invisible.
  • Fast Strobe (10) - A medium strobe effect between visible and invisible.
  • Faster Strobe (11) - A very fast strobe effect between visible and invisible.
  • Slow Flicker (13) - Sprite flickers in and out of visibility.
  • Fast Flicker (13) - Sprite quickly flickers in and out of visibility.
  • Constant Glow (14) - Seemingly unused.
  • Distort (15) - Sprite has a slight fast pulsing of transparency.
  • Hologram (Distort + fade) (16) - Sprite has a slight fast pulsing of transparency. Fades out with distance.
• Render Mode (rendermode) - Allows special rendering modes to be applied to the given entity.
  • Normal (0) - Standard rendering. Render FX and FX Amount will generally have no effect.
  • Color (1) - Allows sprite to become transparent. (Counter-intuitively, is the only Render Mode that is not affected by FX Color.)
  • Texture (2) - Allows sprite to become transparent.
  • Glow (3) - Removes background of sprite. Sprite will appear larger and become more faint with distance. Allows sprite to become transparent.
  • Solid (4) - Allows sprite to become transparent.
  • Additive (5) - Removes background of sprite. Allows sprite to become transparent.
• FX Amount (1 - 255) (renderamt) - In all but "Normal" Render Mode, alters how transparent the sprite is. Scales from 0 (invisible) to 255 (solid, normal).
• FX Color (R G B) (rendercolour) - Alters the colour of the sprite. Will have no effect if R, G and B are all equal.
• Name (targetname) - Name is a general attribute used to identify entities.
• Pitch Yaw Roll (Y Z X) (angles) - Sets the visual rotation of the sprite. Yaw will set the degrees in rotation of the sprite, with 0 being the default. Roll can do the same, and will override Yaw if set to anything other than 0. Pitch is unused.
• Framerate (framerate) - Sets how many frames per second the sprite will animate at.
• Sprite Name (model) - This defines which sprite file will be displayed by the entity. This accepts an input of the form "path/filename.spr" (starting from the root folder). (Example: "sprites/tele1.spr").
• Scale (scale) - Sets the scale of the sprite, in the form of a size multiplier.

Flags

• Start on (1) - If enabled, the sprite will be turned on at the start of the map.
• Play Once (2) - If not enabled, the sprite will be treated as toggled, and triggering the env_sprite will toggle the sprite between visible and invisible. The sprite will repeat its animation indefinitely. If enabled, the sprite will play through its animation once when triggered and then stay invisible until it is triggered again. (If the env_sprite is triggered while this single animation is playing, it will become invisible immediately.)

Notes

• If a sprite with only one frame is used with the Play Once flag enabled, it will operate as normal; the sprite will only appear for as long as one frame takes as defined by Framerate.