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

Наследует: SkeletonModifier3D < Node3D < Node < Object

Наследуется от: AimModifier3D, ConvertTransformModifier3D, CopyTransformModifier3D

Узел, который может модифицировать кость Skeleton3D, связывая две кости.

Описание

Базовый класс для SkeletonModifier3D, который изменяет кость, заданную через set_apply_bone(), на основе трансформации кости, полученной через get_reference_bone().

Примечание: Большинство методов этого класса принимают параметр index. Он указывает, какую запись из списка настроек следует возвращать, если IK содержит несколько записей (например, settings/<index>/amount).

Методы

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)

Перечисления

enum ReferenceType: 🔗

ReferenceType REFERENCE_TYPE_BONE = 0

В качестве опорной точки используется кость. В данном случае опорная точка находится в локальном пространстве.

ReferenceType REFERENCE_TYPE_NODE = 1

В качестве опорного объекта используется Node3D. В данном случае опорный объект находится в пространстве модели.

Иными словами, координаты опорного объекта обрабатываются так, как если бы он был расположен непосредственно под Skeleton3D, который является родительским элементом для BoneConstraint3D.

Описания метода

void clear_setting() 🔗

Очистить все настройки.

float get_amount(index: int) const 🔗

Возвращает примененную величину настройки в index.

int get_apply_bone(index: int) const 🔗

Возвращает применённую настройку кости в index. Эта кость будет изменена.

String get_apply_bone_name(index: int) const 🔗

Возвращает имя применяемой кости настройки в index. Эта кость будет изменена.

int get_reference_bone(index: int) const 🔗

Возвращает опорную кость настройки в index.

Эта кость будет только ссылаться на нее, но не будет изменена этим модификатором.

String get_reference_bone_name(index: int) const 🔗

Возвращает имя опорной кости настройки в index.

Эта кость будет только ссылаться на нее, но не будет изменена этим модификатором.

NodePath get_reference_node(index: int) const 🔗

Возвращает путь к узлу-ссылке для параметра по адресу index.

Этот узел будет только использоваться в качестве ссылки и не будет изменяться данным модификатором.

ReferenceType get_reference_type(index: int) const 🔗

Возвращает целевой тип ссылки для параметра по адресу index. См. также ReferenceType.

int get_setting_count() const 🔗

Возвращает количество настроек в модификаторе.

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

Устанавливает применяемое значение параметра index на amount.

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

Устанавливает применяемую кость настройки в index на bone. Эта кость будет изменена.

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

Устанавливает применяемую кость настройки в index на bone_name. Эта кость будет изменена.

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

Устанавливает опорную кость настройки в index на bone.

Эта кость будет только ссылаться на нее, но не будет изменена этим модификатором.

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

Устанавливает опорную кость настройки в index на bone_name.

Эта кость будет только ссылаться на нее, но не будет изменена этим модификатором.

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

Устанавливает путь к узлу-ссылке для параметра index в node.

Этот узел будет только использоваться в качестве ссылки и не будет изменяться этим модификатором.

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

Устанавливает целевой тип ссылки для параметра по адресу index равным type. См. также ReferenceType.

void set_setting_count(count: int) 🔗

Задает количество настроек в модификаторе.