Get Object | hyperPad Documentation
Logo
Object

Get Object

Published September 28, 2018
Get Object

Art Studio learning guide

Description

Get the details of a selected object to use in other behaviors.

Rigged Objects

This section describes the live-rig update and requires a build with Rigged Objects. A public release date has not been assigned. Existing sprite/object workflows remain supported.

A Rigged Object is one scene object. Its bones and Body Parts are internal animation controls, not independently selectable objects. Get Object and Get Objects By Tag return the character's object ID; they do not return a limb ID. Collision Event, Create Collision, and Ignore Collisions operate on the object's configured collision shape and object-to-object physics rules, not on separately generated bone hitboxes.

A visual change such as Crouch does not automatically resize the collider. Inspect and configure scene collision separately. To read a limb position, use Get Bone Transform. To carry a separate scenery/kinematic visual, use Attach Object to Bone. To swap a limb's own graphic, use Set Rig Attachment.

See Rigged Objects and Rig Behaviours for the object/rig distinction and supported controls.

Properties

Triggers Immediately

ObjectSelect the object you wish to get the details of.
Get Object ByGet the object by its ID or its name.
Get Objects by TagGets all objects containing a specified tag.
Get Objects in LayerGets all objects in a specified layer.
Get All ObjectsGets all active objects in the scene.
Object IdentifierThe ID or name of the object you would like to get the details of.

Outputs

X

This outputs the X position of the Object.

Y

This outputs the Y position of the Object.

X Scale

This outputs the object's scale on the X axis

Y Scale

This outputs the object's scale on the Y axis.

X Skew

This outputs the object's skew on the X axis.

Y Skew

This outputs the object's skew on the Y axis.

Rotation

This outputs the object's rotation.

Tags

This outputs any tags attached to the object as an array.

Object ID

This outputs the object ID. If multiple objects are found, this will be an array of object IDs.

Object Name

This outputs the name of the object.

Examples

Download Example Project

Get Attribute

Get Objects by Tag

Set Attribute