SkeletonModification2D #

virtual func _draw_editor_gizmo() -> void#

Used for drawing editor-only modification gizmos. This function will only be called in the Godot editor and can be overridden to draw custom gizmos.

Note: You will need to use the Skeleton2D from SkeletonModificationStack2D.get_skeleton and it's draw functions, as the SkeletonModification2D resource cannot draw on its own.

virtual func _execute(delta: float) -> void#

Executes the given modification. This is where the modification performs whatever function it is designed to do.

virtual func _setup_modification(modification_stack: SkeletonModificationStack2D) -> void#

Called when the modification is setup. This is where the modification performs initialization.

func clamp_angle(invert: bool) -> float#

Takes an angle and clamps it so it is within the passed-in min and max range. invert will inversely clamp the angle, clamping it to the range outside of the given bounds.

const func get_editor_draw_gizmo() -> bool#

Returns whether this modification will call _draw_editor_gizmo in the Godot editor to draw modification-specific gizmos.

const func get_is_setup() -> bool#

Returns whether this modification has been successfully setup or not.

func get_modification_stack() -> SkeletonModificationStack2D#

Returns the SkeletonModificationStack2D that this modification is bound to. Through the modification stack, you can access the Skeleton2D the modification is operating on.

func set_editor_draw_gizmo(draw_gizmo: bool) -> void#

Sets whether this modification will call _draw_editor_gizmo in the Godot editor to draw modification-specific gizmos.

func set_is_setup(is_setup: bool) -> void#

Manually allows you to set the setup state of the modification. This function should only rarely be used, as the SkeletonModificationStack2D the modification is bound to should handle setting the modification up.