Libraries.Interface.Events.SceneEditorChangeEvent Documentation

The SceneEditorChangeEvent class describes an event where the user interacted with the Scene Editor and added or removed an item from the scene. This class contains information on the Scene Editor affected, the item involved in the event, and the EditorLayer the item was on.

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
integer REMOVED
integer ADDED

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.

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)

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)

GetEventType()

Returns the event type. If 1 the item was added, if 2 the item was removed.

Return

integer: The event type

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()

GetItem()

Returns the item that was added or removed

Return

Libraries.Interface.Item: The item that was added or removed

GetLayer()

Returns the EditorLayer affected by the event

Return

Libraries.Interface.Controls.Scenes.Layers.EditorLayer: The EditorLayer

GetParentItem()

Returns the parent of the item that triggered the event

Return

Libraries.Interface.Item: The parent item

GetSceneEditor()

Returns the SceneEditor where the event happened

Return

Libraries.Interface.Controls.Scenes.SceneEditor: The scene editor

Set(Libraries.Interface.Controls.Scenes.SceneEditor editor, Libraries.Interface.Item item, Libraries.Interface.Item parentItem, Libraries.Interface.Controls.Scenes.Layers.EditorLayer layer, integer eventType)

The Set action sets all the fields of the event. When creating a new event this action is called so the object contains all the information needed for the listeners to react to it.

Parameters