View source for Env sun

{{lang|title=env_sun}}

[[File:Sun_ldrhdr.jpg|thumbnail|Example of env_sun working with sky_day01_04_hdr skybox. (LDR (left) HDR (right))]]
[[File:Env_sun(gmod).png|left]]
{{CD|CSun|file1=sun.cpp}}
{{entity|env_sun|type=e0}} It places a glowing sun effect [[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 {{ent|light_environment}} to provide actual sunlight for your map.

{{PreservedEnt}}

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 {{l4d}}.}}
: {{fix|A fix for this bug can be found here: [[General_SDK_Snippets_%26_Fixes#Fix_env_sun_sprite_disappearing_in_sky_when_you_look_at_it]]}}

==Keyvalues==
{{KV Targetname}}
{{KV|UseAngles|intn=use_angles|boolean|The old way to orient <code>env_sun</code> is to use ''Viewer entity''. The new way is by '''Pitch Yaw Roll'''. If you want to use the new way, set this property to YES.}}
{{KV|Viewer entity|intn=target|target_destination|Name of an entity (probably {{ent|sky_camera}}) used to determine where the sun is in the skybox. The resulting sun sprite will be positioned based on a line starting from the '''Viewer entity''' towards the <code>env_sun</code>.}}
{{KV|Pitch|intn=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.}}
{{KV|Yaw|intn=angle|nofgd=1|float|Override for '''Yaw''' in '''Pitch Yaw Roll''', similar to '''Pitch'''.}}
{{KV|Sun Color (R G B)|intn=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.}}
{{KV|Overlay Color (R G B)|intn=overlaycolor|color255|Color of the sun overlay.}}
{{KV|Size|intn=size|integer|Size of the sun.}}
{{KV|Overlay Size|intn=overlaysize|integer|A value of -1 means the overlay will act the old way{{clarify}}.}}
{{KV|Material Name|intn=material|sprite|Material of the inner glow.}}
{{KV|Overlay Material Name|intn=overlaymaterial|sprite|Material of the overlay glow.}}
{{KV|HDR color scale|intn=HDRColorScale|float|Color multiplier when in [[HDR]] mode.}}
{{KV|Glow Distance Scale|intn=glowDistanceScale|since=CSGO|float|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==
{{IO|TurnOn|Enable sun rendering.}}
{{IO|TurnOff|Disable sun rendering.}}
{{IO|SetColor|param=color255|Sets '''Sun Color'''.}}