Index · Object → RefCounted → Resource → SkeletonModification2D → SkeletonModification2DLookAt

SkeletonModification2DLookAt

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

Class Description

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

var bone2d_node: NodePath = NodePath("")

The Bone2D node that the modification will operate on.

var bone_index: int = -1

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

var target_nodepath: NodePath = 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.

Inherited from SkeletonModification2D (2)
var enabled: bool = true
Inherited from Resource (4)

Methods

func get_additional_rotation() -> float

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

func get_constraint_angle_invert() -> bool

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

func get_constraint_angle_max() -> float

Returns the constraint's maximum allowed angle.

func get_constraint_angle_min() -> float

Returns the constraint's minimum allowed angle.

func get_enable_constraint() -> bool

Returns true if the LookAt modification is using constraints.

func set_additional_rotation(rotation: float) -> void

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.

func set_constraint_angle_invert(invert: bool) -> void

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.

func set_constraint_angle_max(angle_max: float) -> void

Sets the constraint's maximum allowed angle.

func set_constraint_angle_min(angle_min: float) -> void

Sets the constraint's minimum allowed angle.

func set_enable_constraint(enable_constraint: bool) -> void

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

Inherited from SkeletonModification2D (9)
func _draw_editor_gizmo() -> void
func _execute(delta: float) -> void
func _setup_modification(modification_stack: SkeletonModificationStack2D) -> void
func clamp_angle(angle: float, min: float, max: float, invert: bool) -> float
func get_is_setup() -> bool
func set_editor_draw_gizmo(draw_gizmo: bool) -> void
func set_is_setup(is_setup: bool) -> void
Inherited from Resource (18)
func _get_rid() -> RID
func _reset_state() -> void
func _set_path_cache(path: String) -> void
func _setup_local_to_scene() -> void
func copy_from_resource(resource: Resource) -> Error
func duplicate(deep: bool = false) -> Resource
func duplicate_deep(deep_subresources_mode: Resource.DeepDuplicateMode = 1) -> Resource
func emit_changed() -> void
func get_rid() -> RID
func is_built_in() -> bool
func reset_state() -> void
func set_id_for_path(path: String, id: String) -> void
func set_path_cache(path: String) -> void
func setup_local_to_scene() -> void
func take_over_path(path: String) -> void
Inherited from RefCounted (4)
func init_ref() -> bool
func reference() -> bool
func unreference() -> bool
Inherited from Object (62)
func _get(property: StringName) -> Variant
func _get_property_list() -> Dictionary[]
func _init() -> void
func _iter_get(iter: Variant) -> Variant
func _iter_init(iter: Array) -> bool
func _iter_next(iter: Array) -> bool
func _notification(what: int) -> void
func _set(property: StringName, value: Variant) -> bool
func _to_string() -> String
func _validate_property(property: Dictionary) -> void
func add_user_signal(signal: String, arguments: Array = []) -> void
func call(method: StringName) -> Variant
func callv(method: StringName, arg_array: Array) -> Variant
func cancel_free() -> void
func connect(signal: StringName, callable: Callable, flags: int = 0) -> Error
func disconnect(signal: StringName, callable: Callable) -> void
func emit_signal(signal: StringName) -> Error
func free() -> void
func get(property: StringName) -> Variant
func get_class() -> String
func get_incoming_connections() -> Dictionary[]
func get_indexed(property_path: NodePath) -> Variant
func get_meta(name: StringName, default: Variant = null) -> Variant
func get_meta_list() -> StringName[]
func get_method_list() -> Dictionary[]
func get_property_list() -> Dictionary[]
func get_signal_connection_list(signal: StringName) -> Dictionary[]
func get_signal_list() -> Dictionary[]
func has_meta(name: StringName) -> bool
func has_method(method: StringName) -> bool
func has_signal(signal: StringName) -> bool
func is_class(class: StringName) -> bool
func is_connected(signal: StringName, callable: Callable) -> bool
func notification(what: int, reversed: bool = false) -> void
func remove_meta(name: StringName) -> void
func remove_user_signal(signal: StringName) -> void
func set(property: StringName, value: Variant) -> void
func set_block_signals(enable: bool) -> void
func set_deferred(property: StringName, value: Variant) -> void
func set_indexed(property_path: NodePath, value: Variant) -> void
func set_message_translation(enable: bool) -> void
func set_meta(name: StringName, value: Variant) -> void
func set_script(script: Variant) -> void
func set_translation_domain(domain: StringName) -> void
func to_string() -> String
func tr(message: StringName, context: StringName = &"") -> String
func tr_n(message: StringName, plural_message: StringName, n: int, context: StringName = &"") -> String

Signals

Inherited from Resource (2)
signal changed()
Inherited from Object (2)