Libraries.Game.DialogLayerPool Documentation

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.
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetDialogLayer()This action returns a DialogLayer that is ready for use.
GetHashCode()This action gets the hash code for an object.
Recycle(Libraries.Game.DialogLayer layer)This action informs the pool that a DialogLayer can be reused later.

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.

GetDialogLayer()

This action returns a DialogLayer that is ready for use. It will return an old DialogLayer that has been recycled if possible, or a new one if no old layer is available.

Return

Libraries.Game.DialogLayer:

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.

Recycle(Libraries.Game.DialogLayer layer)

This action informs the pool that a DialogLayer can be reused later. This should only be called on DialogLayers that are not in use anymore, and this will reset the DialogLayer. This is called automatically on a DialogLayer when the corresponding Dialog is hidden.

Parameters