Class SkeletonModification2DLookAt

A modification that rotates a Bone2D node to look at a target.

Inheritance

SkeletonModification2D

Resource

RefCounted

Object

SkeletonModification2DLookAt

Remarks

This SkeletonModification2D rotates a bone to look a target. This is extremely helpful for moving character's head to look at the player, rotating a turret to look at a target, or any other case where you want to make a bone rotate towards something quickly and easily.

Properties

bone2d_node

The Bone2D node that the modification will operate on.

var bone2d_node : NodePath = NodePath("")

Property Value

NodePath

Remarks

• void set_bone2d_node(NodePath value)
• NodePath get_bone2d_node

bone_index

The index of the Bone2D node that the modification will operate on.

var bone_index : int = -1

Property Value

int

Remarks

• void set_bone_index(int value)
• int get_bone_index

target_nodepath

The NodePath to the node that is the target for the LookAt modification. This node is what the modification will rotate the Bone2D to.

var target_nodepath : NodePath = NodePath("")

Property Value

NodePath

Remarks

• void set_target_node(NodePath value)
• NodePath get_target_node

Methods

get_additional_rotation

Qualifiers: const

Returns the amount of additional rotation that is applied after the LookAt modification executes.

float get_additional_rotation

get_constraint_angle_invert

Qualifiers: const

Returns whether the constraints to this modification are inverted or not.

bool get_constraint_angle_invert

get_constraint_angle_max

Qualifiers: const

Returns the constraint's maximum allowed angle.

float get_constraint_angle_max

get_constraint_angle_min

Qualifiers: const

Returns the constraint's minimum allowed angle.

float get_constraint_angle_min

get_enable_constraint

Qualifiers: const

Returns true if the LookAt modification is using constraints.

bool get_enable_constraint

set_additional_rotation(float)

Sets the amount of additional rotation that is to be applied after executing the modification. This allows for offsetting the results by the inputted rotation amount.

void set_additional_rotation(float rotation)

Parameters

rotation float

set_constraint_angle_invert(bool)

When true, the modification will use an inverted joint constraint.

An inverted joint constraint only constraints the Bone2D to the angles outside of the inputted minimum and maximum angles. For this reason, it is referred to as an inverted joint constraint, as it constraints the joint to the outside of the inputted values.

void set_constraint_angle_invert(bool invert)

Parameters

invert bool

set_constraint_angle_max(float)

Sets the constraint's maximum allowed angle.

void set_constraint_angle_max(float angle_max)

Parameters

angle_max float

set_constraint_angle_min(float)

Sets the constraint's minimum allowed angle.

void set_constraint_angle_min(float angle_min)

Parameters

angle_min float

set_enable_constraint(bool)

Sets whether this modification will use constraints or not. When true, constraints will be applied when solving the LookAt modification.

void set_enable_constraint(bool enable_constraint)

Parameters

enable_constraint bool