Object

(Called internally) Clears all cached transforms, and force-stops caching.

Adds the specified object as a child to this object, and adds it to a stage if it was not added to one previously.
Calls child:onAdd(self).

@param child — The object to be added.

@return child — The object that was added.

Adds a DrawFX to the object.
DrawFX are classes that can apply visual effects to an object when drawing it.
Each effect will be applied in sequence, with effects of higher priority rendering later.

@param fx — The DrawFX instance to add to the object.

@param id — An optional string ID that can be used to reference the DrawFX in other functions.

@return fx — The DrawFX instance that was added to the object.

Called during drawing to apply cutouts.

(Override)
By default, returns self.debug_select.

@return can_select — Whether the object can be selected by the Object Selection debug feature.

Returns whether the object has been clicked this frame.

@param number — The mouse button to check. If not provided, it will check all buttons available.

@return success — Whether the object was clicked.

@return button — The mouse button that clicked the object. Useful if the 'button' argument was not provided.

Whether the object is colliding with another object or collider.

@param other — The object or collider to check collision with.

@return collided — Whether the collision occurred or not.

(Override) Called every frame by its parent during drawing if the object is visible.
By default, draws its children.

End caching the transforms of all objects (started with Object.startCache()).

@param x — The explosion's horizontal offset.

@param y — The explosion's vertical offset.

@param dont_remove — Whether the object should not be removed.

@param options — Additional properties.

options:
    | "play_sound" -- Whether it should play the sound. (Defaults to true)

Fades the object's alpha to 0 over time seconds, then removes it.

@param time — The amount of time, in seconds, that the fade should take. (Defaults to 1 second)

Fades the object's alpha to 0 at a speed of speed per frame, then removes it.

@param speed — The amount that the object's alpha should approach the target value, per frame at 30FPS. (Defaults to 0.04)

Fades the object's alpha to the specified value over time seconds.

@param target — The alpha value that the object's alpha should approach.

@param time — The amount of time, in seconds, that the fade should take. (Defaults to 1 second)

@param callback — A function that will be called when the alpha value is reached. Receives self as an argument.

Fades the object's alpha to the specified value at a speed of speed per frame.

@param target — The alpha value that the object's alpha should approach.

@param speed — The amount that the object's alpha should approach the target value, per frame at 30FPS. (Defaults to 0.04)

@param callback — A function that will be called when the alpha value is reached. Receives self as an argument.

Returns the camera origin of the object, simplifying to be a ratio relative to its width and height if its current camera origin is exact.

@return x — The horizontal camera origin of the object.

@return y — The vertical camera origin of the object.

Returns the camera origin of the object, multiplying to give the exact pixels if its current camera origin is not exact.

@return x — The horizontal camera origin of the object.

@return y — The vertical camera origin of the object.

Returns the values of the object's color and alpha values.

@return r — The red value of the object's color.

@return g — The green value of the object's color.

@return b — The blue value of the object's color.

@return a — The alpha value of the object.

Returns the object's cutout values.

@return The — cutout_left value of the object.

@return The — cutout_top value of the object.

@return The — cutout_right value of the object.

@return The — cutout_bottom value of the object.

(Override)
By default, returns an empty table.

@return info — A list of strings to display if the object is selected by the Object Selection debug feature.

(Override) Defines options that can be used when selecting the object with the Object Selection debug feature.
By default, defines options that all objects use.

@param context — The menu object containing the debug options that can be used.

To define an option, use context:addMenuItem(name: string, description: string, code: function), where:

• name defines the name that appears in the menu.
• description defines the text that appears when hovering over the option.
• code is the function that will be called when selecting the option.

@return context — The modified menu object.

(Override) Returns a table defining the rectangle to use for selecting the object with the Object Selection debug feature.
By default, returns self.debug_rect, or a rectangle with the same width and height as the object if self.debug_rect is nil.

@return rectangle — A table containing 4 number values, defining the x, y, width and height of the selection rectangle.

Returns the object's physics.direction, or the object's rotation if physics.match_rotation is true.

@return dir — The movement direction of the object.

Returns the object's color and alpha.
If the object's inherit_color is true, the result is multiplied by its parent's color and alpha, to get the color it should draw at.

@return r — The red value of the object's draw color.

@return g — The green value of the object's draw color.

@return b — The blue value of the object's draw color.

@return a — The object's draw alpha.

Returns a DrawFX added to the object.

@param id — A string referring to the ID of a DrawFX, the class type that a DrawFX includes, or a DrawFX instance.

@return fx — A DrawFX instance if the object has one that matches the ID, or nil otherwise.

Returns the object's scale, multiplied by its parent's full scale.

@return x — The horizontal scale of the object.

@return y — The vertical scale of the object.

@return hierarchy — A table of all parents between this object and its stage (inclusive).

Returns the dimensions of the object's collider if that collider is a Hitbox.

@return x — The x position of the collider, relative to the object.

@return y — The y position of the collider, relative to the object.

@return width — The width of the collider, in pixels.

@return height — The height of the collider, in pixels.

Returns the layer of the object.

@return The — layer value of the object.

Returns the origin of the object, simplifying to be a ratio relative to its width and height if its current origin is exact.

@return x — The horizontal origin of the object.

@return y — The vertical origin of the object.

Returns the origin of the object, multiplying to give the exact pixels if its current origin is not exact.

@return x — The horizontal origin of the object.

@return y — The vertical origin of the object.

Returns the parallax of the object.

@return x — The parallax_x value of the object.

@return y — The parallax_y value of the object.

Returns the parallax origin of the object.

@return x — The parallax_origin_x value of the object.

@return y — The parallax_origin_y value of the object.

Returns the position of the object.

@return x — The x position of the object.

@return y — The y position of the object.

Returns the specified position for the object, relative to another object.

@param x — The x position relative to the object.

@param y — The y position relative to the object.

@param other — The object the returned values should be relative to.

@return x — The new x position relative to the other object.

@return y — The new y position relative to the other object.

Returns the object's position, relative to another object.

@param other — The object the returned values should be relative to.

@return x — The new x position relative to the other object.

@return y — The new y position relative to the other object.

Returns the rotation origin of the object, simplifying to be a ratio relative to its width and height if its current rotation origin is exact.
If the object doesn't have a rotation origin defined, it will return self:getOrigin() instead.

@return x — The horizontal rotation origin of the object.

@return y — The vertical rotation origin of the object.

Returns the rotation origin of the object, multiplying to give the exact pixels if its current rotation origin is not exact.
If the object doesn't have a rotation origin defined, it will return self:getOriginExact() instead.

@return x — The horizontal rotation origin of the object.

@return y — The vertical rotation origin of the object.

Returns the scale of the object.

@return x — The scale_x value of the object.

@return y — The scale_y value of the object.

Returns the scaling origin of the object, simplifying to be a ratio relative to its width and height if its current scaling origin is exact.
If the object doesn't have a scaling origin defined, it will return self:getOrigin() instead.

@return x — The horizontal scaling origin of the object.

@return y — The vertical scaling origin of the object.

Returns the scaling origin of the object, multiplying to give the exact pixels if its current scaling origin is not exact.
If the object doesn't have a scaling origin defined, it will return self:getOriginExact() instead.

@return x — The horizontal scaling origin of the object.

@return y — The vertical scaling origin of the object.

Returns the height of the object, accounting for scale.

@return height — The height of the object multiplied by its scale_y.

Returns the size of the object, accounting for scale.

@return width — The width of the object multiplied by its scale_x.

@return height — The height of the object multiplied by its scale_y.

Returns the width of the object, accounting for scale.

@return width — The width of the object multiplied by its scale_x.

Returns the object's position relative to the topleft of the game window.

@return x — The x position of the object.

@return y — The y position of the object.

Returns the size of the object.

@return width — The width value of the object.

@return height — The height value of the object.

(Override) Used by World to determine what position should be used when sorting its layer.
By default, returns self:getRelativePos(self.width/2, self.height).

@return x — The horizontal position to use.

@return y — The vertical position to use.

Returns the velocity and direction of the object's physics, converting physics.speed_x and physics.speed_y if necessary.

@return speed — The linear speed the object moves at.

@return direction — The direction the object is moving in.

Returns the horizontal and vertical speed of the object's physics, converting physics.speed and physics.direction if necessary

@return speed_x — The horizontal speed of the object.

@return speed_y — The vertical speed of the object.

@return stage — The object's highest parent.

(Override)
By default, returns true.

@return attached — Whether a Camera attached to this object should follow it.

Returns whether the object and its parents are active, determining whether the object should be updated or not.

@return active — Whether the object and its parents are active.

Returns whether the object and its parents are visible, determining whether the object should be drawn or not.

@return visible — Whether the object and its parents are visible.

@return has_stage — Whether the object has a parent or not.

Returns the specified position for the object, relative to the object's stage.

@param x — The x position relative to the object.

@param y — The y position relative to the object.

@return x — The new x position relative to the object's stage.

@return y — The new y position relative to the object's stage.

Moves the object's x and y values by the specified values.

@param x — How much to add to the object's x value.

@param y — How much to add to the object's y value.

@param speed — How much to multiply the x and y movement by. (Defaults to 1)

(Override) Called when the object is added to a parent object via parent:addChild(self) or self:setParent(parent).

@param parent — The parent that the object is being added to.

(Override) Called when the object is first added to the Game stage, via parent:addChild(self) or self:setParent(parent).
Will not be called when changing to a new parent via self:setParent(new_parent) if the object had a parent prior.

@param stage — The Stage object that the object is being added to.

(Override) Called when the object is removed from its parent object via self:remove(), parent:removeChild(self), or self:setParent(new_parent).

@param parent — The parent that the object is being removed from.

(Override) Called when the object is removed from the Game stage via self:remove() or parent:removeChild(self).
Will not be called when changing to a new parent via self:setParent(new_parent).

@param stage — The Stage object that the object was a child of.

Removes the object from its parent.

Removes the specified object from this object's children, and removes it from its stage.
Calls child:onRemove(self).

@param child — The object to be removed.

@return child — The object that was removed.

Removes the specified DrawFX from the object.

@param id — A string referring to the ID of a DrawFX, the class type that a DrawFX includes, or a DrawFX instance.

@return fx — The removed DrawFX instance if the object has one that matches the ID, or nil otherwise.

Resets all of the object's graphics table values to their default values,
making it so it will stop transforming if it was before.

Resets all of the object's physics table values to their default values,
making it so it will stop moving if it was before.

Returns the specified position for the object's stage, relative to this object.

@param x — The x position relative to the object's stage.

@param y — The y position relative to the object's stage.

@return x — The new x position relative to the object.

@return y — The new y position relative to the object.

Sets the object's camera_origin_x and camera_origin_y values to the specified origin, and sets camera_origin_exact to false.
The camera origin set by this function will therefore be a ratio relative to the object's width and height.

@param x — The value to set camera_origin_x to.

@param y — The value to set camera_origin_y to. (Defaults to the x parameter)

Sets the object's camera_origin_x and camera_origin_y values to the specified origin, and sets camera_origin_exact to true.
The camera origin set by this function will therefore be in exact pixels.

@param x — The value to set camera_origin_x to.

@param y — The value to set camera_origin_y to. (Defaults to the x parameter)

Sets the object's color and alpha values to the specified color.

@param r — The red value to set for the object's color.

@param g — The green value to set for the object's color.

@param b — The blue value to set for the object's color.

@param a — The value to set alpha to. (Doesn't change alpha if unspecified)

@param color — The value to set color to. Can optionally define a 4th value to set alpha.

Sets the object's cutout values to the specified cutout.

@param left — The value to set cutout_left to.

@param top — The value to set cutout_top to.

@param right — The value to set cutout_right to.

@param bottom — The value to set cutout_bottom to.

Sets the object's movement direction to the specified direction, or its rotation if physics.match_rotation is true.

@param dir — The value to set physics.direction or rotation to.

Resets the object's graphics and sets new values for it.

@param graphics — A table of values to set for the object's graphics transformation.

Sets the object's collider to a new Hitbox with the specified dimensions.

@param x — The x position of the collider, relative to the object.

@param y — The y position of the collider, relative to the object.

@param w — The width of the collider, in pixels.

@param h — The height of the collider, in pixels.

Sets the object's layer, and updates its position in its parent's children list.

@param layer — The value to set layer to.

Sets the object's origin_x and origin_y values to the specified origin, and sets origin_exact to false.
The origin set by this function will therefore be a ratio relative to the object's width and height.

@param x — The value to set origin_x to.

@param y — The value to set origin_y to. (Defaults to the x parameter)

Sets the object's origin_x and origin_y values to the specified origin, and sets origin_exact to true.
The origin set by this function will therefore be in exact pixels.

@param x — The value to set origin_x to.

@param y — The value to set origin_y to. (Defaults to the x parameter)

Sets the object's parallax_x and parallax_y to the specified parallax.

@param x — The value to set parallax_x to.

@param y — The value to set parallax_y to. (Defaults to the x parameter)

Sets the object's parallax_origin_x and parallax_origin_y values to the specified origin.

@param x — The value to set parallax_origin_x to.

@param y — The value to set parallax_origin_y to.

Sets the object's parent, removing it from its previous parent if it had one.

@param parent — The object to add self to.

Resets the object's physics and sets new values for it.

@param physics — A table of values to set for the object's physics.

Sets the object's x and y values to the specified position.

@param x — The value to set x to.

@param y — The value to set y to.

Sets the object's rotation_origin_x and rotation_origin_y values to the specified origin, and sets rotation_origin_exact to false.
The rotation origin set by this function will therefore be a ratio relative to the object's width and height.

@param x — The value to set rotation_origin_x to.

@param y — The value to set rotation_origin_y to. (Defaults to the x parameter)

Sets the object's rotation_origin_x and rotation_origin_y values to the specified origin, and sets rotation_origin_exact to true.
The rotation origin set by this function will therefore be in exact pixels.

@param x — The value to set rotation_origin_x to.

@param y — The value to set rotation_origin_y to. (Defaults to the x parameter)

Sets the object's scale_x and scale_y values to the specified scale.

@param x — The value to set scale_x to.

@param y — The value to set scale_y to. (Defaults to the x parameter)

Sets the object's scale_origin_x and scale_origin_y values to the specified origin, and sets scale_origin_exact to false.
The scaling origin set by this function will therefore be a ratio relative to the object's width and height.

@param x — The value to set scale_origin_x to.

@param y — The value to set scale_origin_y to. (Defaults to the x parameter)

Sets the object's scale_origin_x and scale_origin_y values to the specified origin, and sets scale_origin_exact to true.
The scaling origin set by this function will therefore be in exact pixels.

@param x — The value to set scale_origin_x to.

@param y — The value to set scale_origin_y to. (Defaults to the x parameter)

Sets the object's position relative to the topleft of the game window.

@param x — The x position for the object.

@param y — The y position for the object.

Sets the object's width and height values to the specified size.

@param width — The value to set width to.

@param height — The value to set height to. (Defaults to the width parameter)

Sets the object's speed in its physics table.

@param x — The value to set physics.speed_x to.

@param y — The value to set physics.speed_y to.

@param speed — The value to set physics.speed to.

Makes the object shake by the specified amount.

@param x — The amount of shake in the x direction. (Defaults to 4)

@param y — The amount of shake in the y direction. (Defaults to 0)

@param friction — The amount that the shake should decrease by, per frame at 30FPS. (Defaults to 1)

@param delay — The time it takes for the object to invert its shake direction, in seconds. (Defaults to 1/30)

Sets the object's relative origin to the specified values, and adjusts its position so that it stays in the same place visually.

@param ox — The value to set origin_x to.

@param oy — The value to set origin_y to. (Defaults to the ox parameter)

Sets the object's exact origin to the specified values, and adjusts its position so that it stays in the same place visually.

@param ox — The value to set origin_x to.

@param oy — The value to set origin_y to. (Defaults to the ox parameter)

Moves the object along a path of points.

@param path — A table containing a list of tables with two number values in each, defining a list of points the object should follow.

@param options — A table defining additional properties that the path should use.

options:
    | "time" -- The amount of time, in seconds, that the object should take to travel along the full path.
    | "speed" -- The speed at which the object should travel along the path, in pixels per frame at 30FPS.
    | "ease" -- The ease type to use when travelling along the path. Unused if `speed` is specified instead of `time`. (Defaults to "linear")
    | "after" -- A function that will be called when the end of the path is reached. Receives no arguments.
    | "move_func" -- A function called every frame while the object is travelling along the path. Receives `self` and the `x` and `y` offset from the previous frame as arguments.
    | "relative" -- Whether the path should be relative to the object's current position, or simply set its position directly.
    | "loop" -- Whether the path should loop back to the first point when reaching the end, or if it should stop.
    | "reverse" -- If true, reverse all of the points on the path.
    | "skip" -- A number defining how many points of the path to skip.
    | "snap" -- Whether the object's position should immediately "snap" to the first point, or if its initial position should be counted as a point on the path.

Moves the object's x and y values to the new specified position over time seconds.

@param x — The new x value to approach.

@param y — The new y value to approach.

@param marker — A map marker whose position the object should approach.

@param time — The amount of time, in seconds, that the slide should take. (Defaults to 1 second)

@param ease — The ease type to use when moving to the new position. (Defaults to "linear")

@param after — A function that will be called when the target position is reached. Receives no arguments.

@return success — Whether the sliding will occur. False if the object's current position is already at the specified position, and true otherwise.

Moves the object's x and y values to the new specified position at a speed of speed pixels per frame.

@param x — The new x value to approach.

@param y — The new y value to approach.

@param marker — A map marker whose position the object should approach.

@param speed — The amount that the object's x and y should approach the specified position, in pixels per frame at 30FPS. (Defaults to 4)

@param after — A function that will be called when the target position is reached. Receives no arguments.

@return success — Whether the sliding will occur. False if the object's current position is already at the specified position, and true otherwise.

Begin caching the transforms of all objects.
This should be called before any collision checks, and ended with Object.endCache().
If an object is moved mid-cache, call Object.uncache() on it.

Stops the object from shaking.

Uncache an object's transform, if Object.startCache() is active.
This recalculates the object's transform and all of its children, incase it was moved.

(Called internally) Uncaches an object's full transform, including all of its children.

(Override) Called every frame by its parent if the object is active.
By default, updates its physics and graphics tables, and its children.

(Used internally) Whether the object should draw its children or not.

Whether the object should update itself and its children.

The alpha transparency of the object, between 0 (invisible) and 1 (fully visible).

A camera instance that will automatically move and scale the object and its children. Should be nil for most objects.

Whether the object's camera origin is measured as a ratio of its width and height, or in exact pixels. (Defaults to false)

The horizontal camera origin of the object. (Defaults to 0.5)
Camera origin defines what position on the object a camera attached to it should follow.

The vertical camera origin of the object. (Defaults to 0.5)
Camera origin defines what position on the object a camera attached to it should follow.

A list of all of this object's children.

(Used internally) A list of children for the object to remove next time it updates.

Whether the object should be able to collide with other objects.

A Collider class used to check collision with other objects.

The color of the object in the form {R, G, B}.
The values of R, G, and B are between 0 and 1.

The amount of pixels to cut from the bottom of the object when drawing.

The amount of pixels to cut from the left of the object when drawing.

The amount of pixels to cut from the right of the object when drawing.

The amount of pixels to cut from the top of the object when drawing.

Defines the rectangle used for selecting the object with the Object Selection debug feature.

Whether the object can be selected by the Object Selection debug feature. (Defaults to true)

If defined, children with a layer greater than this value will be drawn above the object.

If defined, children with a layer less than this value will be drawn underneath the object.

A list of all DrawFX that are being applied to the object.

Whether the object is flipped horizontally.

Whether the object is flipped vertically.

A table of data, defining ways the object's properties should automatically update.

The height of the object.

Whether the object's color will be multiplied by its parent's color.

The horizontal position of the object when it was created.

The vertical position of the object when it was created.

The horizontal position of the object in the previous frame.

The vertical position of the object in the previous frame.

The layer of the object within its parent.
Objects update and draw their children in order sorted by layer. Objects with a higher layer will update and draw later than objects with lower layers.

All children of an object will draw at the same visual layer as the parent. In other words, a child cannot render above an object that is higher than its parent, even if its own layer is higher.

Whether the object's origin is measured as a ratio of its width and height, or in exact pixels. (Defaults to false)

The horizontal origin of the object.
Origin is used to define the point that the object is scaled, rotated, and positioned from.
This determines where the position (0, 0) is within the object.

If origin_exact is false, the origin will be a ratio relative to the object's width and height, meaning an origin of 0.5, 0.5 will cause the object to be centered.
If it is true, then the origin will be measured in exact pixels.

The vertical origin of the object.
Origin is used to define the point that the object is scaled, rotated, and positioned from.
This determines where the position (0, 0) is within the object.

If origin_exact is false, the origin will be a ratio relative to the object's width and height, meaning an origin of 0.5, 0.5 will cause the object to be centered.
If it is true, then the origin will be measured in exact pixels.

The horizontal position on the object's parent that the object's parallax will orient around.

The vertical position on the object's parent that the object's parallax will orient around.

How much an object's position will be affected by the camera horizontally.
A value of 1 means it fully moves with the camera (aka default behavior), and a value of 0 means it will not move at all when the camera moves.
Parallax will only affect an object if its parent has a camera.

How much an object's position will be affected by the camera vertically.
A value of 1 means it fully moves with the camera (aka default behavior), and a value of 0 means it will not move at all when the camera moves.
Parallax will only affect an object if its parent has a camera.

The object's parent.

A table of data, defining ways the object should automatically move when updating.

The rotation of the object, in radians. (0 is right, positive is clockwise)

Whether the object's rotation origin is measured as a ratio of its width and height, or in exact pixels. (Defaults to false)

The horizontal rotation origin of the object.
Rotation origin overrides the object's origin, and defines where the object will rotate from.

The vertical rotation origin of the object.
Rotation origin overrides the object's origin, and defines where the object will rotate from.

Whether the object's scale origin is measured as a ratio of its width and height, or in exact pixels. (Defaults to false)

The horizontal scale origin of the object.
Scale origin overrides the object's origin, and defines where the object will scale from.

The vertical scale origin of the object.
Scale origin overrides the object's origin, and defines where the object will scale from.

The horizontal scale of the object.

The vertical scale of the object.

A multiplier that determines the speed at which the object updates.

(Used internally) If true, the object will re-sort its children list.

Whether the object should draw itself and its children.

The width of the object.

The horizontal position of the object, relative to its parent.

The vertical position of the object, relative to its parent.