Libraries.Game.Graphics.Model

This action adds a different Item3D into this one. This makes a few things happen. 1. The added item will get this item as its parent. 2. The added item's x, y, and z coordinates will become relative to this Item. 3. Most actions on this Item will also affect the added Item.

Parameters

• Libraries.Interface.Item3D: The item to add as a child to this Item3D.

This action adds a different Item3D into this one, storing the added Item3D at a specific index in the internal array.

Parameters

• integer index: The index to store the child item at.
• Libraries.Interface.Item3D: The item to add as a child to this Item3D.

This action adds a new Behavior to this Item.

Parameters

• Libraries.Interface.Behaviors.Behavior

This action adds a FocusListener to the Item. When the Item receives a FocusEvent due to either gaining or losing the focus, the listener will be notified.

Parameters

• Libraries.Interface.Events.FocusListener

This action adds a GestureListener to the Item. If the Item ever receives a GestureEvent, the listener will be notified.

Parameters

• Libraries.Interface.Events.GestureListener

This action adds a MouseListener to the Item. If the Item ever receives a MouseEvent due to a mouse click, the mouse listener will be notified.

Parameters

• Libraries.Interface.Events.MouseListener

This action adds a MouseMovementListener to the Item. If the Item ever receives a MouseEvent due to mouse movement, the listener will be notified.

Parameters

• Libraries.Interface.Events.MouseMovementListener

This action adds a MouseWheelListener to the Item. If the Item ever receives a MouseEvent due to the mouse wheel being scrolled, the listener will be notified.

Parameters

• Libraries.Interface.Events.MouseWheelListener

This action adds a TouchListener to the Item. If the Item ever receives a TouchEvent, the listener will be notified.

Parameters

• Libraries.Interface.Events.TouchListener

This action will increase the y-coordinate of this Item by the given amount.

Parameters

• Libraries.Compute.Vector3

Parameters

• number seconds

transform:Translate(xAmount, yAmount, -zAmount)

Parameters

• Libraries.Compute.Vector3
• Libraries.Compute.Vector3

This action will increase the x, y, and z coordinates of this Item by the given amounts.

Parameters

• Libraries.Compute.Vector3

ACTIONS MADE FOR JOINTS.

Parameters

• Libraries.Compute.Vector3
• Libraries.Compute.Vector3

This action will increase the z-coordinate of this Item by the given amount.

Parameters

• Libraries.Compute.Vector3
• Libraries.Compute.Vector3

ACTIONS MADE FOR JOINTS.

Parameters

• Libraries.Compute.Vector3

transform:Translate(0, 0, -zAmount)

Parameters

• Libraries.Compute.Vector3

Parameters

• Libraries.Compute.Vector3

This action is used to indicate that two items have just begun colliding. When two Items collide, the BeginCollision action should be called on both of them, with the other item passed as a parameter to the action. Note that this action does nothing by default, but classes that inherit from Item may override it.

Parameters

• Libraries.Interface.Item: The other Item involved in the collision.

CalculateBoundingBox will create a new BoundingBox object that contains the bounds of the Model.

Return

Libraries.Game.BoundingBox: A new axis-aligned BoundingBox for this Model.

CalculateBoundingBox will compute the bounds of this Model, and then store them inside the provided BoundingBox object. If any data was previously stored in this BoundingBox, it will be overwritten.

Parameters

• Libraries.Game.BoundingBox

Return

Libraries.Game.BoundingBox: The given axis-aligned BoundingBox, which will contain the bounds of this Model.

Parameters

• boolean flag

This action stops all behaviors this Item is following without finishing them.

Return

boolean

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

• Libraries.Language.Object: The object to compare to.

Return

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

Parameters

• Libraries.Compute.Vector3

Return

number

Parameters

• Libraries.Compute.Vector3
• Libraries.Compute.Vector3

Return

number

This action will take a TouchEvent and distribute it to any TouchListeners that have been added to this Item3D. This action will also set the event to the "handled" state.

Parameters

• Libraries.Game.Collision.BroadphaseCollision3D
• Libraries.Game.Collision.PhysicsPosition3D

This action will remove all Items from this Item's children hierarchy. Note that this will not empty the hierarchies of the contained Items.

Parameters

• Libraries.Game.Collision.BroadphaseCollision3D

This action is used to free up any additional memory that is being used by this Item for purposes such as graphics. Note that the Item class doesn't have any extra memory that needs to be released with this action, but some classes which inherit from Item, such as Libraries.Game.Graphics.Drawable, do.

This action is used to call Dispose on this Item and on the entire children hierarchy of this Item.

This action is used to call Dispose on the entire children hierarchy of this Item. This will not call Dispose on this Item.

The Draw action is what makes a Model appear on the screen. This action will automatically be called by the Game class if the Model has been added to the Game with the Add(Item) action. Most users will never need to use this action directly.

Parameters

• Libraries.Game.Graphics.Painter3D: The Painter3D being used to draw this Model.

This action will remove all Items from this Item's children hierarchy. Note that this will not empty the hierarchies of the contained Items.

This action will call Empty on the entire children hierarchy of this item, and then empty this item as well.

This action is used to call Empty on all children contained in this item's children hierarchy. This will not empty the children of this item.

This action will return the global y coordinate of the Item3D. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Parameters

• boolean flag

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

Parameters

• Libraries.Language.Object: The to be compared.

Return

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

ExtendBoundingBox will expand the bounds of the given BoundingBox to fully encapsulate the bounds of this Model.

Parameters

• Libraries.Game.BoundingBox: The BoundingBox to extend.

Return

Libraries.Game.BoundingBox: The given BoundingBox, which now includes the bounds of this Model.

This action sets the x, y, and z coordinates of the Item3D.

Parameters

• boolean flag

This action is used to indicate that two items that were previously colliding no longer are. The FinishCollision action should be called on both Items involved, with the other item passed as a parameter to the action. Note that this action does nothing by default, but classes that inherit from Item may override it.

Parameters

• Libraries.Interface.Item: The other Item involved in the collision.

This action sets focus on this Item. If the Item is not focusable, it will instead look through the parent hierarchy and set focus on the first focusable ancestor. If no focusable Item can be found, this action will have no effect.

This action is fired if the item received the focus.

Parameters

• Libraries.Interface.Events.FocusEvent

This action returns the current accessiblity code for this Item

Return

integer:

This action returns the custom accessibility role description for this item, if any.

Return

text:

This action returns the name of the accessiblity code for this Item as Text

Return

text:

This action returns the parent of this Item3D. An Item3D gets a parent when it is added to another Item using the Add action.

Return

Libraries.Interface.Item: The parent Item.

This action sets the width, height, and depth of the Item3D.

Return

number:

Source: http://answers.unity3d.com/storage/temp/12048-lefthandedtorighthanded.pdf

Return

number:

This action sets the Z offset of the item. The offset tells the Item where to relate its Z position to. In other words, the Z offset is where a Z coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Return

Libraries.Compute.Vector3:

This action returns an array containing all Animation objects used by this Model.

Return

Libraries.Containers.Array: The array containing the Animations used by this Model.

This action returns the asset file that was used to load this asset. This might be a custom model file (e.g. ".obj") or it might be a texture applied to a primitive (e.g. ".png"). If this model doesn't use an asset file (e.g. it's a non-textured primitive object) then this will remain undefined.

Return

Libraries.System.File: The file that was used to load this Model, or undefined if no such file has been used.

This action will return the identifier for the ModelBlueprint that this model was loaded from.

Return

text: A text value identifying the ModelBlueprint used to load this Model.

This action is used to draw this Item on the screen, and then draw all of the Item's children hierarchy on the screen. Note that Items themselves can not be drawn, but some classes that extend the Item class, such as the Libraries.Game.Graphics.Model class, can be. To see how they draw, see their documentation.

Parameters

• integer childIndex

Return

Libraries.Game.BoundingBox:

Return

Libraries.Compute.Vector3

Return

Libraries.Game.Collision.PhysicsPosition3D

This action lets the 3D collision solver actions (inside the class CollisionSolver3D) know that if this object needs its physics to be updated.

Return

boolean:

This action sets where in the "list of objects that needs to be updated because collision happened" that this object resides in. This "list of objects that needs to be updated because collision happened" is stored inside the CollisionSolver3D class as tempSolverBodyPool.

Return

integer:

This action will return the Matrix4 containing the rotations applied to the Item3D. The values inside the Matrix are used during transform calculations, so they shouldn't be changed unless you know what you're doing!

Return

Libraries.Game.Collision.CollisionEdge3D: The Matrix4 used by this item to store and calculate rotations.

This action removes an Item3D that was previously added to this Item3D.

Return

Libraries.Game.Collision.PhysicsPosition3D: Whether or not the item was found and removed.

Return

Libraries.Game.Collision.PhysicsPosition3D

This action returns the diffuse color of a primitive model. If a primitive shape hasn't been loaded, this action will return undefined.

Return

Libraries.Game.Graphics.Color:

GetDepth will return the depth of this Item3D.

Return

number: The depth of this item.

This action returns the current internal description of the Item.

Return

text:

GetDimensions will return a Vector3 object containing the width, height, and depth of this Item3D object.

Return

Libraries.Compute.Vector3: A new Vector3 object containing the width, height, and depth of this item.

This action returns an Iterator containing all of the FocusListeners that have been added to this Item using the AddFocusListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered FocusListeners.

This action sets the X offset of the Item. The offset tells the Item where to relate its X position to. In other words, the X offset is where an X coordinate of 0 is for this Item. This is automatically set when using an action to add an Item to another Item.

Return

Libraries.Compute.Vector3:

GetZ will return the Z coordinate of this Item3D in 3D space. Note that if if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative Z coordinate, use the GetGlobalZ() action instead.

Return

number: The current z coordinate of this Item, relative to the parent Item (if there is one).

This action returns an Iterator containing all of the GestureListeners that have been added to this Item using the AddGestureListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered GestureListeners.

This action will return the global position of the Item3D as a Vector3. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Return

Libraries.Compute.Vector3: A new Vector3 object containing the global coordinates of this Item (not relative to any parent).

This action will return the global x coordinate of the Item3D. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Return

number: The global X coordinate of this Item (not relative to any parent).

This action will return the global y coordinate of the Item3D. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Return

number: The global Y coordinate of this Item (not relative to any parent).

This action will return the global z coordinate of the Item3D. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Return

number: The global Z coordinate of this Item (not relative to any parent).

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

GetHeight will return the height of this Item3D.

Return

number: The height of this item.

This action returns the input group for this Item. When used with the Game libraries, this tag describes what InputTable (if any) can interact with this Item due to input.

Return

text: The input group tag being used by this Item.

Return

Libraries.Game.InputTable:

Return

Libraries.Compute.Vector3

Return

Libraries.Compute.Vector3

This action adds a different Item3D into this one, storing the added Item3D at a specific index in the internal array.

Return

Libraries.Game.Collision.PhysicsPosition3D:

Return

Libraries.Game.Collision.PhysicsPosition3D

Return

Libraries.Compute.Vector3

GetHeight will return the height of this Item3D.

Return

Libraries.Compute.Matrix3: The height of this item.

GetDepth will return the depth of this Item3D.

Return

number: The depth of this item.

This action returns an Item3D that was previously added to this Item3D by finding it at the given index in the internal array of children Items.

Parameters

• integer index: The index to retrieve from the children array.

Return

Libraries.Interface.Item3D: The child Item stored at the index.

This action returns the number of items contained in this Item3D.

Return

integer: The number of children in this Item3D.

This action returns an iterator containing all the items contained in this Item3D.

Return

Libraries.Containers.Iterator: An iterator containing all children in this Item3D.

vector:Scale(1, 1, -1)

Return

Libraries.Game.Physics.Joints.JointEdge3D:

This action returns the current Layer3D that this Item3D is a part of in the Game libraries.

Return

Libraries.Game.Layer3D: The current Layer3D that this Item3D is attached to (if any).

This action will find all of the Light objects contained in the children hierarchy of this Item3D and add it to the end of the given array. If this object is a Light, it will be added to the array first before adding any descendents where are Lights.

Parameters

• Libraries.Containers.Array

This action will return an array of all Light objects contained in the children hierarchy of this Item3D. If this object is a Light, it will also be included as the first item in the array.

Return

Libraries.Containers.Array: An array of all Lights stored in this Item3D.

GetWidth will return the width of this Item3D.

Return

number: The width of this item.

This action sets the offsets of the item. The offsets tell the Item where to relate its position to. In other words, the offsets determine where each coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Return

Libraries.Compute.Vector3:

Parameters

• Libraries.Compute.Vector3

Return

Libraries.Compute.Vector3

This action will increase the x-coordinate of this Item by the given amount.

Return

number:

This action returns an array containing all Material objects used by this Model.

Return

Libraries.Containers.Array: The array containing the Materials used by this Model.

This action will return the ModelBlueprint that this model was loaded from.

Return

Libraries.Game.Graphics.ModelBlueprint: The ModelBlueprint that this Model was loaded from.

This action returns the type of Model that has been loaded using one of the integer codes found in SceneProperties. By default, this value is NONE.

Return

integer: An integer code representing the type of Model that has been loaded.

This action returns an Iterator containing all of the MouseListeners that have been added to this Item using the AddMouseListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered MouseListeners.

This action returns an Iterator containing all of the MouseMovementListeners that have been added to this Item using the AddMouseMovementListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered MouseMovementListeners.

This action returns an Iterator containing all of the MouseWheelListeners that have been added to this Item using the AddMouseWheelListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered MouseWheelListeners.

This action returns the current internal name of the Item.

Return

text:

This action returns the next focus item. When this Item has the focus and the user requests the focus to advance (e.g. by pressing the tab key), the returned value is the next item to receive that focus, if it is defined. If it isn't defined, the focus can not advance from this Item.

Return

Libraries.Interface.Item: The next Item to receive focus after this one.

This action returns an iterator containing all the items contained in this Item3D.

Parameters

• integer index

Return

Libraries.Game.Collision.Item3DNode: An iterator containing all children in this Item3D.

This action returns whether or not any items are contained in this Item.

Return

integer: Whether or not this item contains any children.

This action returns an array containing all Node objects used by this Model.

Return

Libraries.Containers.Array: The array containing the Nodes used by this Model.

This action returns the X offset of the Item. The offset tells the Item where to relate its X position to. In other words, the X offset is where an X coordinate of 0 is for this Item. This is automatically set when using an action to add an Item to another Item.

Return

number: The current X offset.

This action returns the Y offset of the item. The offset tells the Item where to relate its Y position to. In other words, the Y offset is where a Y coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Return

number: The current Y offset.

This action returns the Z offset of the item. The offset tells the Item where to relate its Z position to. In other words, the Z offset is where a Z coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Return

number: The current Z offset.

Return

Libraries.Compute.Quaternion

This action returns the parent of this Item3D. An Item3D gets a parent when it is added to another Item using the Add action.

Return

Libraries.Interface.Item3D: The parent Item.

Return

Libraries.Game.Physics.PhysicsProperties3D

This action will rotate this Item3D clockwise about an axis passing through the given point. The direction of the axis is represented by the given Vector3 object. The last parameter is a boolean that determines whether or not children should also be rotated - a value of true will rotate the children, a value of false will not. Note that the children will still maintain relative position to this item, regardless of the boolean passed.

Return

number:

GetPosition will return a Vector3 object containing the X, Y, and Z coordinates of this Item3D object. Note that if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative coordinates, use the GetGlobalPosition() action instead.

Return

Libraries.Compute.Vector3: A new Vector3 object containing the x, y, and z coordinates of this Item, relative to the parent Item (if there is one).

This action returns the previous focus item. When this Item has the focus and the user requests the focus to move backwards (e.g. by pressing shift & tab), the returned value is the previous item to receive that focus, if it is defined. If it isn't defined, the focus can not move backwards from this Item.

Return

Libraries.Interface.Item: The previous Item to receive focus before this one.

Return

integer

Parameters

• text key

Return

Libraries.Data.Formats.JavaScriptObjectNotation

Return

Libraries.Containers.Iterator

Return

Libraries.Compute.Vector3

GetRenderables is used to retrieve all of the individual renderable components of this Model. This action is used internally by the Game engine. Most users should never need to access this action directly.

Parameters

• Libraries.Containers.Array: An array that will contain all of the retrieved Renderables.

This action sets the height of the Item.

Return

integer:

GetX will return the X coordinate of this Item3D in 3D space. Note that if if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative X coordinate, use the GetGlobalX() action instead.

Return

number: The current x coordinate of this Item, relative to the parent Item (if there is one).

This action will rotate this Item3D clockwise about an axis passing through the given point. The direction of the axis is represented by the given Vector3 object. The children of this Item3D will also be rotated.

Return

number:

This action will return the Matrix4 containing the rotations applied to the Item3D. The values inside the Matrix are used during transform calculations, so they shouldn't be changed unless you know what you're doing!

Return

Libraries.Compute.Matrix4: The Matrix4 used by this item to store and calculate rotations.

This action will scale the Item3D by values of the given Vector3. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be scaled.

Return

number:

This action will rotate all of the children of this Item3D clockwise about an axis passing through this item. The direction of the axis is represented by the given Vector3, and the children will be rotated by the given number of degrees.

Return

number:

This action will rotate the Item3D about an axis represented by the given Vector3. The item will be rotated by an angle given in degrees. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be rotated.

Return

number:

This action returns a 2D rectangle describing the approximate bounds of this Item3D on the screen. The rectangle isn't rotated (i.e. the rectangle's edges are aligned with the screen's edges), so the rectangle may be significantly larger than the space taken by the Item3D on the screen in some cases.

Return

Libraries.Game.Shapes.Rectangle:

This action returns the x coordinate of the Item on the screen. If the Item hasn't been attached to a Layer, this will return a "Not a Number" value instead.

Return

number:

This action returns the y coordinate of the Item on the screen. If the Item hasn't been attached to a Layer, this will return a "Not a Number" value instead.

Return

number:

The Draw action is what makes a Model appear on the screen. This action will automatically be called by the Game class if the Model has been added to the Game with the Add(Item) action. Most users will never need to use this action directly.

Return

Libraries.Language.Object:

CalculateBoundingBox will compute the bounds of this Model, and then store them inside the provided BoundingBox object. If any data was previously stored in this BoundingBox, it will be overwritten.

Return

Libraries.Game.Graphics.Shaders.ShaderMapping: The given axis-aligned BoundingBox, which will contain the bounds of this Model.

This action returns the asset file that was used to load this asset. This might be a custom model file (e.g. ".obj") or it might be a texture applied to a primitive (e.g. ".png"). If this model doesn't use an asset file (e.g. it's a non-textured primitive object) then this will remain undefined.

Return

Libraries.Game.Graphics.Shaders.ShaderProgram: The file that was used to load this Model, or undefined if no such file has been used.

This action will return an array of all Light objects contained in the children hierarchy of this Item3D. If this object is a Light, it will also be included as the first item in the array.

Return

Libraries.Game.Collision.Shapes.CollisionShape3D: An array of all Lights stored in this Item3D.

This action is used by the Game libraries to create a reference to the layer that this Item3D exists on. It is automatically called as needed by the Layer3D class. Most users will never need to use this action directly.

Return

integer:

Return

number

transform:Set(matrix)

Return

number:

This action will increase the x, y, and z coordinates of this Item by the values inside the given Vector3.

Return

Libraries.Compute.Vector3:

This action returns an Iterator containing all of the TouchListeners that have been added to this Item using the AddTouchListener action.

Return

Libraries.Containers.Iterator: An iterator containing all of the registered TouchListeners.

This action will return the Matrix4 containing the transformations applied to the Item3D, including its global position, rotation, and scaling.

Return

Libraries.Compute.Matrix4: The Matrix4 used by this item to store and calculate transformations.

Return

Libraries.Compute.Vector3

GetWidth will return the width of this Item3D.

Return

number: The width of this item.

GetX will return the X coordinate of this Item3D in 3D space. Note that if if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative X coordinate, use the GetGlobalX() action instead.

Return

number: The current x coordinate of this Item, relative to the parent Item (if there is one).

GetY will return the Y coordinate of this Item3D in 3D space. Note that if if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative Y coordinate, use the GetGlobalY() action instead.

Return

number: The current y coordinate of this Item, relative to the parent Item (if there is one).

We store the offsets we'll be using before manipulating anything. This ensures we use the original data, and there's no risk of using data that's been modified on the fly (e.g., updating a parent item will affect the position of the child item).

Return

number:

GetZ will return the Z coordinate of this Item3D in 3D space. Note that if if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative Z coordinate, use the GetGlobalZ() action instead.

Return

number: The current z coordinate of this Item, relative to the parent Item (if there is one).

Return

boolean

Return

boolean

Parameters

• text key

Return

boolean

This action is used to indicate that an Item and all Items that were added to it should not be visible on the screen. Note that the Item class on its own cannot be drawn on the screen, but classes that inherit from it such as Libraries.Game.Graphics.Drawable can be. By default, Items are considered visible.

Parameters

• number seconds

Parameters

• Libraries.Compute.Vector3
• Libraries.Compute.Vector3
• number impulseMagnitude

This action returns whether or not this Item accepts mouse input. If the value is true, this will intercept incoming mouse events, triggering any related MouseListeners and InputSets and preventing the mouse event from propagating to other Items on the Layer. The default value is true.

Return

boolean: True if this Item can receive mouse events, or false otherwise.

This action returns the nearest parent object that is accessible. This can be anything that the programmer wants to be accessible, from user interface components in a 2D interface to 3D components relative in 3-space on screen. By default, items have no accessible parent and are self-contained, but user interface components normally override the behavior so that controls can be logically nested within each other. attribute: returns Item

Return

boolean:

This action removes an Item that was previously added to this Item by finding it at the given index in the internal array of children Items.

Return

boolean: The Item that was removed.

This action returns whether or not any items are contained in this Item.

Return

boolean: Whether or not this item contains any children.

This action sets the x, y, and z coordinates of the Item3D.

Return

boolean:

This action returns whether or not the Item can currently receive focus. This property can be set with SetFocusable().

Return

boolean:

The IsFocused action determines if this Item is currently focused, returning true if it is, or false if it is not.

Return

boolean:

Return

boolean

This action returns true if the item has been added to a Layer, or false otherwise.

Return

boolean: True if the item is on a Layer, or false otherwise.

This action will return the global z coordinate of the Item3D. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Return

boolean: The global Z coordinate of this Item (not relative to any parent).

Return

boolean

Return

boolean

This action returns whether the Item is currently set to be visible on the screen.

Return

boolean: A boolean representing whether or not the Item is currently visible.

Return

boolean

This action sets the Y coordinate of the Item.

Return

boolean:

Return

boolean

This action will load this Model using the data contained in the given ModelBlueprint, and set its transform using the given Matrix4 (if it is defined).

Parameters

• Libraries.Game.Graphics.ModelBlueprint: The ModelBlueprint to load.
• Libraries.Compute.Matrix4: The Matrix4 used to transform this Model. use Libraries.Game.Game use Libraries.Game.Graphics.Model use Libraries.Game.Graphics.ModelBlueprint use Libraries.Game.Graphics.Color use Libraries.Compute.Matrix4 class Main is Game Model cube Model cubeCopy action Main StartGame() end action CreateGame Color mint mint:SetColor(0.5, 1, 0.75, 1) cube:LoadBox(2, 2, 2, mint) Add(cube) Matrix4 matrix matrix:SetToTranslation(2, 0, 0) matrix:Rotate(0, 1, 0, 45) ModelBlueprint schematic = cube:GetModelBlueprint() cubeCopy:Load(schematic, matrix) Add(cubeCopy) cube:SetX(-2) end end

This action will load the Model file with the given file name from the default file directory. The supported file extensions are .obj, .g3db, and .g3dj.

Parameters

• text fileName: The name of the file to be loaded.

This action will load this Model using the data contained in the given ModelBlueprint.

Parameters

• Libraries.Game.Graphics.ModelBlueprint: The ModelBlueprint to load.

This action will load a model from a given model file. The supported file extensions are .obj, .g3db, and .g3dj.

Parameters

• Libraries.System.File: The file containing the model data to be loaded.

This action will load the Model with a box with the given width, height, depth, and color.

Parameters

• number width: How long the box should be along the x-axis.
• number height: How long the box should be along the y-axis.
• number depth: How long the box should be along the z-axis.
• Libraries.Game.Graphics.Color: What color the box should be.

This action will load the Model with a box with the given width, height, and depth. The box will use the texture located at the provided file path.

Parameters

• number width: How long the box should be along the x-axis.
• number height: How long the box should be along the y-axis.
• number depth: How long the box should be along the z-axis.
• text textureFile: The name of a texture file to be displayed on each side of the box.

This action will load the Model with a box with the given width, height, and depth. The box will use the texture that has been loaded by the given Drawable.

Parameters

• number width: How long the box should be along the x-axis.
• number height: How long the box should be along the y-axis.
• number depth: How long the box should be along the z-axis.
• Libraries.Game.Graphics.Drawable: A loaded Drawable containing an image to be used on each side of the box.

This action will load the Model with a box with the given width, height, and depth. The box will use the texture located in the provided file.

Parameters

• number width: How long the box should be along the x-axis.
• number height: How long the box should be along the y-axis.
• number depth: How long the box should be along the z-axis.
• Libraries.System.File: A file containing a texture to show on each side of the box.

This action will load the Model with a box with the given width, height, depth, and texture.

Parameters

• number width: How long the box should be along the x-axis.
• number height: How long the box should be along the y-axis.
• number depth: How long the box should be along the z-axis.
• Libraries.Game.Graphics.Texture

This action will load the Model with a cylinder with the given dimensions, using the texture contained in the given (loaded) Drawable. The curve of the cylinder will be approximated using 16 straight edges.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• Libraries.Game.Graphics.Drawable: A loaded Drawable to draw onto the cylinder.

This action will load the Model with a cylinder with the given dimensions and texture. The curve of the cylinder will be approximated using 16 straight edges.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• text textureFile: The name of a file containing the texture to draw onto the cylinder.

This action will load the Model with a cylinder with the given width, height, depth, and color. The default cylinder will be made using 16 straight sides to simulate the curve of the cylinder.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• Libraries.Game.Graphics.Color: What color the cylinder should be.

This action will load the Model with a cylinder with the given dimensions and using the texture contained in the provided Drawable. The Drawable must be loaded. The provided number of divisions will be used to simulate the curve of the cylinder - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• integer divisions: How many straight edges to use to simulate the curve of the cylinder.
• Libraries.Game.Graphics.Drawable: A loaded Drawable that contains a texture to be displayed on the cylinder.

This action will load the Model with a cylinder with the given dimensions and texture. The provided number of divisions will be used to simulate the curve of the cylinder - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• integer divisions: How many straight edges to use to simulate the curve of the cylinder.
• Libraries.System.File: A texture file containing the texture to display on the cylinder.

This action will load the Model with a cylinder with the given dimensions and texture. The curve of the cylinder will be approximated using 16 straight edges.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• Libraries.System.File: A file containing the texture to draw onto the cylinder.

This action will load the Model with a cylinder with the given dimensions and texture. The provided number of divisions will be used to simulate the curve of the cylinder - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• integer divisions: How many straight edges to use to simulate the curve of the cylinder.
• Libraries.Game.Graphics.Texture: The texture to draw on the sides of the cylinder.

This action will load the Model with a cylinder with the given dimensions and texture. The curve of the cylinder will be approximated using 16 straight edges.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• Libraries.Game.Graphics.Texture: The texture to be drawn onto the cylinder.

This action will load the Model with a cylinder with the given dimensions and color. The provided number of divisions will be used to simulate the curve of the cylinder - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• integer divisions: How many straight edges to use to simulate the curve of the cylinder.
• Libraries.Game.Graphics.Color: What color the cylinder should be.

This action will load the Model with a cylinder with the given dimensions and texture. The provided number of divisions will be used to simulate the curve of the cylinder - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the cylinder should be along the x-axis.
• number height: How long the cylinder should be along the y-axis.
• number depth: How long the cylinder should be along the z-axis.
• integer divisions: How many straight edges to use to simulate the curve of the cylinder.
• text textureFile: The name of a file containing the texture to display on the cylinder.

This action will load the Model with a plane with the given width, depth, and texture.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.Game.Graphics.Texture

This action will load the Model with a plane with the given width and depth. The plane will use the texture located at the provided file path. If the boolean value provided is true, it will be double sided (allowing it to be viewed from both sides of the plane) -- otherwise, it will only visible along the top of the plane.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• text textureFile: The name of a texture file to be displayed on the surface of the plane.
• boolean doubleSided: True to make the plane double-sided, false otherwise.

This action will load the Model with a plane with the given width and depth. The plane will use the texture located at the provided file path.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• text textureFile: The name of a texture file to be displayed on the surface of the plane.

This action will load the Model with a plane with the given width and depth. The plane will use the texture that has been loaded by the given Drawable. If the boolean value provided is true, it will be double sided (allowing it to be viewed from both sides of the plane) -- otherwise, it will only visible along the top of the plane.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.Game.Graphics.Drawable: A loaded Drawable containing an image to be used on the surface of the plane.
• boolean doubleSided: True to make the plane double-sided, false otherwise.

This action will load the Model with a plane with the given width and depth. The plane will use the texture located in the provided file.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.System.File: A file containing a texture to show on the surface of the plane.

This action will load the Model with a plane with the given width, depth, and color. If the boolean value provided is true, it will be double sided (allowing it to be viewed from both sides of the plane) -- otherwise, it will only visible along the top of the plane.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.Game.Graphics.Color: What color the plane should be.
• boolean doubleSided: True to make the plane double-sided, false otherwise.

This action will load the Model with a plane with the given width, depth, and texture. If the boolean value provided is true, it will be double sided (allowing it to be viewed from both sides of the plane) -- otherwise, it will only visible along the top of the plane.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.Game.Graphics.Texture
• boolean doubleSided: True to make the plane double-sided, false otherwise.

This action will load the Model with a plane with the given width, depth, and color.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.Game.Graphics.Color: What color the plane should be.

This action will load the Model with a plane with the given width and depth. The plane will use the texture that has been loaded by the given Drawable.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.Game.Graphics.Drawable: A loaded Drawable containing an image to be used on the surface of the plane.

This action will load the Model with a plane with the given width and depth. The plane will use the texture located in the provided file. If the boolean value provided is true, it will be double sided (allowing it to be viewed from both sides of the plane) -- otherwise, it will only visible along the top of the plane.

Parameters

• number width: How long the plane should be along the x-axis.
• number depth: How long the plane should be along the z-axis.
• Libraries.System.File: A file containing a texture to show on the surface of the plane.
• boolean doubleSided: True to make the plane double-sided, false otherwise.

This action will load the Model with a sphere with the given dimensions and texture. The provided number of divisions will be used to simulate the curve of the sphere - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• integer horizontalDivisions: How many straight edges to use on the horizontal plane to simulate the curve of the sphere.
• integer verticalDivisions: How many straight edges to use on the vertical plane to simulate the curve of the sphere.
• text textureFile: The name of a file containing the texture to display on the sphere.

This action will load the Model with a sphere with the given dimensions and texture. The provided number of divisions will be used to simulate the curve of the sphere - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• integer horizontalDivisions: How many straight edges to use on the horizontal plane to simulate the curve of the sphere.
• integer verticalDivisions: How many straight edges to use on the vertical plane to simulate the curve of the sphere.
• Libraries.System.File: A texture file containing the texture to display on the sphere.

This action will load the Model with a sphere with the given width, height, depth, and color. The default sphere will be made using 25 straight sides on the horizontal plane and 16 straight sides on the vertical plane to simulate the curve of a true sphere.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• Libraries.Game.Graphics.Color: What color the sphere should be.

This action will load the Model with a sphere with the given dimensions and color. The provided number of divisions will be used to simulate the curve of the sphere - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• integer horizontalDivisions: How many straight edges to use on the horizontal plane to simulate the curve of the sphere.
• integer verticalDivisions: How many straight edges to use on the vertical plane to simulate the curve of the sphere.
• Libraries.Game.Graphics.Color: What color the sphere should be.

This action will load the Model with a sphere with the given dimensions and texture. The curve of the sphere will be approximated using 25 straight edges along the horizontal plane, and 16 straight edges along the vertical plane.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• Libraries.System.File: A file containing the texture to draw onto the sphere.

This action will load the Model with a sphere with the given dimensions and texture. The provided number of divisions will be used to simulate the curve of the sphere - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• integer horizontalDivisions: How many straight edges to use on the horizontal plane to simulate the curve of the sphere.
• integer verticalDivisions: How many straight edges to use on the vertical plane to simulate the curve of the sphere.
• Libraries.Game.Graphics.Texture: The texture to draw on the sides of the sphere.

This action will load the Model with a sphere with the given dimensions and using the texture contained in the provided Drawable. The Drawable must be loaded. The provided number of divisions will be used to simulate the curve of the sphere - the more divisions used, the smoother the curve will appear.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• integer horizontalDivisions: How many straight edges to use on the horizontal plane to simulate the curve of the sphere.
• integer verticalDivisions: How many straight edges to use on the vertical plane to simulate the curve of the sphere.
• Libraries.Game.Graphics.Drawable: A loaded Drawable that contains a texture to be displayed on the sphere.

This action will load the Model with a sphere with the given dimensions and texture. The curve of the cylinder will be approximated using 25 straight edges along the horizontal plane, and 16 straight edges along the vertical plane.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• Libraries.Game.Graphics.Texture: The texture to be drawn onto the sphere.

This action will load the Model with a sphere with the given dimensions, using the texture contained in the given (loaded) Drawable. The curve of the sphere will be approximated using 25 straight edges along the horizontal plane and 16 straight edges along the vertical plane.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• Libraries.Game.Graphics.Drawable: A loaded Drawable to draw onto the sphere.

This action will load the Model with a sphere with the given dimensions and texture. The curve of the cylinder will be approximated using 25 straight edges along the horizontal plane, and 16 straight edges along the vertical plane.

Parameters

• number width: How long the sphere should be along the x-axis.
• number height: How long the sphere should be along the y-axis.
• number depth: How long the sphere should be along the z-axis.
• text textureFile: The name of a file containing the texture to draw onto the sphere.

This action is fired if the item lost the focus.

Parameters

• Libraries.Interface.Events.FocusEvent

This action will increase the x, y, and z coordinates of this Item by the values inside the given Vector3.

Parameters

• Libraries.Compute.Vector3: A vector describing how much to increase the current x, y, and z coordinates of this item by.

This action will increase the x, y, and z coordinates of this Item by the given amounts.

Parameters

• number xAmount: How much to increase the current x coordinate of this item by.
• number yAmount: How much to increase the current y coordinate of this item by.
• number zAmount: How much to increase the current z coordinate of this item by.

This action will increase the x-coordinate of this Item by the given amount.

Parameters

• number xAmount: How much to increase the current x coordinate of this item by.

This action will increase the y-coordinate of this Item by the given amount.

Parameters

• number yAmount: How much to increase the current y coordinate of this item by.

This action will increase the z-coordinate of this Item by the given amount.

Parameters

• number zAmount: How much to increase the current z coordinate of this item by.

Parameters

• number seconds
• Libraries.Game.Collision.PhysicsPosition3D

Parameters

• Libraries.Game.Collision.PhysicsPosition3D

This action takes a gesture event and handles it. It will first test to see if the gesture event took place within the bounds of this Item. If so, it will notify any GestureListeners of the event. If the event was not contained within this Item, or if there are no GestureListeners on this Item, the Item will ask its parent Item to process the event, if there is a parent.

Parameters

• Libraries.Interface.Events.GestureEvent

This action takes a MouseEvent and distributes it to any MouseListeners, MouseMovementListeners, and MouseWheelListeners that have been added to this Item3D. This action will also set the event to the "handled" state.

Parameters

• Libraries.Interface.Events.MouseEvent

This action will take a TouchEvent and distribute it to any TouchListeners that have been added to this Item3D. This action will also set the event to the "handled" state.

Parameters

• Libraries.Interface.Events.TouchEvent: The TouchEvent to process.

This action removes an Item that was previously added to this Item by finding it at the given index in the internal array of children Items.

Parameters

• integer index: The index to remove from the children array.

Return

Libraries.Interface.Item3D: The Item that was removed.

This action removes an Item3D that was previously added to this Item3D.

Parameters

• Libraries.Interface.Item3D

Return

boolean: Whether or not the item was found and removed.

This action removes a FocusListener from the Item. The listener will no longer receive notification if the Item gets a FocusEvent.

Parameters

• Libraries.Interface.Events.FocusListener

This action removes a GestureListener from the Item. The listener will no longer receive notification if the Item gets a GestureEvent.

Parameters

• Libraries.Interface.Events.GestureListener

This action removes a MouseListener from the Item. The listener will no longer receive notification if the Item gets a mouse click event.

Parameters

• Libraries.Interface.Events.MouseListener

This action removes a MouseMovementListener from the Item. The listener will no longer receive notification if the Item gets a mouse movement event.

Parameters

• Libraries.Interface.Events.MouseMovementListener

This action removes a MouseWheelListener from the Item. The listener will no longer receive notification if the Item gets a mouse wheel event.

Parameters

• Libraries.Interface.Events.MouseWheelListener

This action removes a TouchListener from the Item. The listener will no longer receive notification if the Item gets a TouchEvent.

Parameters

• Libraries.Interface.Events.TouchListener

This action sets the Z coordinate of the Item.

Parameters

• boolean flag

This action will rotate the Item3D about an axis represented by the given Vector3. The item will be rotated by an angle given in degrees. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be rotated.

Parameters

• Libraries.Compute.Vector3: The axis or ray to rotate around.
• number degrees: How many degrees to rotate (clockwise).
• boolean rotateChildren: Whether or not children should be rotated around the parent.

This action will rotate the Item3D about an axis represented by the given Vector3. The axis is essentially a ray that starts at the center of the item and points outward. The item will then rotate clockwise around that ray. The item will be rotated by an angle given in degrees. If the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• Libraries.Compute.Vector3: The axis or ray to rotate around.
• number degrees: How many degrees to rotate (clockwise).

This action will rotate the Item3D about an axis. The axis is essentially a ray that starts at the center of the item and points outward. The item will then rotate clockwise around that ray. The ray is defined using three numbers, representing which way it points on the x, y, and z planes, respectively. The item will be rotated by an angle given in degrees. If the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• number rotateX: The x component of the ray to rotate around.
• number rotateY: The y component of the ray to rotate around.
• number rotateZ: The z component of the ray to rotate around.
• number degrees: How many degrees to rotate (clockwise).

This action will rotate the Item3D about an axis represented by the first 3 given number values. The item will be rotated by an angle given in degrees. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be rotated.

Parameters

• number rotateX: The x component of the ray to rotate around.
• number rotateY: The y component of the ray to rotate around.
• number rotateZ: The z component of the ray to rotate around.
• number degrees: How many degrees to rotate (clockwise).
• boolean rotateChildren: Whether or not children should be rotated around the parent.

This action will rotate this Item3D clockwise about an axis passing through the given point. The direction of the axis is represented by the given Vector3 object. The children of this Item3D will also be rotated.

Parameters

• Libraries.Compute.Vector3: The point in space to rotate around.
• Libraries.Compute.Vector3: The axis that determines the direction to rotate in.
• number degrees: How many degrees to rotate (clockwise) around the axis.

This action will rotate this Item3D clockwise about an axis passing through the given point. The direction of the axis is represented by the given Vector3 object. The last parameter is a boolean that determines whether or not children should also be rotated - a value of true will rotate the children, a value of false will not. Note that the children will still maintain relative position to this item, regardless of the boolean passed.

Parameters

• Libraries.Compute.Vector3: The point in space to rotate around.
• Libraries.Compute.Vector3: The axis that determines the direction to rotate in.
• number degrees: How many degrees to rotate (clockwise) around the axis.
• boolean rotateChildren: Whether or not to also rotate this item's children.

This action will rotate all of the children of this Item3D clockwise about an axis passing through this item. The direction of the axis is represented by the given Vector3, and the children will be rotated by the given number of degrees.

Parameters

• number rotateX: The x component of the ray to rotate around.
• number rotateY: The y component of the ray to rotate around.
• number rotateZ: The z component of the ray to rotate around.
• number degrees: How many degrees to rotate (clockwise).

This action will rotate all of the children of this Item3D clockwise about an axis passing through this item. The direction of the axis is represented by the given Vector3, and the children will be rotated by the given number of degrees.

Parameters

• Libraries.Compute.Vector3: The axis or ray to rotate around.
• number degrees: How many degrees to rotate (clockwise).

Parameters

• number time

This action will scale the Item3D by the values of the given Vector3. If the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• Libraries.Compute.Vector3: A Vector3 object describing how much to scale the Item3D by along the x, y, and z axes.

This action will scale the Item3D by values of the given Vector3. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be scaled.

Parameters

• Libraries.Compute.Vector3: A Vector3 object describing how much to scale the Item3D by along the x, y, and z axes.
• boolean scaleChildren: Whether or not children objects should also be scaled.

This action will scale the Item3D by the given values. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be scaled.

Parameters

• number scaleX: How much to scale the Item3D along the x-axis.
• number scaleY: How much to scale the Item3D along the y-axis.
• number scaleZ: How much to scale the Item3D along the z-axis.
• boolean scaleChildren: Whether or not children objects should also be scaled.

This action will scale the Item3D by the given values. If the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• number scaleX: How much to scale the Item3D along the x-axis.
• number scaleY: How much to scale the Item3D along the y-axis.
• number scaleZ: How much to scale the Item3D along the z-axis.

This action sets whether or not this Item accepts mouse input. If set to true, this will intercept incoming mouse events, triggering any related MouseListeners and InputSets and preventing the mouse event from propagating to other Items on the Layer. The default value is true.

Parameters

• boolean accepts: True to set this Item to receive mouse events, or false to ignore them.

This action changes the accessibility code for this Item. This should be done with care because setting the accessiblity code to the incorrect type can cause accessibility to stop functioning or, in some cases, cause the program to crash.

Parameters

• integer newAccessibilityCode: the new accessibility code for this Item.

This action sets a custom accessibility role description for this item. This should only be done if there is not a standard accessibility code for the type of item being implemented. If the item behaves very similarly to a standard control type, then set the accessibility code to that standard type while also setting the role description. For example, if implementing an item that extends Control, is keyboard focusable, and responds to activation via both mouse clicks and the Space key, like a button, but it shouldn't be described as a button, then set the accessibility code to BUTTON and the custom role description to whatever is appropriate. If there isn't a suitable accessibility code, or if in doubt, set the accessibility code to CUSTOM.

Parameters

• text newRoleDescription: the new custom role description for this Item.

This action sets the depth the Item.

Parameters

• number angularDamping

This action sets the offsets of the item. The offsets tell the Item where to relate its position to. In other words, the offsets determine where each coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• Libraries.Compute.Vector3

Parameters

• Libraries.Game.Collision.PhysicsPosition3D

This action returns an Item3D that was previously added to this Item3D by finding it at the given index in the internal array of children Items.

Parameters

• boolean flag

Parameters

• boolean flag

This action lets the 3D collision solver actions (inside the class CollisionSolver3D) know that if this object needs its physics to be updated.

Parameters

• boolean flag: True if physics needs to be updated; false if physics doesn't need to be updated, which is when this object is a "unmovable" object in the physics space.

This action sets where in the "list of objects that needs to be updated because collision happened" that this object resides in. This "list of objects that needs to be updated because collision happened" is stored inside the CollisionSolver3D class as tempSolverBodyPool.

Parameters

• integer index: the index at which this object resides in in the tempSolverBodyPool.

This action sets a reference to the parent item. It is called automatically when an Item3D is added as a child to another Item3D. Most users will not need to use this action directly.

Parameters

• Libraries.Game.Collision.CollisionEdge3D

This action adds a different Item3D into this one. This makes a few things happen. 1. The added item will get this item as its parent. 2. The added item's x, y, and z coordinates will become relative to this Item. 3. Most actions on this Item will also affect the added Item.

Parameters

• Libraries.Game.Collision.PhysicsPosition3D

Parameters

• Libraries.Game.Collision.PhysicsPosition3D

This action sets the diffuse color of a primitive model. If the model did not previously have a color applied to it, it will add a color to it.

Parameters

• Libraries.Game.Graphics.Color

This action sets the depth the Item.

Parameters

• number setDepth: The new depth.

This action sets the internal description of the Item.

Parameters

• text newDescription

This action sets the width, height, and depth of the Item3D.

Parameters

• number setWidth: The new width.
• number setHeight: The new height.
• number setDepth: The new depth.

This action sets the width, height, and depth of the Item3D.

Parameters

• Libraries.Compute.Vector3: A vector containing the new width, height, and depth.

The SetFocusable action sets whether or not this Item should be focusable. If the Item is currently focused and made unfocusable, then it will lose focus, and there will be no focused element.

Parameters

• boolean focus

This action sets the Y offset of the item. The offset tells the Item where to relate its Y position to. In other words, the Y offset is where a Y coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• Libraries.Compute.Vector3

GetPosition will return a Vector3 object containing the X, Y, and Z coordinates of this Item3D object. Note that if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative coordinates, use the GetGlobalPosition() action instead.

Parameters

• number friction

Parameters

• boolean flag

This action sets the height of the Item.

Parameters

• number setHeight: The new height.

This action sets the input group for this Item. When used with the Game libraries, this tag describes what InputTable (if any) can interact with this Item due to input.

Parameters

• text group: The new input group to use.

Parameters

• Libraries.Compute.Vector3

Parameters

• Libraries.Compute.Vector3

This action copies the values of the provided Matrix4 into this item's rotation transform, effectively allowing you to copy rotations from one object to another.

Parameters

• Libraries.Game.Collision.PhysicsPosition3D

This action sets a value inside the internal item array of this Item3D.

Parameters

• integer index: The index to set within the children array.
• Libraries.Interface.Item3D: The item to store in the given index.

This action will return the global position of the Item3D as a Vector3. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Parameters

• Libraries.Game.Physics.Joints.JointEdge3D

This action is used by the Game libraries to create a reference to the layer that this Item3D exists on. It is automatically called as needed by the Layer3D class. Most users will never need to use this action directly.

Parameters

• Libraries.Game.Layer3D: The layer to keep a reference to.

This action sets the width, height, and depth of the Item3D.

Parameters

• number linearDamping

This action will return the global x coordinate of the Item3D. This is the item's position plus any offset applied by its relation to its parent (if it has one).

Parameters

• Libraries.Compute.Vector3

This action returns the Z offset of the item. The offset tells the Item where to relate its Z position to. In other words, the Z offset is where a Z coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• number linearVelocityX

This action returns the Y offset of the item. The offset tells the Item where to relate its Y position to. In other words, the Y offset is where a Y coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• number linearVelocityY

This action returns the X offset of the Item. The offset tells the Item where to relate its X position to. In other words, the X offset is where an X coordinate of 0 is for this Item. This is automatically set when using an action to add an Item to another Item.

Parameters

• number linearVelocityZ

GetDimensions will return a Vector3 object containing the width, height, and depth of this Item3D object.

Parameters

• number mass

This action sets the internal name of the Item.

Parameters

• text newName

This action sets the next focus item. When this Item has the focus and the user requests the focus to advance (e.g. by pressing the tab key), the focus will move to the next focus item, if it is defined.

Parameters

• Libraries.Interface.Item: The next Item to receive focus after this one.

This action sets the offsets of the item. The offsets tell the Item where to relate its position to. In other words, the offsets determine where each coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• Libraries.Compute.Vector3: A Vector3 containing the new x, y, and z offsets.

This action sets the offsets of the item. The offsets tell the Item where to relate its position to. In other words, the offsets determine where each coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• number xAmount: The new X offset.
• number yAmount: The new Y offset.
• number zAmount: The new Z offset.

This action sets the X offset of the Item. The offset tells the Item where to relate its X position to. In other words, the X offset is where an X coordinate of 0 is for this Item. This is automatically set when using an action to add an Item to another Item.

Parameters

• number xAmount: The new X offset.

This action sets the Y offset of the item. The offset tells the Item where to relate its Y position to. In other words, the Y offset is where a Y coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• number yAmount: The new Y offset.

This action sets the Z offset of the item. The offset tells the Item where to relate its Z position to. In other words, the Z offset is where a Z coordinate of 0 is for this item. This is automatically set when using an action to add an Item to another Item.

Parameters

• number zAmount: The new Z offset.

This action sets a reference to the parent item. It is called automatically when an Item3D is added as a child to another Item3D. Most users will not need to use this action directly.

Parameters

• Libraries.Interface.Item3D: The parent item.

Parameters

• Libraries.Game.Physics.PhysicsProperties3D

This action sets the x, y, and z coordinates of the Item3D.

Parameters

• Libraries.Compute.Vector3: The new position for this Item.

This action sets the x, y, and z coordinates of the Item3D.

Parameters

• number setX: The new x coordinate for this Item.
• number setY: The new y coordinate for this Item.
• number setZ: The new z coordinate for this Item.

This action sets the previous focus item. When this Item has the focus and the user requests the focus to move backwards (e.g. by pressing shift & tab), the focus will move to the previous focus item, if it is defined.

Parameters

• Libraries.Interface.Item: The previous Item to receive focus before this one.

Parameters

• text key
• Libraries.Data.Formats.JavaScriptObjectNotation

This action sets the width of the Item.

Parameters

• integer type

GetY will return the Y coordinate of this Item3D in 3D space. Note that if if this object has been added to an Item3D, then this coordinate is relative to the parent item - to get the non-relative Y coordinate, use the GetGlobalY() action instead.

Parameters

• number restitution

This action copies the values of the provided Matrix4 into this item's rotation transform, effectively allowing you to copy rotations from one object to another.

Parameters

• Libraries.Compute.Matrix4: The source rotation matrix to copy into this item.

This action will rotate the Item3D about an axis represented by the given Vector3. The axis is essentially a ray that starts at the center of the item and points outward. The item will then rotate clockwise around that ray. The item will be rotated by an angle given in degrees. If the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• number scaleX
• number scaleY
• number scaleZ

This action takes a MouseEvent and distributes it to any MouseListeners, MouseMovementListeners, and MouseWheelListeners that have been added to this Item3D. This action will also set the event to the "handled" state.

Parameters

• number scaleX
• number scaleY
• number scaleZ
• boolean scaleChildren

This action will scale the Item3D by the given values. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be scaled.

Parameters

• number scale

This action will scale the Item3D by the given values. If the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• number scale
• boolean scaleChildren

This action will rotate all of the children of this Item3D clockwise about an axis passing through this item. The direction of the axis is represented by the given Vector3, and the children will be rotated by the given number of degrees.

Parameters

• number scale
• boolean scaleChildren

This action will scale the Item3D by the values of the given Vector3. If the Item3D has any children items, they will also be scaled, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• number scale

This action will rotate the Item3D about an axis. The axis is essentially a ray that starts at the center of the item and points outward. The item will then rotate clockwise around that ray. The ray is defined using three numbers, representing which way it points on the x, y, and z planes, respectively. The item will be rotated by an angle given in degrees. If the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item.

Parameters

• number scale
• boolean scaleChildren

This action will rotate the Item3D about an axis represented by the first 3 given number values. The item will be rotated by an angle given in degrees. If the boolean parameter is set to true, and if the Item3D has any children items, they will also be rotated, and their offsets will be adjusted to maintain the same relative position to this item. If the boolean parameter is set to false, only this Item will be rotated.

Parameters

• number scale

GetRenderables is used to retrieve all of the individual renderable components of this Model. This action is used internally by the Game engine. Most users should never need to access this action directly.

Parameters

• Libraries.Language.Object

CalculateBoundingBox will create a new BoundingBox object that contains the bounds of the Model.

Parameters

• Libraries.Game.Graphics.Shaders.ShaderMapping

ExtendBoundingBox will expand the bounds of the given BoundingBox to fully encapsulate the bounds of this Model.

Parameters

• Libraries.Game.Graphics.Shaders.ShaderProgram

This action will find all of the Light objects contained in the children hierarchy of this Item3D and add it to the end of the given array. If this object is a Light, it will be added to the array first before adding any descendents where are Lights.

Parameters

• Libraries.Game.Collision.Shapes.CollisionShape3D

Parameters

• number time

matrix:row2column2 = tempMatrix:row2column2// * vector:GetZ()

Parameters

• number timeOfImpact

transform:Translate(vector:GetX(), vector:GetY(), vector:GetZ() * -1)

Parameters

• Libraries.Compute.Vector3

This action sets the width of the Item.

Parameters

• number setWidth: The new width.

This action sets the X coordinate of the Item.

Parameters

• number setX: The new x coordinate for this Item.

This action sets the Y coordinate of the Item.

Parameters

• number setY: The new y coordinate for this Item.

Vector3 localOffset = child:GetGlobalPosition()

Parameters

• number yaw
• number pitch
• number roll

This action sets the Z coordinate of the Item.

Parameters

• number setZ: The new z coordinate for this Item.

Parameters

• Libraries.Interface.Item3D

Return

boolean

This action is used to indicate that an Item and all Items that were added to it should be visible on the screen. Note that the Item class on its own cannot be drawn on the screen, but classes that inherit from it such as Libraries.Game.Graphics.Drawable can be. By default, Items are considered visible.

This action sets the X coordinate of the Item.

Parameters

• boolean flag

This action returns the current Layer3D that this Item3D is a part of in the Game libraries.

This action updates the item. It takes a number parameter that should indicate how many seconds have passed since the last time this action was called. This action does nothing in the Item class, but any class that inherits from Item may override it.

Parameters

• number secondsSinceUpdate: The number of seconds that have passed since the last time Update was called.

This action calls the Update action on this Item and all Items that have been added to this item with the Add action.

Parameters

• number secondsSinceUpdate: The number of seconds that have passed since the last time Update was called.