env_sun

Example of env_sun working with sky_day01_04_hdr skybox. (LDR (left) HDR (right))

Class hierarchy
CSun ↳CBaseEntity
`sun.cpp`

env_sun is a point entity available in all Source games. It places a glowing sun effect in the skybox where it does not parallax, giving the impression that it is nearly infinitely far away. The entity does not contribute any actual lighting; it is merely a visual representation of the Sun. Use light_environment to provide actual sunlight for your map.

Important:This is a preserved entity in

.

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.

When the sun is looked at directly, it will transition to the properties of an "overlay".

Bug:Centering the player's view perfectly on the sun will render it invisible, even if there is no crosshair. This has been fixed since

.

Code Fix:A fix for this bug can be found here

(tested in:

)

Bug:The sprite doesn't displays if you are under water. (tested in:

)

Note:Deprecated and buggy in

Black Mesa; use env_lensflare with newLight_Dir instead.

Tip:As env_sun doesn't affect lighting, the map's light_environment should use the same angles as env_sun. If using multiple env_sun entities, use the average angles of all suns for the sunlight angle (unless light_directional is available).

Keyvalues

Name (targetname) <string>: 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

Pitch Yaw Roll (Y Z X) (angles) <angle>: 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.
UseAngles (use_angles) <boolean>: The old way to orient env_sun is to use the target KV. The new way is by the angles KV. If you want to use the new way, set this KV to 1 ("yes").
Viewer entity (target to point at) (target) <targetname>: Name of an entity (ex: info_target) used to determine where the sun is in the skybox. The resulting sun sprite will be positioned based on a line starting from the target towards the env_sun.; Note:Killing the viewer entity after the env_sun has already been spawned will have no adversarial effects.
Pitch (pitch) <float>: This value sets the pitch position of the sun. It overrides the Pitch in Pitch Yaw Roll, even if left at 0, so it needs to be specified. This Pitch is reverse of the normal, so 90 is straight up, while -90 is straight down.
Yaw (angle) <float> !FGD: Override for Yaw in Pitch Yaw Roll, similar to Pitch.
Bug:Crashes the game if set. Observed with a value of 330 in Team Fortress 2.
Sun Color (R G B) (rendercolor) <color255>: Color of the sun. The effect is additive with the sky: a pure yellow sun with a bright blue sky will appear white in-game; change the color to account for this.
Overlay Color (R G B) (overlaycolor) <color255>: Color of the sun overlay.
Size (size) <integer>: Size of the sun.
Overlay Size (overlaysize) <integer>: A value of -1 means the overlay will act the old way^[Clarify].
Material Name (material) <sprite>: Material of the inner glow.
Overlay Material Name (overlaymaterial) <sprite>: Material of the overlay glow.
HDR color scale (HDRColorScale) <float>: Color multiplier when in HDR mode.
Glow Distance Scale (glowDistanceScale) <float> (in all games since ): Scales the distance used to test for sun glow occlusion. If the player can see any part of the skybox within this range, the overlay will render.

Inputs

TurnOn: Enable sun rendering.

TurnOff: Disable sun rendering.

SetColor <color255>: Sets Sun Color.

env_sun

Keyvalues

Inputs

See also

Navigation menu

Search