Libraries.Interface.Controls.Scenes.SceneConstants Documentation

This class holds values of several defaults the Scene Editor uses to draw itself and other defaults the SceneEditor may need. Values this class stores include default width and height and default colors such as selection highlight colors and cursor colors.

Example Code

SceneConstants constants
output "Camera Width: " + constants:CAMERA_PREVIEW_2D_DEFAULT_WIDTH 
output "Camera Height: " + constants:CAMERA_PREVIEW_2D_DEFAULT_HEIGHT

Inherits from: Libraries.Language.Object

Variables Table

VariablesDescription
Libraries.Game.Graphics.Color GRID_3D_COLOR
Libraries.Game.Graphics.Color CURSOR_2D_COLOR
text EDITOR_TAG
number CAMERA_PREVIEW_2D_DEFAULT_HEIGHT
number CAMERA_PREVIEW_2D_DEFAULT_BORDER_THICKNESS
number CURSOR_2D_DEPTH
number SELECTION_HIGHLIGHT_PADDING_2D
Libraries.Game.Graphics.Color GRID_2D_COLOR
Libraries.Game.Graphics.Color CAMERA_PREVIEW_2D_DEFAULT_COLOR
Libraries.Game.Graphics.Color SELECTION_HIGHLIGHT_UNSELECTED_COLOR
Libraries.Game.Graphics.Color SELECTION_HIGHLIGHT_SELECTED_COLOR
number SELECTION_HIGHLIGHT_PADDING_3D
number CAMERA_PREVIEW_2D_DEPTH
number GRID_2D_DEPTHAdditional properties used for custom scene loading.
number SELECTION_HIGHLIGHT_2D_DEPTH
text SCENE_ITEM_INPUT_GROUP
number CAMERA_PREVIEW_2D_DEFAULT_WIDTH
text EULER_ANGLESAdditional properties used for custom scene loading.

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)

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