Libraries.Game.Scenes.SceneProperties Documentation

The SceneProperties class is a wrapper around a number of public constant text values which are used by the Scene system.

Inherits from: Libraries.Language.Object

Summary

Variable Summary Table

VariablesDescription
text VIEWPORT
text TEXTURE_REGION_LEFT
text CLASS
text NAMEThe following generic properties are used by a variety of elements of a scene.
text PHYSICS_ENABLED
text ROTATION
text APPLICATIONProperties describing the application as a whole.
text LAYERSProperties used for Layers. Layers require the following properties: NAME CLASS CAMERA ITEMS Layers may optionally also have the following: VIEWPORT PHYSICS SKYBOX (Layer3D only)
integer CIRCLE
text SIZE
text COLOR
text FILEThe FILE value typically indicates the location of a texture or a model fil
text RESTITUTION
text POSITION
text INTENSITY
integer PLANE
text LIGHTSThe following constants are used for lights stored in a layer. PointLights aren't stored here -- those are stored as Items instead. The lights here may include directional lights and ambient lighting. The following properties are required: CLASS COLOR DIRECTION (DirectionalLight only)
text ZOOM
text CHILDREN
text DIRECTION
text SCALE
text TEXTURE_REGION_BOTTOM
text ITEMSThe following properties are used for Items. Depending on the class of the Layer, items might be 2D or 3D. Different types of items require different properties, as listed in parenthesis below. The following properties are required for items: CLASS NAME POSITION SIZE TRANSFORM (Item3D) TYPE (Drawable or Model) POINTS (Drawable with TYPE = TRIANGLE) FILE (If TYPE = CUSTOM) TEXTURE_REGION_LEFT (Drawable with TYPE = CUSTOM) TEXTURE_REGION_RIGHT (Drawable with TYPE = CUSTOM) TEXTURE_REGION_TOP (Drawable with TYPE = CUSTOM) TEXTURE_REGION_BOTTOM (Drawable with TYPE = CUSTOM) INTENSITY (PointLight) The following properties are optional: DESCRIPTION SCALE ROTATION COLOR CHILDREN PHYSICS_ENABLED RESPONSIVENESS VIEW
text GRAVITY
integer RECTANGLEValid values for the TYPE property for Drawable item
text FRICTION
text FAR
text TEXTURE_REGION_TOP
integer CYLINDER
text VIEW
text VERSION
text ENABLED
integer BOXValid values for the TYPE property for Model item
integer FILLED_TRIANGLE
text UNMOVABLE
text UP
integer FILLED_CIRCLE
text DESCRIPTION
text SKYBOX
integer FILLED_RECTANGLE
integer SPHERE
text RESPONSIVENESS
number LASTEST_VERSION
text TRANSFORM
text NEAR
text FIELD_OF_VIEW
text PHYSICSProperties related to the use of Physics in a Layer. The following properties are required for Physics: ENABLED These properties are optional: GRAVITY
text RESPONSIVEValid values for the RESPONSIVENESS propert
text CAMERAProperties used for the camera in a Layer. Cameras require the following properties: POSITION DIRECTION UP CLASS They may optionally use the following: ZOOM (OrthographicCamera only) FIELD_OF_VIEW (PerspectiveCamera only) SIZE NEAR FAR
text FULL_SCREEN
text TEXTURE_REGION_RIGHT
integer CUSTOM
text NONRESPONSIVE
text POINTS
text MASS
text TYPE
integer NONENONE is typically used for TYPE if a Model or Drawable hasn't been loaded ye

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.
GetHashCode()This action gets the hash code for an object.

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.

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.