Libraries.Game.Graphics.DirectionalLight Documentation

Inherits from: Libraries.Game.Graphics.Light, Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
Libraries.Compute.Vector3 direction

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns a CompareResult.
Copy()This action will create a copy of this DirectionalLight with the same color and direction as this light.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetColor()This action will return the current color of this light.
GetDirection()This action will return the current direction of this DirectionalLight.
GetHashCode()This action gets the hash code for an object.
SetColor(Libraries.Game.Graphics.Color newColor)This action will set the color of the light to match the given color.
SetColor(number red, number green, number blue, number alpha)This action will set the color of the light using number values for the red, green, blue, and alpha components of a color, respectively.
SetDirection(Libraries.Compute.Vector3 newDirection)This action will set the direction the light points in.
SetDirection(number directionX, number directionY, number directionZ)This action will set the direction the light points in.
SetLight(Libraries.Game.Graphics.Color newColor, Libraries.Compute.Vector3 newDirection)This action will set both the color and direction of this light using the given values.

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns a CompareResult. The compare result is either larger if this hash code is larger than the object passed as a parameter, smaller, or equal.

Example Code

use Libraries.Language.Support.CompareResult
        Object o
        Object t
        CompareResult result = o:Compare(t)

Parameters

Return

Libraries.Language.Support.CompareResult: The Compare result, Smaller, Equal, or Larger.

Copy()

This action will create a copy of this DirectionalLight with the same color and direction as this light.

Return

Libraries.Game.Graphics.DirectionalLight:

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Example Code

use Libraries.Language.Object
        use Libraries.Language.Types.Text
        Object o
        Text t
        boolean result = o:Equals(t)

Parameters

Return

boolean: True if the hash codes are equal and false if they are not equal.

GetColor()

This action will return the current color of this light.

Return

Libraries.Game.Graphics.Color:

GetDirection()

This action will return the current direction of this DirectionalLight.

Return

Libraries.Compute.Vector3:

GetHashCode()

This action gets the hash code for an object.

Example Code

Object o
        integer hash = o:GetHashCode()

Return

integer: The integer hash code of the object.

SetColor(Libraries.Game.Graphics.Color newColor)

This action will set the color of the light to match the given color.

Parameters

SetColor(number red, number green, number blue, number alpha)

This action will set the color of the light using number values for the red, green, blue, and alpha components of a color, respectively. Each number should be between 0 and 1, where 0 represents the total lack of a color component, and 1 represents the full presence of a color component.

Parameters

SetDirection(Libraries.Compute.Vector3 newDirection)

This action will set the direction the light points in. The light will point in the same direction as the supplied Vector3 object.

Parameters

SetDirection(number directionX, number directionY, number directionZ)

This action will set the direction the light points in. It takes three number values, which represent the three values of a 3-dimensional vector.

Parameters

SetLight(Libraries.Game.Graphics.Color newColor, Libraries.Compute.Vector3 newDirection)

This action will set both the color and direction of this light using the given values.

Parameters