Table of Contents

Class BoneMap

Namespace
Godot
Assembly
GodotSharp.dll

This class contains a dictionary that uses a list of bone names in SkeletonProfile as key names.

By assigning the actual Skeleton3D bone name as the key value, it maps the Skeleton3D to the SkeletonProfile.

public class BoneMap : Resource, IDisposable
Inheritance
BoneMap
Implements
Inherited Members

Constructors

BoneMap() 

public BoneMap()

Properties

Profile

A SkeletonProfile of the mapping target. Key names in the BoneMap are synchronized with it.

public SkeletonProfile Profile { get; set; }

Property Value

SkeletonProfile

Methods

FindProfileBoneName(StringName)

Returns a profile bone name having skeletonBoneName. If not found, an empty StringName will be returned.

In the retargeting process, the returned bone name is the bone name of the target skeleton.

public StringName FindProfileBoneName(StringName skeletonBoneName)

Parameters

skeletonBoneName StringName

Returns

StringName

GetSkeletonBoneName(StringName)

Returns a skeleton bone name is mapped to profileBoneName.

In the retargeting process, the returned bone name is the bone name of the source skeleton.

public StringName GetSkeletonBoneName(StringName profileBoneName)

Parameters

profileBoneName StringName

Returns

StringName

HasGodotClassMethod(in godot_string_name)

Check if the type contains a method with the given name. This method is used by Godot to check if a method exists before invoking it. Do not call or override this method.

protected override bool HasGodotClassMethod(in godot_string_name method)

Parameters

method godot_string_name

Name of the method to check for.

Returns

bool

HasGodotClassSignal(in godot_string_name)

Check if the type contains a signal with the given name. This method is used by Godot to check if a signal exists before raising it. Do not call or override this method.

protected override bool HasGodotClassSignal(in godot_string_name signal)

Parameters

signal godot_string_name

Name of the signal to check for.

Returns

bool

InvokeGodotClassMethod(in godot_string_name, NativeVariantPtrArgs, out godot_variant)

Invokes the method with the given name, using the given arguments. This method is used by Godot to invoke methods from the engine side. Do not call or override this method.

protected override bool InvokeGodotClassMethod(in godot_string_name method, NativeVariantPtrArgs args, out godot_variant ret)

Parameters

method godot_string_name

Name of the method to invoke.

args NativeVariantPtrArgs

Arguments to use with the invoked method.

ret godot_variant

Value returned by the invoked method.

Returns

bool

SetSkeletonBoneName(StringName, StringName)

Maps a skeleton bone name to profileBoneName.

In the retargeting process, the setting bone name is the bone name of the source skeleton.

public void SetSkeletonBoneName(StringName profileBoneName, StringName skeletonBoneName)

Parameters

profileBoneName StringName
skeletonBoneName StringName

Events

BoneMapUpdated

This signal is emitted when change the key value in the BoneMap. This is used to validate mapping and to update BoneMap editor.

public event Action BoneMapUpdated

Event Type

Action

ProfileUpdated

This signal is emitted when change the value in profile or change the reference of profile. This is used to update key names in the BoneMap and to redraw the BoneMap editor.

public event Action ProfileUpdated

Event Type

Action
Edit this page