Class reference
SkeletonModification2D
Inherits Resource
Base class for resources that operate on Bone2Ds in a Skeleton2D.
Description
This resource provides an interface that can be expanded so code that operates on Bone2D nodes in a Skeleton2D can be mixed and matched together to create complex interactions. This is used to provide Redot with a flexible and powerful Inverse Kinematics solution that can be adapted for many different uses.
Properties
bool enabled = true
bool enabled = trueIf true, the modification's _execute() function will be called by the SkeletonModificationStack2D.
int execution_mode = 0
int execution_mode = 0The execution mode for the modification. This tells the modification stack when to execute the modification. Some modifications have settings that are only available in certain execution modes.
Methods
void _draw_editor_gizmo() virtual
Used for drawing editor-only modification gizmos. This function will only be called in the Redot 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.
void _execute(float delta) virtual
float delta) virtualExecutes the given modification. This is where the modification performs whatever function it is designed to do.
void _setup_modification(SkeletonModificationStack2D modification_stack) virtual
SkeletonModificationStack2D modification_stack) virtualCalled when the modification is setup. This is where the modification performs initialization.
float clamp_angle(float angle, float min, float max, bool invert)
float clamp_angle(float angle, float min, float max, bool invert)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.
bool get_editor_draw_gizmo() const
bool get_editor_draw_gizmo() constReturns whether this modification will call _draw_editor_gizmo() in the Redot editor to draw modification-specific gizmos.
bool get_is_setup() const
bool get_is_setup() constReturns whether this modification has been successfully setup or not.
SkeletonModificationStack2D get_modification_stack()
SkeletonModificationStack2D get_modification_stack()Returns the SkeletonModificationStack2D that this modification is bound to. Through the modification stack, you can access the Skeleton2D the modification is operating on.
void set_editor_draw_gizmo(bool draw_gizmo)
bool draw_gizmo)Sets whether this modification will call _draw_editor_gizmo() in the Redot editor to draw modification-specific gizmos.
void set_is_setup(bool is_setup)
bool is_setup)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.