Libraries.Game.Graphics.DirectionalLight Documentation

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

Actions Documentation

Compare(Libraries.Language.Object object)

This action compares two object hash codes and returns an integer. The result is larger if this hash code is larger than the object passed as a parameter, smaller, or equal. In this case, -1 means smaller, 0 means equal, and 1 means larger. This action was changed in Quorum 7 to return an integer, instead of a CompareResult object, because the previous implementation was causing efficiency issues.

Parameters

Return

integer: The Compare result, Smaller, Equal, or Larger.

Example

Object o
Object t
integer result = o:Compare(t) //1 (larger), 0 (equal), or -1 (smaller)

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.

Parameters

Return

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

Example

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

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:

GetEnvironment()

This action will return the current color of this light.

Return

Libraries.Game.Graphics.Environment:

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetIntensity()

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

Return

number:

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

  • number red
  • number green
  • number blue
  • number alpha

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

  • number directionX
  • number directionY
  • number directionZ

SetEnvironment(Libraries.Game.Graphics.Environment environment)

This action sets the environment this light is a part of. This is called automatically when a light is added to an environment, so users should never need to use this action directly.

Parameters

SetIntensity(number intensity)

This action will return the current direction of this DirectionalLight.

Parameters

  • number intensity

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

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

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