Libraries.Interface.Views.RadioButtonView

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

Parameters

• integer index
• Libraries.Interface.Item2D

This action adds a different Item2D 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 and y coordinates will become relative to this Item. 3. Most actions on this Item will also affect the added Item.

Parameters

• Libraries.Interface.Item2D

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 TextureLoadListener to the texture. If the texture finishes asynchronously loading an image, the listener will be alerted.

Parameters

• Libraries.Interface.Events.TextureLoadListener: A TextureLoadListener to be alerted when this texture finishes asynchronous loading.

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 is used to advance the item forward in time in physics space to synchronize it for time of impact solving. This action is used internally and users should not need to use this action. Attribute Parameter time The amount of seconds to advance the item forward in time

Parameters

• number time

This action applies an angular impulse to this item. The units are in kilogram units squared per second. This modifies the angular velocity of this item. Physics must be enabled on this item before using this action.

Parameters

• number impulse: The angular impulse in kilogram units squared per second

This action applies a force to this item at the passed point. The force is in kilogram units per second per second. The point is the screen coordinates where the point will be applied. If the point is not on the center of the item, then a torque will be introduced causing the item to rotate. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The force to apply to the item in kilogram units per second per second
• Libraries.Compute.Vector2: The point at which to apply the force

This action applies a force to this item at the center of the item. The force is in kilogram units per second per second. No torque is introduced to the item when using this action. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The force to apply to the item in kilogram units per second per second

This action applies a linear impulse to this item at the passed point. The impulse is in kilogram units per second. This immeadietly modifies the linear velocity of this item. The point is the screen coordinates where the impulse will be applied. If the point is not the center of the item, then the angular velocity of this item will also be modified. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The impulse to apply in kilogram units per second
• Libraries.Compute.Vector2: The point at which to apply the impulse

This action applies a torque to this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Parameters

• number torque: The torque to apply to this item in kilogram units squared per second per second

This action returns whether or not this Item is allowing its children to receive mouse events if the Item is custom drawing. If the Item isn't using custom drawing, this value is irrelevant -- children objects always receive mouse events before the parent if the parent isn't performing custom drawing.

Return

boolean:

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.

This action gets the position of the center of this item in global (world) coordinates.

Parameters

• boolean flag

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

This action sets the mass, mass moment of inertia, and how the 2D item should move (via linear velocity) to be at the desired location.

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.

This action computes the distance of the passed point from the collision shape attached to this item. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Compute.Vector2: The vector representing the point to compute the distance from
• integer childIndex: The index of the collision shape attached to this item we want the bounding box of
• Libraries.Compute.Vector2: The direction of the point from the shape

Return

number: The distance of the point from the collision shape of this item

This action tests if a point in global x,y coordinates is contained inside this Item2D. The global coordinates are considered to be the x and y coordinates of this Item plus its offsetX and offsetY values.

Parameters

• number containsX
• number containsY

Return

boolean: Whether or not the point is contained in this Item.

Return

Libraries.Interface.Views.ControlView

This action copies the information from a given TextureRegion at the given coordinates to the given width and height onto this TextureRegion.

Parameters

• Libraries.Game.Graphics.TextureRegion
• integer x
• integer y
• integer width
• integer height

This action copies the information from the given TextureRegion into this TextureRegion.

Parameters

• Libraries.Game.Graphics.TextureRegion

This action creates the nodes for this item for the broadphase collision. This action is needed in order to add the item to the collision detection system. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Collision.BroadphaseCollision2D: The broadphase to add this item to
• Libraries.Game.Collision.PhysicsPosition2D: The current position of the item in physics space

This action destroys the nodes for this item for the broadphase collision, essentially removing it from the collision detection system. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Collision.BroadphaseCollision2D: The broadphase to remove this item's nodes from

The Dispose action will dispose the currently loaded texture. This frees up computer resources, but the texture will no longer be usable. Note that multiple Drawables can use the same texture, and disposing of it will get rid of the texture information not just for this Drawable, but any Drawable that is using the texture. Dispose should be used when a texture will not be used again. Here are some guide lines for when you should or should not dispose a Drawable: 1. If the Drawable was loaded using Load(text) or Load(File), then the Drawable created new texture data when it was loaded. This can be safely disposed, unless you copied the Drawable, e.g. with Load(Drawable). 2. If the Drawable was loaded as a shape, e.g. with the LoadRectangle action, the Drawable created new texture data when it loaded. It can be safely disposed, unless you copied the Drawable, e.g. with Load(Drawable). 3. If the Drawable was loaded using a Texture or a TextureRegion, such as with the Load(Texture) action, then it is NOT safe to dispose this if there are any other Drawables that are still in use which were also loaded with the same Texture. If there are no other Drawables that were loaded with the Texture, it is safe to dispose. If a texture was used to load multiple Drawables, it is good practice to use the Dispose action directly from the Texture once all of the Drawables are no longer in use. 4. If the Drawable was loaded with an ImageSheet, you should NEVER dispose the Drawable's texture. All Drawables loaded from an ImageSheet use the same Texture data, so disposing of any Drawable from an ImageSheet will delete the ImageSheet's texture data. If you ever wish to dispose an ImageSheet's texture data, it is good practice to use the ImageSheet's Dispose action.

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 used to perform custom drawing on this Item and its children. This is only called during the Game engine's draw phase if this Item has enabled custom drawing via the SetCustomDrawing action. This is an advanced feature, and shouldn't be used by most users. If custom drawing is enabled, this action should be overriden -- if it isn't, the Item will attempt to provide default rendering for itself, its view, and its children, without regard to depth buffering. This action is responsible for instructing the provided Painter on how to draw this item, the view, and its children, and in what order to do so.

Parameters

• Libraries.Game.Graphics.Painter2D

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 removes all TextureLoadListeners that have been added to the texture.

This action enables physics for this item. Passing true turns on physics for this item while passing false turns off physics for this item.

Parameters

• boolean flag: Whether or not to enable physics for this item

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.

This action gets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

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 flips the Drawable along the x-axis, or in other words, flips it horizontally in 2D space.

This action flips the Drawable along the y-axis, or in other words, flips it vertically in 2D space.

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 Item2D. An Item2D gets a parent when it is added to another Item using the Add action.

Return

Libraries.Interface.Item:

This action gets the inverse inertia of this item (i.e., one divided by the inertia of this item). Physics must be enabled on this item before using this action.

Return

number: The inverse inertia of this item

This action gets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Return

number: The angular velocity of this item in radians per second

This action returns where the TextureRegion begins the bottom edge of its region on the stored texture, where 0 is the far bottom of the texture and 1 is the far top side of the texture.

Return

number:

This action is used to get the bounding box of the item. A bounding box is an axis-alligned rectangle containing the shape used for broadphase collision. This action is used internally and users should not need to use this action.

Parameters

• integer childIndex: The index of the collision shape attached to this item we want the bounding box of

Return

Libraries.Game.Collision.BoundingBox2D: The bounding box of the collision shape attached to this item

This action returns a rectangle that fully encloses the four corners of the Item as it is represented by its internal vertices array. Note that the rectangle produced by this action will be larger than the actual box formed by this Item's vertices if the Item is rotated.

Return

Libraries.Game.Shapes.Rectangle:

This action returns the x coordinate of the center of this Item2D.

Return

number:

This action returns the y coordinate of the center of this Item2D.

Return

number:

This action gets the children of this item in an array.

Return

Libraries.Containers.Array: The children of this item in an array

This action gets the clipping coordinates of this Item2D. The coordinates are returned via the two provided Vector2 parameters, the first vector storing the x values of the left and right sides of the clipping coordinates and the second vector storing the y values of the bottom and top sides. The returned boolean value indicates if this Item uses these clipping coordinates (i.e. if this Item or one of its parent Items has clipping enabled). If the clipping is valid, the action returns true. Otherwise, it returns false.

Parameters

• Libraries.Compute.Vector2
• Libraries.Compute.Vector2

Return

boolean:

This action gets the total force on this item. The units are kilogram units per second per second. Physics must be enabled on this item before using this action.

Return

boolean: The total force in kilogram units per second per second

This action gets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Return

integer: The angular velocity of this item in radians per second

This is an action used internally to retrieve the head of the linked list of collisions with this item. This action is used internally and users should not need to use this action.

Return

Libraries.Game.Collision.CollisionEdge2D: The head of the doubly linked list of collisions

This action returns the color filter stored in the Drawable. To see if it's currently in use, use the UsingCustomColor action. If the Drawable is using a different type of filter (such as a Gradient) this will return undefined. To get whatever filter the Drawable is using regardless of type, use the GetColorGroup action.

Return

Libraries.Game.Graphics.Color:

This action returns the color filter stored in the Drawable. The returned value is a ColorGroup object, which describes how the color is mapped to the four corners of the Drawable. If no filter is in use, this action will return undefined.

Return

Libraries.Game.Graphics.ColorGroup:

This action applies a linear impulse to this item at the passed point. The impulse is in kilogram units per second. This immeadietly modifies the linear velocity of this item. The point is the screen coordinates where the impulse will be applied. If the point is not the center of the item, then the angular velocity of this item will also be modified. Physics must be enabled on this item before using this action.

Return

number:

This action returns the current internal description of the Item.

Return

text:

This action will create a new Texture with a solid rectangle of the given color with the given width and height. This texture is then loaded into the Drawable.

Return

Libraries.Game.Graphics.DrawableShape:

This action returns an integer code representing the type of graphics that's been loaded into this Drawable. The type values can be found in the SceneProperties class. The default value is NONE.

Return

integer: An integer code from the SceneProperties class that describes the type of image this Drawable uses.

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 gets the total force on this item. The units are kilogram units per second per second. Physics must be enabled on this item before using this action.

Return

Libraries.Compute.Vector2: The total force in kilogram units per second per second

This action applies a force to this item at the center of the item. The force is in kilogram units per second per second. No torque is introduced to the item when using this action. Physics must be enabled on this item before using this action.

Return

number:

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 returns the Item's global x coordinate. This is the actual world coordinate that the item exists at after it has been offset by its parent's position. If this Item doesn't have a parent, and the offset hasn't been set manually, this is the same as GetX().

Return

number:

This action returns the Item's global y coordinate. This is the actual world coordinate that the item exists at after it has been offset by its parent's position. If this Item doesn't have a parent, and the offset hasn't been set manually, this is the same as GetY().

Return

number:

This action returns the Item's global z value. For an Item2D, this simply returns the Item2D's current z value.

Return

number:

This action returns the gradient stored in the Drawable. To see if it's currently in use, use the UsingCustomGradient action. If the Drawable is using a different type of filter (such as a Color) this will return undefined. To get whatever filter the Drawable is using regardless of type, use the GetColorGroup action.

Return

Libraries.Game.Graphics.Gradient:

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

This action will return the currently set height of the Item2D.

Return

number:

This action is used internally by the rendering system to determine how many indices a Drawable uses in a Mesh. Most users will never need to call this action directly.

Return

integer:

This action gets the rotational inertia of this item. The inertia is in kilogram units squared.

Return

number: The inertia of this item in kilogram units squared

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:

This action gets the inverse inertia of this item (i.e., one divided by the inertia of this item). Physics must be enabled on this item before using this action.

Return

number: The inverse inertia of this item

This action gets the inverse mass of the item (i.e., one divided by the mass of this item). Physics must be enabled on this item before using this action.

Return

number: The inverse mass of this item

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

Parameters

• integer index

Return

Libraries.Interface.Item2D:

Return

Libraries.Interface.Item2D

This action searches through all Items stored in this Item2D and finds the deepest Item which contains the given point in global coordinates.

Parameters

• number x
• number y

Return

Libraries.Interface.Item2D: The deepest item in the children hierarchy at the given point.

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

Return

integer:

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

Return

Libraries.Containers.Iterator:

This is an action used internally to retrieve the head of the liked list of joints connected to this item. This action is used internally and users should not need to use this action.

Return

Libraries.Game.Physics.Joints.JointEdge2D: The head of the linked list of connected joints

This action returns the current Layer2Dthat this Item2D is a part of in the Game libraries.

Return

Libraries.Game.Layer2D:

This action returns where the TextureRegion begins the left edge of its region on the stored texture, where 0 is the far left of the texture and 1 is the far right side of the texture.

Return

number:

Given the local coordinates of a vector, this action computes the screen coordinates of the corresponding vector.

Return

number: The coordinates of the corresponding global vector Attribute Example use Libraries.Interface.Item2D use Libraries.Compute.Vector2 Item2D item Vector2 localVector item:SetWidth(100) item:SetHeight(100) item:SetPosition(400, 250) localVector:Set(0, 0) // Get the coordinates of the center of the item Vector2 worldVector = item:GetWorldVector(localVector)

This action gets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Return

Libraries.Compute.Vector2: The vector representing the linear velocity of this item in units per second

Given a global point (i.e., the screen coordinates of the point), this action computes the corresponding point relative to the center of this item.

Parameters

• Libraries.Compute.Vector2

Return

Libraries.Compute.Vector2: The coordinates of the point relative to the center of this item

Given the screen coordinates of a vector, this action computes the local coordinates of the vector (i.e., the coordinates of the vector relative to the center of this item)

Parameters

• Libraries.Compute.Vector2

Return

Libraries.Compute.Vector2: The local coordinates of the corresponding vector

This action gets the position of the center of this item in local coordinates (i.e., with respect to itself).

Return

Libraries.Compute.Vector2: The vector representing the center of this item in local coordinates

Given a global point (i.e., the screen coordinates of the point), this action computes the corresponding point relative to the center of this item.

Parameters

• Libraries.Compute.Vector2: The screen coordinates of the point to compute

Return

Libraries.Compute.Vector2: The coordinates of the point relative to the center of this item

Given the screen coordinates of a vector, this action computes the local coordinates of the vector (i.e., the coordinates of the vector relative to the center of this item)

Parameters

• Libraries.Compute.Vector2: The screen coordinates of the vector

Return

Libraries.Compute.Vector2: The local coordinates of the corresponding vector

This action returns the mass of the item in kilograms. Physics must be enabled on this item before using this action. If the item is non-responsive or unmovable, the mass is zero.

Return

number: The mass in kilograms

This action is used to advance the item forward in time in physics space to synchronize it for time of impact solving. This action is used internally and users should not need to use this action. Attribute Parameter time The amount of seconds to advance the item forward in time

Parameters

• Libraries.Game.Physics.Mass2D

This action will create a new Texture with a solid black circle with the given radius. This texture is then loaded into the Drawable.

Return

Libraries.Game.Graphics.Mesh:

This action is used internally by the rendering system to determine what index a Drawable starts at in a Mesh. Most users will never need to call this action directly.

Return

integer:

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 gets the number of broadphase nodes this item has. This action is used internally and users should not need to use this action.

Return

integer: The number of broadphase nodes attached to this item

This action returns all of the broadphase nodes attached to this item in an array. This action is used internally and users should not need to use this action.

Return

Libraries.Containers.Array: The broadphase nodes attached to this item in an array

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:

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:

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:

This action will return the current X origin of this Item2D. By default, the origin is at the coordinates 0, 0.

Return

number:

This action will return the current Y origin of this Item2D. By default, the origin is at the coordinates 0, 0.

Return

number:

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

Return

Libraries.Interface.Item2D:

This action computes the distance of the passed point from the collision shape attached to this item. This action is used internally and users should not need to use this action.

Return

Libraries.Game.Physics.PhysicsProperties2D: The distance of the point from the collision shape of this item

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

This action is used to update this items position in physics space after physics solving is finished for this item. This action is used internally and users should not need to use this action.

Return

number:

This action returns the height of the region.

Return

integer:

This action returns the width of the TextureRegion.

Return

integer:

This action returns the x coordinate where the region begins on the Texture.

Return

integer:

This action returns the y coordinate where the region begins on the Texture.

Return

integer:

This action gets the inverse mass of the item (i.e., one divided by the mass of this item). Physics must be enabled on this item before using this action.

Return

integer: The inverse mass of this item

This action gets the total torque on this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Return

number: The total torque in kilogram units squared per second per second

This action returns where the TextureRegion begins the right edge of its region on the stored texture, where 0 is the far left of the texture and 1 is the far right side of the texture.

Return

number:

Gets the current degree of rotation of this Item.

Return

number:

Gets the current rotation of this Item in radians.

Return

number:

This action will return the current x-scaling value of this Item2D. By default, the x-scaling value of an Item is 1.

Return

number:

This action will return the current y-scaling value of this Item2D. By default, the y-scaling value of an Item is 1.

Return

number:

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:

This action will create a new Texture with a solid black triangle that is made of the points identified by the three given points. The three points are relative to the origin of the Drawable. This texture is then loaded into the Drawable.

Return

Libraries.Language.Object:

Return

Libraries.Game.Graphics.Shaders.ShaderMapping:

Return

Libraries.Game.Graphics.Shaders.ShaderProgram:

This item returns the collision shape of this item. The collision shape is the shape the collision system will use to test for collisions with this item. Note that this may be different from the shape drawn on the screen.

Return

Libraries.Game.Collision.Shapes.CollisionShape2D: The collision shape for this item

This action returns an integer representing the type of collision shape currently attached to this item.

Return

integer: The integer representing the type of collision shape for this item

This action gets the children of this item in an array.

Return

number: The children of this item in an array

This action returns the swept movement of this item used for time of impact solving for the physics system. This action is used internally and users should not need to call this action.

Return

Libraries.Game.Collision.Sweep2D: The swept motion of this item

Return

text

This action returns the texture that is currently loaded into the Drawable.

Return

Libraries.Game.Graphics.Texture:

This action returns the texture held by this TextureRegion.

Return

Libraries.Game.Graphics.Texture:

Return

boolean

This action returns where the TextureRegion begins the top edge of its region on the stored texture, where 0 is the far bottom of the texture and 1 is the far top side of the texture.

Return

number:

This action gets the total torque on this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Return

number: The total torque in kilogram units squared per second per second

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 returns the position of the item in physical space. This acction is used internally and should not be used by users to get the position of this item on the screen.

Return

Libraries.Game.Collision.PhysicsPosition2D: The position and angle of this item in physics space

This action gets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action

Return

Libraries.Game.Collision.PhysicsPosition2D: The position and angle of the item in physics space in the previous frame

The SetClipping action is used to enable or disable clipping. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

Return

Libraries.Interface.Views.View2D:

This action searches through all Items stored in this Item2D and finds the deepest Item which contains the given point in global coordinates. This action will only return items which are visible (that is, IsShowing() returns true).

Parameters

• number x
• number y

Return

Libraries.Interface.Item2D: The deepest visible item in the children hierarchy at the given point.

This action will return the currently set width of the Item2D.

Return

number:

This action gets the position of the center of this item in global (world) coordinates.

Return

Libraries.Compute.Vector2: The vector representing the center of this item in global coordinates

Given a point relative to the center of this item, this action computes and returns that point in screen coordinates.

Parameters

• Libraries.Compute.Vector2: The point in coordinates with respect to the center of this item

Return

Libraries.Compute.Vector2: The screen coordinates of the passed local point

Given the local coordinates of a vector, this action computes the screen coordinates of the corresponding vector.

Parameters

• Libraries.Compute.Vector2: The coordinates of a local vector

Return

Libraries.Compute.Vector2: The coordinates of the corresponding global vector Attribute Example use Libraries.Interface.Item2D use Libraries.Compute.Vector2 Item2D item Vector2 localVector item:SetWidth(100) item:SetHeight(100) item:SetPosition(400, 250) localVector:Set(0, 0) // Get the coordinates of the center of the item Vector2 worldVector = item:GetWorldVector(localVector)

This action returns the currently set X coordinate of the Item.

Return

number:

This action returns the currently set Y coordinate of the Item.

Return

number:

This action returns the currently set Z value of this Item2D.

Return

number:

This action returns an integer representing the type of collision shape currently attached to this item.

Return

boolean: The integer representing the type of collision shape for this item

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.

The Initialize action prepares the view for use. It must be called before the view can be used, or else nothing will be drawn while using the view.

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:

The IsClipping action returns true if pixel clipping is enabled, or false if it is disabled. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

Return

boolean: Whether or not pixel clipping is enabled for this Item.

This action determines whether this item is collidable.

Return

boolean: True if this item is collidable, false otherwise

The IsCustomDrawing action returns whether or not this Item is directly managing how itself and its children are drawn. When this value is true, the Item is responsible for determining its rendering via the Draw(Painter2D) action -- if this action isn't overridden, the Item and its children won't be drawn. This is an advanced feature only necessary for complex custom components, and most users will not need to use this functionality.

Return

boolean: Whether or not this Item is currently using custom drawing rules.

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

Return

boolean:

This action sets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Return

boolean:

This action will return true if the Drawable has been flipped across the x-axis, or false if it has not.

Return

boolean:

This action will return true if the Drawable has been flipped across the y-axis, or false if it has not.

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:

This action returns true if there is a texture currently loaded into the Drawable, otherwise it returns false.

Return

boolean:

This action gets the number of broadphase nodes this item has. This action is used internally and users should not need to use this action.

Return

boolean: The number of broadphase nodes attached to this item

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 determines whether physics is currently enabled for this item.

Return

boolean: True if physics is enabled for this item, false otherwise

Return

boolean

This action sets this item to be collidable. Passing true turns on collision for this item while passing false turns off collision for this item.

Return

boolean:

This action determines whether physics is currently enabled for this item.

Return

boolean: True if physics is enabled for this item, false otherwise

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.

This action gets the position of the center of this item in local coordinates (i.e., with respect to itself).

Return

boolean: The vector representing the center of this item in local coordinates

This action sets the x-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Return

boolean:

This action creates the nodes for this item for the broadphase collision. This action is needed in order to add the item to the collision detection system. This action is used internally and users should not need to use this action.

Return

boolean:

This action will load the given TextureRegion into this Drawable, loading from the given x,y coordinates of the texture to the given width and height.

Parameters

• Libraries.Game.Graphics.TextureRegion
• integer sourceX
• integer sourceY
• integer sourceWidth
• integer sourceHeight

This action will load the given TextureRegion into this Drawable, which will set its appearance when drawn on screen.

Parameters

• Libraries.Game.Graphics.TextureRegion

This action will create a new texture from the image file located at the given file path. This texture will then be loaded into this Drawable. This sets the Drawable's appearance when it is drawn on the screen.

Parameters

• text filePath

This action will load a matrix into a Texture to create a monochrome (black and white) image, then load the Texture into this Drawable. Each value is assumed to be between 0 and 1, where 0 represents a black pixel and 1 represents a white pixel.

Parameters

• Libraries.Compute.Matrix: The matrix representing the pixels to load.

This action will load the given texture into this Drawable, loading from the lower left corner of the texture to the given width and height.

Parameters

• Libraries.Game.Graphics.Texture
• integer sourceWidth
• integer sourceHeight

This action will load the given texture into this Drawable, loading from the given x,y coordinates of the texture to the given width and height.

Parameters

• Libraries.Game.Graphics.Texture
• integer sourceX
• integer sourceY
• integer sourceWidth
• integer sourceHeight

This action will create a new texture from provided image file. This texture will then be loaded into this Drawable. This sets the Drawable's appearance when it is drawn on the screen.

Parameters

• Libraries.System.File

This action will load the given texture into this Drawable. This sets the Drawable's appearance when it is drawn on the screen.

Parameters

• Libraries.Game.Graphics.Texture

This action will create a new Texture with a hollow circle of the given color with the given radius. This texture is then loaded into the Drawable.

Parameters

• integer radius
• Libraries.Game.Graphics.ColorGroup

This action will create a new Texture with a hollow black circle with the given radius. This texture is then loaded into the Drawable.

Parameters

• integer radius

This action will create a new Texture with a solid black circle with the given radius. This texture is then loaded into the Drawable.

Parameters

• integer radius

This action will create a new Texture with a solid circle of the given color with the given radius. This texture is then loaded into the Drawable.

Parameters

• integer radius
• Libraries.Game.Graphics.ColorGroup

This action will create a new Texture with a solid black rectangle with the given width and height. This texture is then loaded into the Drawable.

Parameters

• integer width
• integer height

This action will create a new Texture with a solid rectangle of the given color with the given width and height. This texture is then loaded into the Drawable.

Parameters

• integer width
• integer height
• Libraries.Game.Graphics.ColorGroup

This action will create a new Texture with a solid black triangle that is made of the points identified by the three given points. The three points are relative to the origin of the Drawable. This texture is then loaded into the Drawable.

Parameters

• integer x1
• integer y1
• integer x2
• integer y2
• integer x3
• integer y3

This action will create a new Texture with a solid triangle of the given color that is made of the points identified by the three given points. The three points are relative to the origin of the Drawable. This texture is then loaded into the Drawable.

Parameters

• integer x1
• integer y1
• integer x2
• integer y2
• integer x3
• integer y3
• Libraries.Game.Graphics.ColorGroup

This action will create a new Texture with a black line that connects an imaginary point at 0,0 to the provided x,y coordinates. This texture is then loaded into the Drawable.

Parameters

• integer x
• integer y

This action will create a new Texture with a line of the given color that connects between an imaginary point at 0,0 to the provided x,y coordinates. This texture is then loaded into the Drawable.

Parameters

• integer x
• integer y
• Libraries.Game.Graphics.ColorGroup

This action will create a new Texture with a hollow black rectangle with the given width and height. This texture is then loaded into the Drawable.

Parameters

• integer width
• integer height

This action will create a new Texture with a hollow rectangle of the given color with the given width and height. This texture is then loaded into the Drawable.

Parameters

• integer width
• integer height
• Libraries.Game.Graphics.ColorGroup

Parameters

• Libraries.Containers.Array

Parameters

• Libraries.Containers.Array
• Libraries.Game.Graphics.ColorGroup

Parameters

• Libraries.Containers.Array
• Libraries.Containers.Array

This action loads an entire texture into the TextureRegion.

Parameters

• Libraries.Game.Graphics.Texture

This action loads part of a texture into this TextureRegion, starting from the given x,y coordinates of the Texture to the given width and height.

Parameters

• Libraries.Game.Graphics.Texture
• integer x
• integer y
• integer width
• integer height

This action loads part of a texture into the TextureRegion, starting from the bottom left corner to the given width and height.

Parameters

• Libraries.Game.Graphics.Texture
• integer width
• integer height

This action loads part of a texture into this TextureRegion, using the given percentage coordinates from 0 to 1 of the texture to load.

Parameters

• Libraries.Game.Graphics.Texture
• number left
• number right
• number top
• number bottom

This action is fired if the item lost the focus.

Parameters

• Libraries.Interface.Events.FocusEvent

This action will increase the x and y coordinates of this Item by the values stored in the provided Vector2.

Parameters

• Libraries.Compute.Vector2

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

Parameters

• number xAmount
• number yAmount

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

Parameters

• number xAmount

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

Parameters

• number yAmount

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

Parameters

• number zAmount

This action removes all TextureLoadListeners that have been added to the texture.

Parameters

• Libraries.Interface.Events.TextureLoadEvent

Checks to see if the Item2D's internal vertices are up to date, and updates them if they are not. This is used primarily internally to ensure that the item's vertices are properly aligned before use, e.g. to project an image on the screen at the coordinates of the vertices. Most users will never need to use this action directly.

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 mouse event and handles it. It will first test to see if the mouse event took place within the bounds of this Item. If so, it will notify any MouseListeners of the event. If the event was not contained within this Item, or if there are no MouseListeners on this Item, the Item will ask its parent Item to process the mouse event, if there is a parent.

Parameters

• Libraries.Interface.Events.MouseEvent

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

Parameters

• Libraries.Interface.Events.TouchEvent

Parameters

• Libraries.Game.Graphics.Painter2D

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

Return

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

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

Parameters

• Libraries.Interface.Item2D

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 TextureLoadListener from the texture. If the listener was not previously added to this texture, this does nothing.

Parameters

• Libraries.Interface.Events.TextureLoadListener: A TextureLoadListener to be removed from the Texture.

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 informs the engine that this Item needs to recalculate its vertex values before they can be used (most commonly, to be drawn to the screen). Most users will never need to call this directly. If you are using a custom ShaderProgram with this Item, you can use this action to indicate that the shader mapping should reset the vertex values for this Item before its drawn again.

This action sets the y-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Parameters

• boolean flag

This action sets the mass, mass moment of inertia, and how the 2D item should move (via linear velocity) to be at the desired location.

The Resize action is used to recalculate the size and position of Controls that are being controlled by a Layout. Calling Resize on an Item2D won't have a direct effect on it, but if the Item's children hierarchy contains any Controls, those Controls will be resized.

Rotates this Item2D by the given number of degrees. This will also rotate all Items in the children hierarchy of this Item.

Parameters

• number degrees

This action will multiply the current scaling value by the given number. A parameter of 0 or less will be ignored.

Parameters

• number amount

This action will multiply the x scaling and y scaling values, respectively, by the given numbers. A parameter of 0 or less will be ignored.

Parameters

• number xAmount
• number yAmount

This action will multiply the current scaling value by the given number. A parameter of 0 or less will be ignored. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Parameters

• number amount

This action will multiply the current scaling values of the x and y planes by the given number. A parameter of 0 or less will be ignored. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Parameters

• number xAmount
• number yAmount

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.

Sets the alpha of the Drawable. The alpha represents how transparent the Drawable is. The given value should be between 0 and 1, where a value of 0 is totally transparent, and a value of 1 is totally opaque.

Parameters

• number alpha

This action gets the rotational inertia of this item. The inertia is in kilogram units squared.

Parameters

• number angularDamping

This action sets this item's angular velocity in radians per second. Physics must be enabled in this item before using this action.

Parameters

• number angularVelocity: The angular velocity of this item in radians per second

This action selects a point on the loaded texture that this Drawable will consider to be the bottom edge of the image to be drawn. 0 represents the bottom edge of the base texture, and 1 represents the top edge of the base texture.

Parameters

• number bottom

This action will set the x coordinate, y coordinate, width, and height of the Item2D, respectively.

Parameters

• number newX
• number newY
• number newWidth
• number newHeight

This action will set the X and Y coordinates of the Item so that the center of the Item is located at the given X, Y coordinates.

Parameters

• number setX
• number setY

This action will set the X coordinate of the Item so that the center of the Item is aligned with the given X coordinate value.

Parameters

• number setX

This action will set the Y coordinate of the Item so that the center of the Item is aligned with the given Y coordinate value.

Parameters

• number setY

The SetChildrenProcessingMouseEvents action is used to set whether or not children items should receive mouse events if this Item is using custom drawing. This affects only custom drawing Items -- if the Item isn't drawing, children objects will always receive the mouse events first. This value is false by default. This is an advanced feature only necessary for complex custom components, and most users will not need to use this.

Parameters

• boolean shouldProcess

This action sets the clipping coordinates of the given painter to respect the coordinates of this Item (if it's clipping) as well as any clipping being performed by parent Items. This action is called automatically by the Game engine as necessary, and most users will never need to use this action directly.

Parameters

• Libraries.Game.Graphics.Painter2D

The SetClipping action is used to enable or disable clipping. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

Parameters

• boolean clip: True to enable pixel clipping, false to disable.

This action sets this item to be collidable. Passing true turns on collision for this item while passing false turns off collision for this item.

Parameters

• boolean flag: Whether or not to turn collision on for this item

This action gets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action

Parameters

• boolean flag

This action sets the total torque on this item. The units are kilogram units squared per second per second. This action should be used to set the total torque on this item. If we want to apply a torque to this item, we should use the ApplyTorque actions instead. Physics must be enabled on this action before using this action.

Parameters

• boolean flag

This action sets the total force on this item. The units are kilogram units per second per second. This action should be used to set the total force on this item. If we want to apply a force to this item, we should use the ApplyForce actions instead. Physics must be enabled on this item before using this action.

Parameters

• integer index

This is an action used internally by the physics system to keep track of the collisions with this item in a linked list structure. This action sets the head of the linked list of collisions to the passed CollisionEdge2D object. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Collision.CollisionEdge2D: The new head of the linked list of collisions

Sets the color filter on this Drawable. This will reduce the intensity of colors in the Drawable that are not part of the filter, while leaving the other colors that are part of the filter as the same.

Parameters

• Libraries.Game.Graphics.ColorGroup

Sets the color filter of the Drawable from the given components of red, green, blue, and alpha. The values for the components should be between 0 and 1, representing 0% to 100% of that color or alpha.

Parameters

• number red
• number green
• number blue
• number alpha

The SetCustomDrawing action is used to indicate that this Item wants to directly manage how itself and its children are drawn. When this is set to true, the Item must be responsible for determining this rendering via the Draw(Painter2D) action -- if this action isn't overridden, the Item and its children won't be drawn. This is an advanced feature only necessary for complex custom components, and most users will not need to use this functionality.

Parameters

• boolean isCustom: True if this Item should use custom drawing, or false to use default drawing rules.

This action applies an angular impulse to this item. The units are in kilogram units squared per second. This modifies the angular velocity of this item. Physics must be enabled on this item before using this action.

Parameters

• number density

This action sets the internal description of the Item.

Parameters

• text newDescription

This action will create a new Texture with a hollow black circle with the given radius. This texture is then loaded into the Drawable.

Parameters

• Libraries.Game.Graphics.DrawableShape

This action sets an integer code representing the type of graphics that's been loaded into this Drawable. The type values can be found in the SceneProperties class. This action is used internally by the engine as needed, and most users won't ever need to call this directly.

Parameters

• integer type

This action will set the Item2D to be flipped across the X-axis according to the boolean. If the boolean value is false, the Item2D will be set to its unflipped state. If it is true, the Item will be set to its flipped state.

Parameters

• boolean flip

This action will set the Item2D to be flipped across the Y-axis according to the boolean. If the boolean value is false, the Item2D will be set to its unflipped state. If it is true, the Item will be set to its flipped state.

Parameters

• boolean flip

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 total force on this item. The units are kilogram units per second per second. This action should be used to set the total force on this item. If we want to apply a force to this item, we should use the ApplyForce actions instead. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The total force in kilogram units per second per second

This action applies a torque to this item. The units are kilogram units squared per second per second. Physics must be enabled on this item before using this action.

Parameters

• number friction

This action returns the swept movement of this item used for time of impact solving for the physics system. This action is used internally and users should not need to call this action.

Parameters

• boolean flag

This action will set the height of the Item2D.

Parameters

• number newHeight

This action is used internally by the rendering system to set how many indices a Drawable uses in a Mesh. Most users will never need to call this action directly.

Parameters

• integer indicesCount

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.

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

Parameters

• integer index
• Libraries.Interface.Item2D

Parameters

• Libraries.Interface.Item2D

This is an action used internally by the physics system to keep track of the joints connected to this item in a linked list structure. This action sets the head of the linked list of collisions to the passed CollisionEdge2D object. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Physics.Joints.JointEdge2D

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

Parameters

• Libraries.Game.Layer2D

This action selects a point on the loaded texture that this Drawable will consider to be the left edge of the image to be drawn. 0 represents the left edge of the base texture, and 1 represents the right edge of the base texture.

Parameters

• number left

Given a point relative to the center of this item, this action computes and returns that point in screen coordinates.

Parameters

• number linearDamping

This action sets the linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Parameters

• Libraries.Compute.Vector2: The vector representing the linear velocity of this item in units per second

This action sets the x-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Parameters

• number linearVelocityX: The x-component of this item's linear velocity in units per second

This action sets the y-component of this item's linear velocity in units per second. Physics must be enabled on this item before using this action.

Parameters

• number linearVelocityY: The y-component of this item's linear velocity in units per second

This action is used to syncronize the item's position in physics space with its position in the tree used for broadphase collision. This action is used internally and users should not need to use this action.

Parameters

• number mass

This action sets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Physics.Mass2D

This action will create a new Texture with a hollow circle of the given color with the given radius. This texture is then loaded into the Drawable.

Parameters

• Libraries.Game.Graphics.Mesh

This action is used internally by the rendering system to set what index a Drawable starts at in a Mesh. Most users will never need to call this action directly.

Parameters

• integer meshIndex

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 returns all of the broadphase nodes attached to this item in an array. This action is used internally and users should not need to use this action.

This action will set both the X and Y offsets of the item, respectively.

Parameters

• number xAmount
• number yAmount

This action will set X, Y, and Z offsets of the item, respectively.

Parameters

• number xAmount
• number yAmount
• number zAmount

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

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

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

This action will set the origin of the Item to be at the given location in the Item. This is used when projecting the Item's vertices onto the screen, i.e. when determining where to draw a picture on the screen.

Parameters

• number setX
• number setY

This action will set the origin of the Item to be at the current center of the Item's width and height bounds.

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

Parameters

• Libraries.Interface.Item2D

This action is used to get the bounding box of the item. A bounding box is an axis-alligned rectangle containing the shape used for broadphase collision. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Physics.PhysicsProperties2D

This action will set both the X coordinate and the Y coordinate of the Item, in that order.

Parameters

• number setX
• number setY

This action will set both the X and Y coordinates of this Item2D, and will additionally set the Z value of this Item2D.

Parameters

• number setX
• number setY
• number setZ

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

Sets the region of this TextureRegion to start at the given x,y coordinates and go to the given width and height.

Parameters

• integer x
• integer y
• integer width
• integer height

Sets the region of this TextureRegion to be the same as the region of a different TextureRegion.

Parameters

• Libraries.Game.Graphics.TextureRegion

This action selects the portion of the loaded texture to use when drawing. The four parameters represent the left, top, right, and bottom sides of the texture, respectively. For the left and right parameters, 0 represents the left of the base texture, and 1 represents the right of the base texture. For the top and bottom parameters, 0 represents the bottom, and 1 represents the top.

Parameters

• number left
• number top
• number right
• number bottom

Sets the region of this TextureRegion to begin at the start of the given TextureRegion's plus an offset by the given x,y values, and stretching to the given width and height.

Parameters

• Libraries.Game.Graphics.TextureRegion
• integer x
• integer y
• integer width
• integer height

This action sets the height of the region.

Parameters

• integer height

This action sets the width of the TextureRegion.

Parameters

• integer width

This action sets the x coordinate where the region begins on the Texture.

Parameters

• integer x

This action sets the y coordinate where the region begins on the Texture.

Parameters

• integer y

This action determines whether this item is collidable.

This action returns the mass of the item in kilograms. Physics must be enabled on this item before using this action. If the item is non-responsive or unmovable, the mass is zero.

Parameters

• integer type

This action applies a force to this item at the passed point. The force is in kilogram units per second per second. The point is the screen coordinates where the point will be applied. If the point is not on the center of the item, then a torque will be introduced causing the item to rotate. Physics must be enabled on this item before using this action.

Parameters

• number restitution

This action selects a point on the loaded texture that this Drawable will consider to be the right edge of the image to be drawn. 0 represents the left edge of the base texture, and 1 represents the right edge of the base texture.

Parameters

• number right

Sets this Item2D to be rotated to an angle of the given number of degrees. This will also rotate all Items in the children hierarchy of this Item.

Parameters

• number degrees

This action sets separate scaling values for the x and y planes on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height.

Parameters

• number newX
• number newY

This action sets the scale of this Item2D, causing the vertices of the item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height.

Parameters

• number scale

This action sets the scale of this Item2D, causing the vertices of the item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Parameters

• number scale

This action sets separate scaling values for the x and y planes on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width and height. The default scaling values are 1.0, or 100% of the Item's width and height. This action will increase or decrease the scale of the object from the center, and update the Item's x,y coordinates to reflect the new bottom-left corner of the Item.

Parameters

• number newX
• number newY

This action sets the scaling value of the x plane on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the width. The default scaling values are 1.0, or 100% of the Item's width and height.

Parameters

• number scaleX

This action sets the scaling value of the y plane on this Item2D. This will cause the vertices of this Item to be calculated based on a scaled percentage of the height. The default scaling values are 1.0, or 100% of the Item's width and height.

Parameters

• number scaleY

This item returns the collision shape of this item. The collision shape is the shape the collision system will use to test for collisions with this item. Note that this may be different from the shape drawn on the screen.

This action will create a new Texture with a solid circle of the given color with the given radius. This texture is then loaded into the Drawable.

Parameters

• Libraries.Language.Object

This action will create a new Texture with a solid triangle of the given color that is made of the points identified by the three given points. The three points are relative to the origin of the Drawable. This texture is then loaded into the Drawable.

Parameters

• Libraries.Game.Graphics.Shaders.ShaderMapping

Parameters

• Libraries.Game.Graphics.Shaders.ShaderProgram

This action sets the collision shape of this item. The collision shape is the shape the collision system will use to test for collisions with this item. Note that this may be different from the shape drawn on the screen. A copy of the passed shape is used for the collison shape for this item.

Parameters

• Libraries.Game.Collision.Shapes.CollisionShape2D: The collision shape to use for this item

This action will set the width and height of the Item2D, respectively.

Parameters

• number newWidth
• number newHeight

This action enables physics for this item. Passing true turns on physics for this item while passing false turns off physics for this item.

Parameters

• number time

Parameters

• text value

This action sets the texture used by this TextureRegion to the given texture.

Parameters

• Libraries.Game.Graphics.Texture

Parameters

• boolean selected

This action selects a point on the loaded texture that this Drawable will consider to be the top edge of the image to be drawn. 0 represents the bottom edge of the base texture, and 1 represents the top edge of the base texture.

Parameters

• number top

This action sets the total torque on this item. The units are kilogram units squared per second per second. This action should be used to set the total torque on this item. If we want to apply a torque to this item, we should use the ApplyTorque actions instead. Physics must be enabled on this action before using this action.

Parameters

• number torque

This action is used internally by the physics system to set the position of this item in the physics world. This action is used internally and users users should not need to use this action.

Parameters

• Libraries.Compute.Vector2: The vector representing the position of the center of the item in physics space
• number angle: The rotation in radians of the item in physics space

This action sets the position of the item in physical space. This action is used internally and should not be used by users to set the position of this item on the screen.

Parameters

• Libraries.Game.Collision.PhysicsPosition2D: The position and angle of this item in physics space

This action sets the position of the item in physics space from the previous frame. This action is used internally and users should not need to use this action.

Parameters

• Libraries.Game.Collision.PhysicsPosition2D: The position and angle of the item in physics space in the previuos frame

This action destroys the nodes for this item for the broadphase collision, essentially removing it from the collision detection system. This action is used internally and users should not need to use this action.

This item is used to test whether a passed point is on the collision shape of this item.

Parameters

• boolean flag

The IsClipping action returns true if pixel clipping is enabled, or false if it is disabled. If it is enabled, when the Item and its children are drawn as part of the QueueForDrawing action, any pixels that would be drawn outside of the unrotated dimensions of the Item are not rendered. In other words, the Item will only draw inside the exact rectangle formed by its x, y position and its width and height.

Parameters

• Libraries.Interface.Views.View2D

This action will set the width of the Item2D.

Parameters

• number newWidth

This action sets the X coordinate of the Item.

Parameters

• number setX

This action sets the Y coordinate of the Item.

Parameters

• number setY

This action sets the Z value of the Item2D. For Item2D, the z value is used during layer sorting to determine ordering, where lower z values will be placed first.

Parameters

• number setZ

get the old target global center of the object

Parameters

• Libraries.Interface.Item2D

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 linear velocity of this item in units per second. Physics must be enabled on this item before using this action.

Parameters

• boolean flag

This action is used to syncronize the item's position in physics space with its position in the tree used for broadphase collision. This action is used internally and users should not need to use this action.

This action is used to update this items position in physics space after physics solving is finished for this item. This action is used internally and users should not need to use this action.

This item is used to test whether a passed point is on the collision shape of this item.

Parameters

• Libraries.Compute.Vector2: The vector representing the point to test

Return

boolean: True if the passed point is on the collisoin shape, false otherwise

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.

Parameters

• boolean flipX
• boolean flipY

Parameters

• number x
• number y
• number z

Parameters

• number angle

Parameters

• number width
• number height

This action is used internally by the physics system to set the position of this item in the physics world. This action is used internally and users users should not need to use this action.

This action sets the position of the item in physical space. This action is used internally and should not be used by users to set the position of this item on the screen.

This action returns the position of the item in physical space. This acction is used internally and should not be used by users to get the position of this item on the screen.

This action removes the color filter from a Drawable.

This action returns whether or not the Drawable has a custom Color filter. This will return false if a different type of filter, such as a Gradient, is in use. To check for a filter regardless of type, use the UsingCustomTint action.

Return

boolean:

This action returns whether or not the Drawable is using a gradient. This will return false if a different type of filter, such as a Gradient, is in use. To check for a filter regardless of type, use the UsingCustomTint action.

Return

boolean:

This action returns whether or not the Drawable is being tinted by a ColorGroup, such as a Color or Gradient.

Return

boolean: