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...

BoneConstraint3D

Hérite de : SkeletonModifier3D < Node3D < Node < Object

Hérité par : AimModifier3D, ConvertTransformModifier3D, CopyTransformModifier3D

Un nœud qui peut modifier un os d'un Skeleton3D en associant deux os.

Description

Base class of SkeletonModifier3D that modifies the bone set in set_apply_bone() based on the transform of the bone retrieved by get_reference_bone().

Note: Most methods in this class take an index parameter. This parameter specifies which setting list entry to return if the IK has multiple entries (e.g. settings/<index>/amount).

Méthodes

void	clear_setting()
float	get_amount(index: int) const
int	get_apply_bone(index: int) const
String	get_apply_bone_name(index: int) const
int	get_reference_bone(index: int) const
String	get_reference_bone_name(index: int) const
NodePath	get_reference_node(index: int) const
ReferenceType	get_reference_type(index: int) const
int	get_setting_count() const
void	set_amount(index: int, amount: float)
void	set_apply_bone(index: int, bone: int)
void	set_apply_bone_name(index: int, bone_name: String)
void	set_reference_bone(index: int, bone: int)
void	set_reference_bone_name(index: int, bone_name: String)
void	set_reference_node(index: int, node: NodePath)
void	set_reference_type(index: int, type: ReferenceType)
void	set_setting_count(count: int)

Énumérations

enum ReferenceType: 🔗

ReferenceType REFERENCE_TYPE_BONE = 0

The reference target is a bone. In this case, the reference target spaces is local space.

ReferenceType REFERENCE_TYPE_NODE = 1

The reference target is a Node3D. In this case, the reference target spaces is model space.

In other words, the reference target's coordinates are treated as if it were placed directly under Skeleton3D which parent of the BoneConstraint3D.

Descriptions des méthodes

void clear_setting() 🔗

Efface tous les paramètres.

float get_amount(index: int) const 🔗

Renvoie le montant d'application du paramètre à l'index index.

int get_apply_bone(index: int) const 🔗

Renvoie l'os d'application du paramètre à l'index index. Cet os sera modifié.

String get_apply_bone_name(index: int) const 🔗

Renvoie le nom de l'os d'application du paramètre à l'index index. Cet os sera modifié.

int get_reference_bone(index: int) const 🔗

Renvoie l'os de référence du paramètre à l'index index.

Cet os sera uniquement référencé et non modifié par ce modificateur.

String get_reference_bone_name(index: int) const 🔗

Renvoie le nom de l'os de référence du paramètre à l'index index.

Cet os sera uniquement référencé et non modifié par ce modificateur.

NodePath get_reference_node(index: int) const 🔗

Renvoie le chemin du nœud de référence du paramètre à l'index index.

Ce nœud sera uniquement référencé et non modifié par ce modificateur.

ReferenceType get_reference_type(index: int) const 🔗

Renvoie le type de cible de référence du réglage à index. Voir aussi ReferenceType.

int get_setting_count() const 🔗

Renvoie le nombre de paramètres dans le modificateur.

void set_amount(index: int, amount: float) 🔗

Définit le montant d'application du paramètre à l'index index au montant amount.

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

Définit l'os d'application du paramètre à l'index index à l'os bone. Cet os sera modifié.

void set_apply_bone_name(index: int, bone_name: String) 🔗

Définit l'os d'application du paramètre à l'index index à l'os ayant pour nom bone_name. Cet os sera modifié.

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

Définit l'os de référence du paramètre à l'index index à l'os bone.

Cet os sera uniquement référencé et non modifié par ce modificateur.

void set_reference_bone_name(index: int, bone_name: String) 🔗

Définit l'os de référence du paramètre à l'index index à l'os ayant pour nom bone_name.

Cet os sera uniquement référencé et non modifié par ce modificateur.

void set_reference_node(index: int, node: NodePath) 🔗

Définit le chemin du nœud de référence du paramètre à l'index index au nœud node.

Ce nœud sera uniquement référencé et non modifié par ce modificateur.

void set_reference_type(index: int, type: ReferenceType) 🔗

Définit le type de cible de référence du réglage à index à type. Voir aussi ReferenceType.

void set_setting_count(count: int) 🔗

Définit le nombre de paramètres dans le modificateur.