Libraries.Interface.Controls.Charts.ChartLine

Example

use Libraries.Game.Graphics.Drawable
use Libraries.Game.Graphics.Color
use Libraries.Game.Graphics.ColorGroup
use Libraries.Game.Game

class Main is Game

    Color color

    action Main
        StartGame()
    end

    action CreateGame
        Drawable drawable
        drawable:SetColor(0, 1, 1, 1)
        ColorGroup group = drawable:GetColorGroup()
    end

end

GetColorProperty(text property)

This action gets the color of a given property in the Control.

Parameters

text property

Return

Libraries.Interface.Controls.Charts.Chart

GetContainer()

Return

GetContainerGridHeight()

This action returns how many rows this Control should be divided into when using a GridLayout. This will have no effect if this Control is not a container or if it is using a different layout.

Return

integer:

GetContainerGridWidth()

This action returns how many columns this Control should be divided into when using a GridLayout. This will have no effect if this Control is not a container or if it is using a different layout.

Return

integer:

GetCurrentLayoutProperties()

This action returns the LayoutProperties that were last used to define the Control, and thus describe its current state. Note that if the Control hasn't been laid out yet, this will return undefined.

Return

Libraries.Interface.Layouts.LayoutProperties: The last LayoutProperties used to layout this Control, or undefined if it hasn't been laid out yet.

GetDefaultFont()

This action obtains the default font for this control. This allows individual controls to customize their default font properties on a per control basis. By default, the system asks for the default system font name on a per control basis, then loads that font and returns it. Font loading is shared, so loading many fonts of the same type and size is not particularly expensive and can be done without much concern for memory requirements.

Return

Libraries.Game.Graphics.Font:

Example

use Libraries.Interface.Controls.TextBox
use Libraries.Game.Graphics.Font

TextBox box
text name = box:GetDefaultFont()
output name

GetDefaultFontName()

This action defines what the default font is for this control. This allows individual controls to customize their default font properties on a per control basis.

Return

text:

Example

use Libraries.Interface.Controls.TextBox

TextBox box
text name = box:GetDefaultFontName()
output name

GetDefaultFontSize()

This action defines what the default font size for this control. This allows individual controls to customize their default font properties on a per control basis.

Return

integer:

Example

use Libraries.Interface.Controls.TextBox

TextBox box
integer size = box:GetDefaultFontSize()
output size

GetDefaultLayoutProperties()

This action returns the default LayoutProperties used for this Control.

Return

Libraries.Interface.Layouts.LayoutProperties: The default LayoutProperties of this Control.

GetDefaultMonospaceFontName()

This action sets the interface scale for the control.

Return

text: the scale, a number between 0 and 1 that scales the control.

GetDefaultProportionalFontName()

This action defines what the default font is for this control. This allows individual controls to customize their default font properties on a per control basis.

Return

text:

Example

use Libraries.Interface.Controls.TextBox

TextBox box
text name = box:GetDefaultFontName()
output name

GetDensity()

Return

number:

Example

use Libraries.Interface.Item2D
use Libraries.Compute.Vector2

Item2D item
Vector2 impulse
Vector2 point

item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)

impulse:Set(100)
point:Set(100, 100)     // apply the impulse to the top right corner

item:ApplyLinearImpulse(impulse, point)

GetDescription()

This action returns the current internal description of the Item.

Return

text:

Example

use Libraries.Interface.Item

Item item
item:SetDescription("Used for demo purposes.")
output "My item's description is : " + item:GetDescription()

GetDisplayName()

This action obtains the displayable name for this region of the chart.

Return

text: the display name

GetDownItem()

Returns the Item accessed "below" (via the DOWN arrow) this Item in the chart selection.

Return

Libraries.Game.Graphics.DrawableShape:

GetDrawableShape()

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

Example

use Libraries.Game.Graphics.Drawable
use Libraries.Game.Graphics.Color
use Libraries.Game.Game

class Main is Game
    
    action Main
        StartGame()
    end

    action CreateGame
        Color green
        green:SetColor(0, 1, 0, 1)
        Drawable rectangle
        rectangle:LoadFilledRectangle(20, 100, green)
        rectangle:SetPosition(50, 50)
        Add(rectangle)
    end
end

GetDrawableType()

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.

GetEnterItem()

Returns the Item accessed within (default: ENTER key) this Item in the chart selection.

Return

GetEscapeItem()

Returns the escape Item accessed from this Item in the chart selection (by default using the ESCAPE key).

Return

GetFocusBorderColor()

This action gets the focus border color.

Return

Libraries.Game.Graphics.ColorGroup: the focus border color.

GetFocusColor()

This action sets the focus color.

Return

Libraries.Game.Graphics.ColorGroup: the focus color.

GetFocusFontColor()

This action gets focus font color.

Return

Libraries.Game.Graphics.ColorGroup: the focus font color.

GetFocusListeners()

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.

GetFont()

This action returns the Font being used by this Control. How this Font is used varies between Controls, and in some cases the Control will ignore it entirely (for example, ScrollPanes), but typically this sets the font that's used for the default label on many Controls, such as Buttons. If the Font is undefined, many Controls will omit their default label.

Return

Libraries.Game.Graphics.Font: The Font being used for this Control.

GetFontColor()

This action gets the current the font color of the font contained in the Control.

Return

Libraries.Game.Graphics.Gradient:

GetFontOutlineColor()

This action gets the font outline color value.

Return

Libraries.Game.Graphics.ColorGroup: the font outline color value.

GetFontOutlineThickness()

This action returns the font outline thickness value.

Return

number: the font outline thickness value.

GetFontSize()

This action returns the base Font size to be used by this Control, if the Control uses a Font.

Return

integer:

GetForce()

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

Example

use Libraries.Interface.Item2D
use Libraries.Compute.Vector2

Item2D item
Vector2 force

item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
force:Set(300, 350)
item:SetForce(force)
Vector2 totalForce = item:GetForce()

GetForegroundColor()

This action gets the color of the Control foreground color.

Return

Libraries.Game.Graphics.ColorGroup: the foreground color.

GetForegroundSelectionColor()

This action gets the color of the Control foreground selection color.

Return

Libraries.Game.Graphics.ColorGroup: the foreground selection color.

GetFriction()

Return

number:

Example

use Libraries.Compute.Vector2
use Libraries.Interface.Item2D

Item2D item
Vector2 force

item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)

force:Set(300, 350)

item:ApplyForce(force)

GetGestureListeners()

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.

GetGlobalX()

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:

Example

use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetX(100)
myItem:SetX(30)
number globalX = myItem:GetGlobalX()

GetGlobalY()

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:

Example

use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetY(60)
myItem:SetX(90)
number globalY = myItem:GetGlobalY()

GetGlobalZ()

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

Return

number:

GetGlowColor()

This action gets the glow color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the glow color.

GetGradient()

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

Example

use Libraries.Game.Graphics.Drawable
use Libraries.Game.Graphics.Gradient
use Libraries.Game.Graphics.Color
use Libraries.Game.Game

class Main is Game

    Gradient gradient
    Color color

    action Main
        StartGame()
    end

    action CreateGame
        Drawable drawable
        Gradient gradient
        gradient:Set(color:Red(), color:Green(), color:Blue(), color:White())
        drawable:SetGradient(gradient)

        drawGradient = drawable:GetGradient()
    end

end

GetGridHeight()

The GetGridHeight action returns how many cells in a column this Control occupies. By default, this value is 1. This value is only used for GridLayouts, and is ignored by other layouts.

Return

integer:

GetGridWidth()

The GetGridWidth action returns how many cells in a row this Control occupies. By default, this value is 1. This value is only used for GridLayouts, and is ignored by other layouts.

Return

integer:

GetGridX()

This action returns this Control's cell x-coordinate within a GridLayout. This indicates which column this Control is located within. If the Control's parent container isn't using a GridLayout, this value is ignored.

Return

integer:

GetGridY()

This action returns this Control's cell y-coordinate within a GridLayout. This indicates which row this Control is located within. If the Control's parent container isn't using a GridLayout, this value is ignored.

Return

integer:

GetGroup()

Gets the group. The group is the label on the chart associated with this drawable. In most cases the groups are created by unique factors. GroupPanel is used to position, locate, and name the drawable on the chart.

Return

Libraries.Interface.Controls.Charts.GroupPanel: the GroupPanel .

GetHashCode()

This action gets the hash code for an object.

Return

integer: The integer hash code of the object.

Example

Object o
integer hash = o:GetHashCode()

GetHeight()

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

Return

number:

Example

use Libraries.Interface.Item2D
Item2D myItem
number height = myItem:GetHeight()

GetHorizontalLayoutMode()

The GetHorizontalLayoutMode is used to determine how the width of a Control is calculated. It should be one of the following constants: STANDARD, which will calculate the width as a set number of pixels plus a percentage of the container's width. FILL, which will make the width fill the remaining width of the container. FIT_CONTENTS, which will calculate the width to fit the children contents.

Return

integer: the integer that maps to the layout mode constant, one of STANDARD, FILL, or FILL_CONTENTS.

GetIcon()

This action gets the Icon (typically an image or texture) used by this Control. Different Controls use this Icon differently, depending on their purpose.

Return

Libraries.Game.Graphics.TextureRegion:

GetIconColor()

This action gets the Icon color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the icon color.

GetIndicesCount()

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:

GetInertia()

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

Example

use Libraries.Interface.Item2D

Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inertia = item:GetInertia()

GetInputGroup()

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.

Example

use Libraries.Interface.Item

Item item
item:SetInputGroup("arrowKeys")
output "My item's input group is : " + item:GetInputGroup()

GetInputTable()

Return

Libraries.Game.InputTable:

GetInterfaceOptionsKey()

This action sets the base Font size to be used by this Control, if the Control uses a Font.

Return

text:

GetInterfaceScale()

This action sets the interface scale for the control.

Return

number: the scale, a number between 0 and 1 that scales the control.

GetInverseInertia()

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

Example

use Libraries.Interface.Item2D

Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inverseInertia = item:GetInverseInertia()

GetInverseMass()

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

Example

use Libraries.Interface.Item2D

Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inverseMass = item:GetInverseMass()

GetItem(integer index)

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:

Example

use Libraries.Interface.Item2D

Item2D parentItem
Item2D child1
Item2D child2
parentItem:Add(child1)
parentItem:Add(child2)
Item temp = parentItem:GetItem(0)

GetItemAt(number x, number y)

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.

Example

use Libraries.Interface.Item2D

Item2D parentItem
Item2D child
Item2D grandchild
parentItem:Add(child)
child:Add(grandchild)
grandchild:SetHeight(100)
grandchild:SetWidth(100)
Item2D temp = parentItem:GetItemAt(75, 75)

GetItemCount()

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

Return

integer:

Example

use Libraries.Interface.Item2D

Item2D parentItem
Item2D child1
Item2D child2
parentItem:Add(child1)
parentItem:Add(child2)
integer size = parentItem:GetItemCount()

GetItems()

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

Return

Libraries.Containers.Iterator:

Example

use Libraries.Interface.Item2D
use Libraries.Containers.Iterator

Item2D parentItem
Item2D child1
Item2D child2
parentItem:Add(child1)
parentItem:Add(child2)
Iterator<Item2D> iterator = parentItem:GetItems()

GetJointList()

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

GetLabelText()

This action returns the text used for this Control's label, if it has one.

Return

text: The text of this Control's label.

GetLayer()

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

Return

Libraries.Game.Layer2D:

GetLayout()

Returns true if rendering the selection event.

Return

Libraries.Interface.Layouts.Layout:

GetLayoutProperties(number containerWidth, number containerHeight)

This action returns the best suited LayoutProperties stored by the Control for use with the given container width and height. The Control will attempt to find the most restricted LayoutProperties that is still valid, prioritizing width over height in case of equal values.

Parameters

number containerWidth: The width of the container the LayoutProperties must be legal for.
number containerHeight: The height of the container the LayoutProperties must be legal for.

Return

Libraries.Interface.Layouts.LayoutProperties: The LayoutProperties contained in the Control that is best suited to the requested container dimensions.

GetLayoutProperties()

This action is fired if the item lost the focus.

Return

Libraries.Containers.Iterator:

GetLayoutRows()

This action returns how many rows this element should occupy, if the layout supports it. This effectively makes the control taller. This is most commonly used in conjunction with FormRowLayout (or StackedRowPage which uses that layout).

Return

number:

GetLeftItem()

Returns the Item accessed to the left of this Item in the chart selection.

Return

GetLeftMargin()

This action gets the left margin size. The left margin is the space outside of the left border.

Return

number: the number amount of left margin.

GetLeftPadding()

This action gets the left padding size. The left padding is the space inside of the left border.

Return

number: the number amount of left padding.

GetLeftSide()

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:

GetLineEnd()

Returns min x point of all points

Return

GetLineMax()

Returns max y point of all points

Return

GetLineMin()

Returns min y point of all points

Return

GetLineStart()

Returns max x point of all points

Return

Libraries.Containers.Array:

GetLinearDamping()

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)

GetLinearVelocity()

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

Example

use Libraries.Interface.Item2D
use Libraries.Compute.Vector2

Item2D item
Vector2 velocity

item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
velocity:Set(100, 0)
item:SetLinearVelocity(velocity)

Vector2 currentVelocity = item:GetLinearVelocity()

GetLinearVelocityFromLocalPoint(Libraries.Compute.Vector2 localPoint)

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

Example

use Libraries.Interface.Item2D
use Libraries.Compute.Vector2

Item2D item
Vector2 worldPoint

item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)

worldPoint:Set(400, 350)    // the lower left corner of the item

Vector2 localPoint = item:GetLocalPoint(worldPoint)

GetLinearVelocityFromWorldPoint(Libraries.Compute.Vector2 worldPoint)

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

Example

use Libraries.Interface.Item2D
use Libraries.Compute.Vector2

Item2D item
Vector2 worldVector

item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)

worldVector:Set(400, 350)    // the lower left corner of the item

Vector2 localVector = item:GetLocalVector(worldVector)

GetLines()

Returns an array of Drawables for this line.

Return

GetLocalCenter()

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

GetLocalPoint(Libraries.Compute.Vector2 worldPoint)

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

Example

use Libraries.Interface.Item2D
use Libraries.Compute.Vector2

Item2D item
Vector2 worldPoint

item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)

worldPoint:Set(400, 350)    // the lower left corner of the item

Vector2 localPoint = item:GetLocalPoint(worldPoint)

GetLocalVector(Libraries.Compute.Vector2 worldVector)

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

Example

use Libraries.Interface.Item2D
use Libraries.Compute.Vector2

Item2D item
Vector2 worldVector

item:SetWidth(100)
item:SetHeight(100)
item:SetPosition(400, 350)

worldVector:Set(400, 350)    // the lower left corner of the item

Vector2 localVector = item:GetLocalVector(worldVector)

GetMass(Libraries.Game.Physics.Mass2D mass)

Parameters

Libraries.Game.Physics.Mass2D

GetMass()

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

Example

use Libraries.Interface.Item2D

Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number mass = item:GetMass()

GetMesh()

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:

Example

use Libraries.Game.Graphics.Drawable
use Libraries.Game.Game

class Main is Game
    
    action Main
        StartGame()
    end

    action CreateGame
        Drawable circle
        circle:LoadFilledCircle(75)
        circle:SetPosition(50, 50)
        Add(circle)
    end
end

GetMeshIndex()

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:

GetMouseDownColor()

This action gets the mouse down font color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over font color value.

GetMouseDownFontColor()

This action gets the mouse down font color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse down font color.

GetMouseDownGlowColor()

This action gets the mouse down glow color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse down glow color.

GetMouseListeners()

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.

GetMouseMovementListeners()

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.

GetMouseOverColor()

This action gets the mouse over color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over color.

GetMouseOverFontColor()

This action gets the mouse over font color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over font color value.

GetMouseOverGlowColor()

This action gets the mouse over glow color.

Return

Libraries.Game.Graphics.ColorGroup: the mouse over glow color.

GetMouseWheelListeners()

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.

GetName()

This action returns the current internal name of the Item.

Return

text:

Example

use Libraries.Interface.Item

Item item
item:SetName("My Item")
output "My item's name is " + item:GetName()

GetNextFocus()

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.

GetNodeCount()

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

GetNodes()

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

GetNumberProperty(text property)

This action gets a generic property with a specified name from the control.

Parameters

text property: the property name.

Return

number: the number value of the property.

GetOffsetX()

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:

Example

use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetX(100)
number offset = myItem:GetOffsetX()

GetOffsetY()

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:

Example

use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetY(75)
number offset = myItem:GetOffsetY()

GetOffsetZ()

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:

Example

use Libraries.Interface.Item2D
Item2D myItem
myItem:SetOffsetZ(75)
number offset = myItem:GetOffsetZ()

GetOriginX()

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

Return

number:

Example

use Libraries.Interface.Item2D

Item2D myItem
myItem:SetSize(100, 200)
myItem:SetOriginCenter()
number xOrigin = myItem:GetOriginX()

GetOriginY()

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

Return

number:

Example

use Libraries.Interface.Item2D

Item2D myItem
myItem:SetSize(100, 200)
myItem:SetOriginCenter()
number yOrigin = myItem:GetOriginY()

GetParent()

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:

Example

use Libraries.Interface.Item2D

Item2D parentItem
Item2D child
parentItem:Add(child)
Item2D item = child:GetParent()

GetParentChart()

Try to get the chart this is attached to via the parent hierarchy.

Return

Libraries.Interface.Controls.Charts.Chart:

GetPattern()

Return

integer

GetPatternName()

Return

text

GetPercentageHeight()

This action returns the height of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target height as a percentage (as a value between 0.0 and 1.0) of the container's height.

GetPercentageOriginX()

This action returns the x-coordinate of the "origin" of the Control, as a percentage of its width. The origin is the point that the Control is positioned by. For example, by default, the origin is at 0% x and 0% y, or the bottom-left corner of the Control. Changing the percentage origin x and y to 0.5 (50%) would mean the Control should be positioned using its center instead. The origin point is used by layouts that allow for specific positioning, such as ManualLayout or GridLayout. It is ignored by layouts that have special positioning rules, such as FlowLayout.

Return

number:

GetPercentageOriginY()

This action returns the y-coordinate of the "origin" of the Control, as a percentage of its width. The origin is the point that the Control is positioned by. For example, by default, the origin is at 0% x and 0% y, or the bottom-left corner of the Control. Changing the percentage origin x and y to 0.5 (50%) would mean the Control should be positioned using its center instead. The origin point is used by layouts that allow for specific positioning, such as ManualLayout or GridLayout. It is ignored by layouts that have special positioning rules, such as FlowLayout.

Return

number:

GetPercentageWidth()

This action returns the width of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target width as a percentage (as a value between 0.0 and 1.0) of the container's width.

GetPercentageX()

This action returns the x position of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target x position as a percentage (as a value between 0.0 and 1.0) of the container's width.

GetPercentageY()

This action returns the y position of the Control relative to the size of its container, if the container's Layout supports it.

Return

number: The target y position as a percentage (as a value between 0.0 and 1.0) of the container's height.

GetPhysicsProperties()

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

GetPixelHeight()

This action returns the target height of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target height of this Control in pixels.

GetPixelWidth()

This action returns the target width of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target height of this Control in pixels.

GetPixelX()

This action returns the target x position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target x position of this Control in pixels.

GetPixelY()

This action returns the target y position of the Control in pixels. Note that this may not be used by some layouts (such as FlowLayout).

Return

number: The target y position of this Control in pixels.

GetPoints()

Returns an array of ChartPoints for this line.

Return

Libraries.Containers.Array:

GetPointsFlag()

Returns the value of the showPoints flag.

Return

boolean:

GetPopupMenu()

The GetContextMenu action returns this Control's context menu, if it has one. A context menu is a PopupMenu which appears when a user wants additonal context about this Control (most commonly by right-clicking on the Control).

Return

Libraries.Interface.Controls.PopupMenu:

GetPreviousFocus()

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.

GetPropertiesSize()

Return

integer

GetProperty(text key)

Parameters

text key

Return

Libraries.Data.Formats.JavaScriptObjectNotation

GetPropertyKeyIterator()

Return

Libraries.Containers.Iterator

GetRawInertia()

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:

GetRegionHeight()

This action returns the height of the region.

Return

integer:

GetRegionWidth()

This action returns the width of the TextureRegion.

Return

integer:

GetRegionX()

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

Return

integer:

GetRegionY()

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

Return

integer:

GetResponsiveness()

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

Example

use Libraries.Interface.Item2D

Item2D item
item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetMass(20)
number inverseMass = item:GetInverseMass()

GetRestitution()

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

Example

use Libraries.Interface.Item2D

Item2D item

item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetTorque(200)
number totalTorque = item:GetTorque()

GetRightItem()

Returns the Item accessed to the right of this Item in the chart selection.

Return

GetRightMargin()

This action gets the right margin size. The right margin is the space outside of the right border.

Return

number: the number amount of right margin.

GetRightPadding()

This action gets the right padding size. The right padding is the space inside of the right border.

Return

number: the number amount of right padding.

GetRightSide()

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:

GetRotation()

Gets the current degree of rotation of this Item.

Return

number:

Example

use Libraries.Interface.Item2D

Item2D myItem
myItem:SetRotation(90)
number rotation = myItem:GetRotation()

GetRotationInRadians()

Gets the current rotation of this Item in radians.

Return

number:

Example

use Libraries.Interface.Item2D

Item2D myItem
myItem:SetRotation(90)
number rotation = myItem:GetRotationInRadians()

GetScaleX()

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:

Example

use Libraries.Interface.Item2D

Item2D myItem
myItem:SetSize(100, 200)
myItem:Scale(1.25)
number scaleX = myItem:GetScaleX()

GetScaleY()

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:

Example

use Libraries.Interface.Item2D

Item2D myItem
myItem:SetSize(100, 200)
myItem:Scale(1.25)
number scaleY = myItem:GetScaleY()

GetScreenX()

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:

GetScreenY()

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:

GetSelectionBorderColor()

This action gets the selection border color.

Return

Libraries.Game.Graphics.ColorGroup: the selection border color.

GetSelectionColor()

Returns the value of the showPoints flag.

Return

Libraries.Interface.Controls.Charts.Series:

GetSelectionFontColor()

This action gets the selection font color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the selection font color.

GetSelectionListeners()

This action return an iterator of all SelectionListeners which have been added to the Control of the given SelectionEvent.

Return

Libraries.Containers.Iterator: All SelectionListeners registered with the Control.

GetSeries()

Sorts all the chart points within the line by lowest x value first This is used in numerical factor line charts

Return

GetShaderData()

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:

Example

use Libraries.Game.Graphics.Drawable
use Libraries.Game.Game

class Main is Game
    
    action Main
        StartGame()
    end

    action CreateGame
        Drawable triangle
        triangle:LoadFilledTriangle(0, 0, 200, 200, 400, 0)
        triangle:SetPosition(50, 50)
        Add(triangle)
    end
end

GetShaderMapping()

Return

Libraries.Game.Graphics.Shaders.ShaderMapping:

GetShaderProgram()

Return

Libraries.Game.Graphics.Shaders.ShaderProgram:

GetShadowColor()

This action gets the shaddow color from the control.

Return

Libraries.Game.Graphics.ColorGroup: the shaddow color.

GetShadowEdgeFade()

This action returns the shadow edge fade property.

Return

number: the shadow edge fade number.

GetShadowHeight()

This action returns the shadow height property.

Return

number: the shadow height number.

GetShadowWidth()

This action returns the shadow width property.

Return

number: the shadow width number.

GetShadowX()

This action returns the shadow X value.

Return

number: the shadow X value.

GetShadowY()

This action returns the shadow Y value.

Return

number: the shadow Y value.

GetShape()

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

Example

use Libraries.Game.Drawable
use Libraries.Game.Collision.Shapes.Circle

Drawable ball
ball:Load("ball.png")
Circle circle
circle:SetRadius(30)
ball:SetShape(circle)
CollisionShape2D shape = ball:GetShape()

GetShapeType()

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

GetSleepTime()

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

Return

number: The children of this item in an array

Example

use Libraries.Interface.Item2D

Item2D parent
Item2D child1
Item2D child2

parent:Add(child1)
parent:Add(child2)

Array<Item2D> children = parent:GetChildren()

GetSweep()

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

GetTexture()

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

Return

Libraries.Game.Graphics.Texture:

Example

use Libraries.Game.Graphics.Drawable
use Libraries.Game.Graphics.Texture
use Libraries.Game.Game

class Main is Game

    action Main
        StartGame()
    end

    action CreateGame
        Drawable drawable
        drawable:LoadFilledCircle(75)
        Texture circle = drawable:GetTexture()
    end

end

GetTextureField()

This action returns the texture held by this TextureRegion.

Return

Libraries.Game.Graphics.Texture:

GetTopLeftPixelRounding()

This action returns the top left pixel rounding value.

Return

number: the top left pixel rounding value.

GetTopLeftRounding()

This action returns the top left rounding value.

Return

number: the top left rounding value.

GetTopMargin()

This action gets the top margin size. The top margin is the space outside of the top border.

Return

number: the number amount of top margin.

GetTopPadding()

This action gets the top padding size. The top padding is the space inside of the top border.

Return

number: the number amount of top padding.

GetTopRightPixelRounding()

This action returns the top right pixel rounding value.

Return

number: the top right pixel rounding value.

GetTopRightRounding()

This action returns the top right rounding value.

Return

number: the top right rounding value.

GetTopSide()

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:

GetTorque()

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

Example

use Libraries.Interface.Item2D

Item2D item

item:SetWidth(100)
item:SetHeight(100)
item:EnablePhysics(true)
item:SetTorque(200)
number totalTorque = item:GetTorque()

GetTouchListeners()

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.

GetTransform()

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

GetTransform0()

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

GetUnfocusedSelectionBorderColor()

This action gets the unfocused selection border color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the unfocused selection border color.

GetUnfocusedSelectionColor()

This action gets the unfocused selection color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the unfocused selection color.

GetUnfocusedSelectionFontColor()

This action gets the unfocused selection font color on the control.

Return

Libraries.Game.Graphics.ColorGroup: the unfocused selection font color.

GetUpItem()

Returns the Item accessed "above" (via the UP arrow) this Item in the chart selection.

Return