Libraries.Interface.Controls.Scenes.SceneEditorInputTable Documentation

The SceneEditorInputTable class inherits from InputTable in order to add more functionality to the regular InputTable. The SceneEditor class uses this so that it can use one table to group two tables together to switch between based on if the editor is currently editing a 2D or 3D scene. At its core it is still an InputTable which matches InputSets to a behavior but behaviors and swaps between them based on the state of the SceneEditor.

Inherits from: Libraries.Language.Object, Libraries.Game.InputTable

Actions Documentation

Add(Libraries.Game.InputSet set, Libraries.Interface.Behaviors.Behavior behavior)

Parameters

Add2D(Libraries.Game.InputSet set, Libraries.Interface.Behaviors.Behavior behavior)

Add2D maps an InputSet to a Behavior specifically for the SceneEditor that is on a 2D scene or interacting with an Item2D.

Parameters

Add3D(Libraries.Game.InputSet set, Libraries.Interface.Behaviors.Behavior behavior)

Add3D maps an InputSet to a Behavior specifically for the SceneEditor that is on a 3D scene or interacting with an Item3D.

Parameters

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.

Parameters

Return

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

Example

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

Copy()

Return

Libraries.Game.InputTable

Empty()

Equals(Libraries.Language.Object object)

This action determines if two objects are equal based on their hash code values.

Parameters

Return

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

Example

use Libraries.Language.Object
use Libraries.Language.Types.Text
Object o
Text t
boolean result = o:Equals(t)

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetIdentifier()

Return

text

GetInputSets()

Return

Libraries.Containers.Iterator

GetSize()

Return

integer

GetValue(Libraries.Game.InputSet set)

Parameters

Return

Libraries.Interface.Behaviors.Behavior

HasKey(Libraries.Game.InputSet set)

HasKey takes an InputSet and returns true if the InputSet is mapped to any behavior in this InputTable in either 2D mode or 3D mode.

Parameters

Return

boolean:

ProcessInput(Libraries.Game.InputSet set, Libraries.Interface.Events.BehaviorEvent event)

ProcessInput is an overridden action from InputTable. In an InputTable this action would grab the mapping for the passed InputSet and pass the BehaviorEvent to the mapped Behavior. For SceneEditorInputTable if the SceneEdtior is selecting a 2D or 3D layer the corresponding 2D or 3D table is used to find the mapping instead.

Parameters

Return

boolean:

RemoveKey(Libraries.Game.InputSet set)

Parameters

Return

Libraries.Interface.Behaviors.Behavior

RemoveKey2D(Libraries.Game.InputSet set)

RemoveKey2D removes a mapping of an InputSet to a Behavior specifically for the SceneEditor that is on a 2D scene or interacting with an Item2D.

Parameters

Return

Libraries.Interface.Behaviors.Behavior:

RemoveKey3D(Libraries.Game.InputSet set)

RemoveKey3D removes a mapping of an InputSet to a Behavior specifically for the SceneEditor that is on a 3D scene or interacting with an Item3D.

Parameters

Return

Libraries.Interface.Behaviors.Behavior:

SetIdentifier(text id)

Parameters

  • text id