Libraries.Game.Graphics.Gradient Documentation

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

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetBottomLeft()
GetBottomRight()
GetHashCode()This action gets the hash code for an object.
GetTopLeft()
GetTopRight()
Set(Libraries.Game.Graphics.Color bottomLeft, Libraries.Game.Graphics.Color bottomRight, Libraries.Game.Graphics.Color topLeft, Libraries.Game.Graphics.Color topRight)
SetBottomLeft(Libraries.Game.Graphics.Color color)
SetBottomRight(Libraries.Game.Graphics.Color color)
SetTopLeft(Libraries.Game.Graphics.Color color)
SetTopRight(Libraries.Game.Graphics.Color color)

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.

Example Code

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

Parameters

Return

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

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.

GetBottomLeft()

Return

Libraries.Game.Graphics.Color

GetBottomRight()

Return

Libraries.Game.Graphics.Color

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.

GetTopLeft()

Return

Libraries.Game.Graphics.Color

GetTopRight()

Return

Libraries.Game.Graphics.Color

Set(Libraries.Game.Graphics.Color bottomLeft, Libraries.Game.Graphics.Color bottomRight, Libraries.Game.Graphics.Color topLeft, Libraries.Game.Graphics.Color topRight)

Parameters

SetBottomLeft(Libraries.Game.Graphics.Color color)

Parameters

SetBottomRight(Libraries.Game.Graphics.Color color)

Parameters

SetTopLeft(Libraries.Game.Graphics.Color color)

Parameters

SetTopRight(Libraries.Game.Graphics.Color color)

Parameters