Cycler sprite (GoldSrc)

Class hierarchy
CCyclerSprite ↳CBaseEntity
h_cycler.cpp

cycler_sprite is a model entity available in all GoldSrc games. A simple model entity that is intended for previewing sprites. As env_sprite works better for placing sprites in a map (not being removed when loading a saved game), this entity frequently gets relegated to being used to display MDLs instead in multiplayer games such as Counter-Strike.

Confirm:Not in all GoldSrc games? Not found in source code in SDK.

Workaround:Use env_sprite instead. Like this entity, it supports MDLs as well.

Key Values

Name (targetname) <string>

The targetname that other entities refer to this entity by, usually via the target, killtarget, and TriggerTarget KVs.

Pitch Yaw Roll (Y Z X) (angles) <QAngle>

This entity's orientation in the world. Pitch is rotation around the Y axis, yaw is the rotation around the Z axis, roll is the rotation around the X axis.

Model (model) <model path>

Model to display (MDL, BSP, or SPR). Relative to mod folder.

Colormap (colormap) <integer>

Works like the deathmatch recolor system, wherein this KV equals (bottomcolor * 256) + topcolor. This value can be calculated using .

Tip:In Sven Co-op, the topcolor and bottomcolor KVs are available to be used instead, for clarity.

Framerate (framerate) <float>

Rate at which the sprite or model should animate, if at all. For SPR, this is an absolute framerate (max 10), whereas for MDL, this is a scalar.

Render Mode (rendermode) <choices>

Render Mode to use.

Render modes

Normal Color Texture Glow Solid Additive

Render Amount (0-255) (renderamt) <integer>

Controls transparency when using another render mode then normal. 0 is completely invisible, and 255 is opaque. If render mode is solid, then all values except 0 are opaque.

Render Color (R G B) (rendercolor) <color255>

Color to use by the specified render mode.
Also used on brush entities to control the speed of scrolling textures; see func_conveyor for more information.

Render FX (renderfx) <choices>

Render FX mode to use, for special effects.

Render effects

Normal Slow Pulse Fast Pulse Slow Wide Pulse Fast Wide Pulse Slow Fade Away Fast Fade Away Slow Become Solid Fast Become Solid Slow Strobe Fast Strobe Faster Strobe Slow Flicker Fast Flicker Constant Glow Distort Hologram (Distort + fade)

Master (master) <targetname>

Name of a master entity. If the master hasn't been activated, this entity will not activate.

ZHLT:

Copy lighting from (VHLT+) (zhlt_copylight) <targetname>

Copies the lighting from the named entity to the nearest lightmap luxel below this entity's origin.

Tip:To avoid having the copied lighting visibly affecting the brush lighting, put a 16x16x1 func_detail with zhlt_noclip enabled directly below this model's origin. Texture the top face with black_HIDDEN, and the rest of the faces with SKIP. If the player or any other MDL entity can go above this model, place another identical func_detail above this model's origin to reduce the chance of extraneous models being lit weirdly.

Note:Not compatible with entities using the effect flag EF_INVLIGHT.

Model shadows (UMHLT, SDHLT) (zhlt_studioshadow) <boolean>

Enable to cast shadows from MDLs found in the model KV.

Model shadow mode (SDHLT) (zhlt_shadowmode) <choices>

0 - Use Bounding Box

1 - Use triangles (default)

2 - Use Bounding boxes of triangles

See also

• cycler
• cycler_wreckage
• cycler_weapon