Skip to main content

env_sun

Point Entity

An entity to control & draw a sun effect in the sky.

Keyvalues

  • Entity Scripts (vscripts) <ScriptList>
    Name(s) of script files that are executed after all entities have spawned.

  • Name (targetname) <TargetSource>
    The name that other entities refer to this entity by.

  • Viewer entity (target) <TargetDestination>
    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) <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.

  • Sun Color (R G B) (rendercolor) <Color255>

  • Overlay Color (R G B) (overlaycolor) <Color255>
    A value of 0 0 0 will act the old way.

  • Size (size) <Integer>

  • Overlay Size (overlaysize) <Integer>
    A value of -1 means the overlay will act the old way.

  • Material Name (material) <Sprite>
    Material of the inner glow.

  • Overlay Material Name (overlaymaterial) <Sprite>
    Material of the overlay glow.

  • HDR color scale. (HDRColorScale) <Float>
    float value to multiply sprite color by when running in HDR mode.

Inputs

  • RunScriptFile <String>
    Load and execute a script file

  • RunScriptCode <String>
    Execute a fragment of script code

  • CallScriptFunction <String>
    Call a script function

  • CallPrivateScriptFunction <String>
    Calls a script function from this entity's private script scope.

  • CallGlobalScriptFunction <String>
    Calls a script function in the global script scope.

  • Kill <Void>
    Removes this entity from the world.

  • KillHierarchy <Void>
    Removes this entity and all its children from the world.

  • AddOutput <String>
    Adds an entity I/O connection to this entity. Parameter format: outputname>targetname>inputname>parameter>delay>max times to fire (-1 == infinite). Very dangerous, use with care.

  • FireUser1 <Void>
    Causes this entity's OnUser1 output to be fired.

  • FireUser2 <Void>
    Causes this entity's OnUser2 output to be fired.

  • FireUser3 <Void>
    Causes this entity's OnUser3 output to be fired.

  • FireUser4 <Void>
    Causes this entity's OnUser4 output to be fired.

  • TurnOn <Void>
    Enable sun rendering.

  • TurnOff <Void>
    Disable sun rendering.

  • SetColor <Color255>
    Change the sun's color. Format: <Red 0-255> <Green 0-255> <Blue 0-255>

Outputs

  • OnUser1 <Void>
    Fired in response to FireUser1 input.

  • OnUser2 <Void>
    Fired in response to FireUser2 input.

  • OnUser3 <Void>
    Fired in response to FireUser3 input.

  • OnUser4 <Void>
    Fired in response to FireUser4 input.

  • OnKilled <Void>
    Fired when the entity is killed and removed from the game.