Libraries.Interface.Controls.TextStyles.TextHighlight 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.
GetDrawable(number width, number height)This action returns a Drawable representing the visual content of a text highlight of a given width and height.
GetHashCode()This action gets the hash code for an object.
IsLineHighlight()This action returns whether or not this highlight is applied to an entire line of text.
IsVisibleWhileSelected()This action returns whether or not this highlight will be visible on selected text.
SetLineHighlight(boolean isLineHighlight)This action sets whether or not this highlight should be applied to an entire line of text.
SetVisibleWhileSelected(boolean visible)This action sets whether or not this highlight will be rendered on top of the selection highlight for selected text.

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.

GetDrawable(number width, number height)

This action returns a Drawable representing the visual content of a text highlight of a given width and height.

Parameters

Return

Libraries.Game.Graphics.Drawable:

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.

IsLineHighlight()

This action returns whether or not this highlight is applied to an entire line of text.

Return

boolean:

IsVisibleWhileSelected()

This action returns whether or not this highlight will be visible on selected text. If this value is false and text is selected, the selection highlight will be rendered on top of this highlight. Note that if the selection highlight uses transparency, this highlight will be partially visible underneath the selection highlight.

Return

boolean:

SetLineHighlight(boolean isLineHighlight)

This action sets whether or not this highlight should be applied to an entire line of text. The highlight will be applied to whatever line contains the start index of the TextStyle that is using this highlight.

Parameters

SetVisibleWhileSelected(boolean visible)

This action sets whether or not this highlight will be rendered on top of the selection highlight for selected text. If the provided value is false, then the highlight will appear normally on unselected text, but will be hidden on selected text. If the text's selection color uses transparency, this highlight will be partially visible underneath the selection highlight.

Parameters