Env sun: Difference between revisions

From Valve Developer Community
Jump to navigation Jump to search
m (Technical limitations)
mNo edit summary
Line 3: Line 3:
==Entity Description==
==Entity Description==
The '''env_sun''' entity creates a sun effect in the sky.
The '''env_sun''' entity creates a sun effect in the sky.
* Effect's position relative to the player is determined by angle; it does not parallax
* 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 may appear somewhat green in-game; change the color to account for this


==Keyvalues==
==Keyvalues==
* [[Targetname]] - Excluded by default, but it can still be added in [[Hammer_Object_Properties_Dialog#SmartEdit|SmartEdit]] mode and used by the [[Entity_I/O_-_How_to_hook_up_entity_inputs_and_outputs.|I/O system]].


* '''Pitch Yaw Roll (Y Z X) (angles)'''
*[[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.


* '''Viewer entity (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.


* '''UseAngles (use_angles)'''
* '''use_angles'''
: <choices> 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)'''
* '''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.


* '''Sun Color (R G B) (rendercolor)
* '''rendercolor'''
: <color255> Color of the sun.
: <color255> Color of the sun.


* '''Size (size)'''
* '''size'''
: <integer> Size of the sun.
: <integer> Size of the sun.


* ''Name (targetname)''
==Inputs==
: <target_source> Name of the env_sun entity.  Not available by default, but it can still be added in [[Hammer_Object_Properties_Dialog#SmartEdit|SmartEdit]] mode and used by the [[Entity_I/O_-_How_to_hook_up_entity_inputs_and_outputs.|I/O system]].


==Flags==
* [[Targetname]] - Excluded by default
 
No Flags
 
==Inputs==


* '''TurnOn'''
* '''TurnOn'''
Line 43: Line 41:


==Outputs==
==Outputs==
* [[Targetname]] - Excluded by default


No outputs.
==Miscellaneous==
* Effect's position relative to the player is determined by angle; it does not parallax
* 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 may appear somewhat green in-game; change the color to account for this


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

Revision as of 20:02, 9 July 2005

Template:Wrongtitle

Entity Description

The env_sun entity creates a sun effect in the sky.

  • Effect's position relative to the player is determined by angle; it does not parallax
  • 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 may appear somewhat green in-game; change the color to account for this

Keyvalues

  • 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.
  • 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
<color255> Color of the sun.
  • size
<integer> Size of the sun.

Inputs

  • TurnOn
Enable sun rendering.
  • TurnOff
Disable sun rendering.
  • SetColor <color255>
Change the sun's color. Format: <Red 0-255> <Green 0-255> <Blue 0-255>

Outputs