Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

Checking the stable version of the documentation...

BoneSpaceAdjuster3D

Inherits: SkeletonModifier3D < Node3D < Node < Object

Inputs a scale and converts it to the position of a child bone.

Description

Inputs a scale and converts it to the position of a child bone. Intended for use in combination with Skeleton3D.set_bone_skin_scale().

This modifier repositions child bones to follow the skin transformation by Skeleton3D.set_bone_skin_scale() in cases when you want to adjust bone length using Skeleton3D.set_bone_skin_scale() or when the bone has multiple child bones.

Properties

int	setting_size
bool	use_bone_skin_scale_for_all_bones	`true`

Methods

void	clear_setting()
int	get_bone(index: int) const
StringName	get_bone_name(index: int) const
Vector3	get_bone_scale(index: int) const
bool	is_using_bone_skin_scale(index: int) const
void	set_bone(index: int, bone: int)
void	set_bone_name(index: int, bone_name: StringName)
void	set_bone_scale(index: int, scale: Vector3)
void	set_use_bone_skin_scale(index: int, enabled: bool)

Property Descriptions

int setting_size 🔗

void set_setting_size(value: int)
int get_setting_size()

The number of settings in the modifier.

bool use_bone_skin_scale_for_all_bones = true 🔗

void set_use_bone_skin_scale_for_all_bones(value: bool)
bool are_all_bones_using_bone_skin_scale()

If true, this modifier processes all bones for which Skeleton3D.get_bone_skin_scale() is not Vector3(1, 1, 1).

If false, this modifier allows you to configure whether to process bone skin scaling individually in the settings.

Method Descriptions

void clear_setting() 🔗

Clears all settings.

int get_bone(index: int) const 🔗

Returns the scaled bone of the setting at index.

StringName get_bone_name(index: int) const 🔗

Returns the scaled bone name of the setting at index.

Vector3 get_bone_scale(index: int) const 🔗

Returns the scale of the setting at index.

bool is_using_bone_skin_scale(index: int) const 🔗

Returns whether to use the skin_scale property of a Skeleton3D's bone of the setting at index.

void set_bone(index: int, bone: int) 🔗

Sets the scaled bone of the setting at index.

void set_bone_name(index: int, bone_name: StringName) 🔗

Sets the scaled bone name of the setting at index.

void set_bone_scale(index: int, scale: Vector3) 🔗

When is_using_bone_skin_scale() returns false, sets the scale of the setting at index.

Note: The scale value is recommended to be non-zero.

void set_use_bone_skin_scale(index: int, enabled: bool) 🔗

Sets whether to use the skin_scale property of a Skeleton3D's bone of the setting at index.

User-contributed notes

Please read the User-contributed notes policy before submitting a comment.