Libraries.Interface.Behaviors.Controls.TextFieldCaretMoveBehavior Documentation

Inherits from: Libraries.Language.Object, Libraries.Interface.Behaviors.TimedBehavior, Libraries.Interface.Behaviors.Behavior

Summary

Variable Summary Table

VariablesDescription
integer LEFT
integer RIGHT

Actions Summary Table

ActionsDescription
Compare(Libraries.Language.Object object)This action compares two object hash codes and returns an integer.
Dispose()
Equals(Libraries.Language.Object object)This action determines if two objects are equal based on their hash code values.
GetDirection()
GetHashCode()This action gets the hash code for an object.
GetSelecting()
GetTimer()
HasBeenRun()This action returns true if the Behavior has been run by a current item that it has been added to.
IsFinished()
IsPaused()
IsRunningOnUpdate()The IsRunningOnUpdate action returns true if this Behavior calls its Run action during the Game's update loop, and returns false if the Behavior calls its Run action immediately upon being added to an Item.
PauseTimer()
ResumeTimer()
Run(Libraries.Interface.Events.BehaviorEvent event)
SetDirection(integer direction)
SetHasRunFlag(boolean hasRun)This action sets a flag indicating if the Behavior has been run by the current Item this Behavior has been added to.
SetRunOnUpdate(boolean run)The SetRunOnUpdate action determines when a behavior should be first run when the behavior is added to an Item.
SetSelecting(boolean select)
SetTimer(number seconds)
Update(number seconds)

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.

Dispose()

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.

GetDirection()

Return

integer

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.

GetSelecting()

Return

boolean

GetTimer()

Return

number

HasBeenRun()

This action returns true if the Behavior has been run by a current item that it has been added to. This is an internal flag used by the engine, and most users will never need this functionalit

Return

boolean:

IsFinished()

Return

boolean

IsPaused()

Return

boolean

IsRunningOnUpdate()

The IsRunningOnUpdate action returns true if this Behavior calls its Run action during the Game's update loop, and returns false if the Behavior calls its Run action immediately upon being added to an Item. The default value is fals

Return

boolean:

PauseTimer()

ResumeTimer()

Run(Libraries.Interface.Events.BehaviorEvent event)

Parameters

SetDirection(integer direction)

Parameters

SetHasRunFlag(boolean hasRun)

This action sets a flag indicating if the Behavior has been run by the current Item this Behavior has been added to. This is used internally by the engine, and most users should never need this functionalit

Parameters

SetRunOnUpdate(boolean run)

The SetRunOnUpdate action determines when a behavior should be first run when the behavior is added to an Item. If the value is false, then the Behavior's Run action will be called immediately when it is added to an Item. If it is true, it will be called during the next update loo

Parameters

SetSelecting(boolean select)

Parameters

SetTimer(number seconds)

Parameters

Update(number seconds)

Parameters