Libraries.Game.NumberUtilities Documentation

The NumberUtilities class contains some actions used by the game engine to manipulate the bits of a number for graphical purposes. Most users will never need to interface with this class directl

Inherits from: Libraries.Language.Object

Summary

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
EncodeColorIntegerAsNumber(integer target)Creates a number with the same bits as the integer parameter, ensuring that the returned number is a valid color cod
EncodeIntegerAsNumber(integer target)Creates a number with the same bits as the integer paramete
EncodeNumberAsInteger(number target)Creates an integer with the same bits as the number paramete
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetHashCode()This action gets the hash code for an 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.

Example Code

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

Parameters

Return

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

EncodeColorIntegerAsNumber(integer target)

Creates a number with the same bits as the integer parameter, ensuring that the returned number is a valid color cod

Parameters

Return

number:

EncodeIntegerAsNumber(integer target)

Creates a number with the same bits as the integer paramete

Parameters

Return

number:

EncodeNumberAsInteger(number target)

Creates an integer with the same bits as the number paramete

Parameters

Return

integer:

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(

Parameters

Return

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

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.