Env sun: Difference between revisions
Jump to navigation
Jump to search
Warning:light_environment, env_sun and shadow_control should be used together. Each entity represents only a one aspect of a naturally unified phenomenon; Sunlight. light_environment defines the direct sunlight settings and creates (buggy, unconfigurable) dynamic shadows which can only be overridden/controlled by shadow_control. env_sun places a glow sprite in the skybox where the sunlight comes from. To make sense of it all, just make sure that the <angles> (Pitch/Yaw/Roll) are set the same for all three entities. Unfortunately shadow_control does not have the Pitch override parameter, so its Pitch will be determined by the first of its <angles>. Even more unfortunately, the Pitch override rotation cannot be switched off and is measured counter-clockwise from the horizontal (so straight down is -90 degrees) whereas the <angles> Pitch is rotation is clockwise (so straight down is +90 degrees).
mNo edit summary |
(→Entity description: added workaround warning) |
||
Line 3: | Line 3: | ||
== Entity description == | == Entity description == | ||
Places a sun effect in the | Places a sun effect (glow sprite) in the skybox representing the Sun or Moon. It 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. | * 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. | * 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. | * 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. | ||
{{Warning|[[light_environment]], [[env_sun]] and [[shadow_control]] should be used together. Each entity represents only a one aspect of a naturally unified phenomenon; Sunlight. [[light_environment]] defines the direct sunlight settings and creates (buggy, unconfigurable) dynamic shadows which can only be overridden/controlled by [[shadow_control]]. [[env_sun]] places a glow sprite in the skybox where the sunlight comes from. To make sense of it all, just make sure that the <angles> (Pitch/Yaw/Roll) are set the same for all three entities. Unfortunately [[shadow_control]] does not have the Pitch override parameter, so its Pitch will be determined by the first of its <angles>. Even more unfortunately, the Pitch override rotation cannot be switched off and is measured counter-clockwise from the horizontal (so straight down is -90 degrees) whereas the <angles> Pitch is rotation is clockwise (so straight down is +90 degrees).}} | |||
== Keyvalues == | == Keyvalues == |
Revision as of 17:04, 14 April 2008
Template:Wrongtitle Template:Base point
Entity description
Places a sun effect (glow sprite) in the skybox representing the Sun or Moon. It 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.
- Template:Kv hdrcolorscale
- 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.
- pitch
- <integer> The pitch of this entity. 90 is straight up, -90 is straight down.
- rendercolor
- ⇆#000000rgb(0,0,0)⇆ Color of the sun.
- size
- <integer> Size of the sun.
- ⇆#000000rgb(0,0,0)⇆ 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 ⇆#000000rgb(0,0,0)⇆
- Set the rendercolor.