Env sun: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (minoro)
Line 1: Line 1:
{{wrongtitle|title=env_sun}}
{{wrongtitle|title=env_sun}}


==Entity Description==
== Entity description ==
Places a sun effect in the sky. Does not contribute any actual lighting - this entity is best used in conjunction with a [[light_environment]].
Places a sun effect in the sky. Does not contribute any actual lighting - this entity is best used in conjunction with a [[light_environment]].


Line 8: Line 8:
* 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.
* 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.


==Keyvalues==
== Keyvalues ==
* {{not in fgd}} {{kv targetname}}
* {{not in fgd}} {{kv targetname}}
*{{kv angles}}
*{{kv angles}}
* '''target'''
* '''target'''
: <target_destination> Name of an entity used to determine where the sun is in the skybox. The sun should be lined up on a line from this entity to the env_sun entity.
: <target_destination> Name of an entity used to determine where the sun is in the skybox. The sun should be lined up on a line from this entity to the env_sun entity.
*{{kv hdrcolorscale}}
*{{kv hdrcolorscale}}
* '''use_angles'''
* '''use_angles'''
: {{boolean}} The old way to orient env_sun is to point it at a target. The new way is to specify the angles. If you use the new way, set this property to YES, otherwise, set this property to NO.
: {{boolean}} The old way to orient env_sun is to point it at a target. The new way is to specify the angles. If you use the new way, set this property to YES, otherwise, set this property to NO.
* '''pitch'''
* '''pitch'''
: <integer> The pitch of this entity. 90 is straight up, -90 is straight down.
: <integer> The pitch of this entity. 90 is straight up, -90 is straight down.
* '''rendercolor'''
* '''rendercolor'''
: {{color}} Color of the sun.
: {{color}} Color of the sun.
* '''size'''
* '''size'''
: <integer> Size of the sun.
: <integer> Size of the sun.
* '''{{ep1 add|overlaycolor}}
* '''{{ep1 add|overlaycolor}}
: {{color}} Overlay Color (R G B)
: {{color}} Overlay Color (R G B)
Line 43: Line 35:
: Material of the overlay glow. (sprites/light_glow02_add_noz)
: Material of the overlay glow. (sprites/light_glow02_add_noz)


==Inputs==
== Inputs ==
 
* {{not in fgd}}:
* {{not in fgd}}:
:{|
:{|
Line 50: Line 41:
* {{i targetname}}
* {{i targetname}}
|}
|}
* '''TurnOn'''
* '''TurnOn'''
: Enable sun rendering.
: Enable sun rendering.
* '''TurnOff'''
* '''TurnOff'''
: Disable sun rendering.
: Disable sun rendering.
* '''SetColor {{color}}'''
* '''SetColor {{color}}'''
: Set the rendercolor.
: Set the rendercolor.


==Outputs==
== Outputs ==
* {{not in fgd}} {{o targetname}}
* {{not in fgd}} {{o targetname}}


[[Category:Entities]]
[[Category:Entities]]

Revision as of 04:27, 1 February 2008

Template:Wrongtitle

Entity description

Places a sun effect in the sky. Does not contribute any actual lighting - this entity is best used in conjunction with a light_environment.

  • The effect's position relative to the player is determined by angle; it does not parallax, so gives the effect of the sun being infinitely far away.
  • You can also send inputs to the env_sun entity by directing them to "env_sun" instead of using a target name.
  • 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.

Keyvalues

<target_destination> Name of an entity used to determine where the sun is in the skybox. The sun should be lined up on a line from this entity to the env_sun entity.
<boolean> The old way to orient env_sun is to point it at a target. The new way is to specify the angles. If you use the new way, set this property to YES, otherwise, set this property to NO.
  • pitch
<integer> The pitch of this entity. 90 is straight up, -90 is straight down.
  • rendercolor
#000000 Color of the sun.
  • size
<integer> Size of the sun.
#000000 Overlay Color (R G B)
A value of 0 0 0 will act the old way.
<integer> Overlay Size
A value of -1 means the overlay will act the old way.
<material> Material Name
Material of the inner glow. (sprites/light_glow02_add_noz)
<material> Overlay Material Name
Material of the overlay glow. (sprites/light_glow02_add_noz)

Inputs

  • TurnOn
Enable sun rendering.
  • TurnOff
Disable sun rendering.
  • SetColor #000000
Set the rendercolor.

Outputs