From 20a23cd8cb6de08a599bcad770e4187eb29433aa Mon Sep 17 00:00:00 2001 From: Tigran <122690491+TigranExe@users.noreply.github.com> Date: Sun, 15 Jan 2023 12:54:20 -0500 Subject: Updated SkeletonProfile's main and property descriptions Updated SkeletonProfile's main and property descriptions -Description now has note about read only quality -"bone_size" and "group_size" property descriptions have been added and clarified. -Property descriptions refer to BoneMap page instead of [code]bone_map[/code] from [Retargeting 3d skeletons](https://docs.godotengine.org/en/latest/tutorials/assets_pipeline/retargeting_3d_skeletons.html#bone-map). -all property descriptions now do not have any Notes to split them -TokageItLab clarifies property descriptions to highlight their use Co-Authored-By: Silc 'Tokage' Renew --- doc/classes/SkeletonProfile.xml | 11 +++++++---- 1 file changed, 7 insertions(+), 4 deletions(-) diff --git a/doc/classes/SkeletonProfile.xml b/doc/classes/SkeletonProfile.xml index 57bdd52d9e..6fb311bcee 100644 --- a/doc/classes/SkeletonProfile.xml +++ b/doc/classes/SkeletonProfile.xml @@ -5,6 +5,7 @@ This resource is used in [EditorScenePostImport]. Some parameters are referring to bones in [Skeleton3D], [Skin], [Animation], and some other nodes are rewritten based on the parameters of [SkeletonProfile]. + [b]Note:[/b] These parameters need to be set only when creating a custom profile. In [SkeletonProfileHumanoid], they are defined internally as read-only values. $DOCS_URL/tutorials/assets_pipeline/retargeting_3d_skeletons.html @@ -160,16 +161,18 @@ + The amount of bones in retargeting section's [BoneMap] editor. For example, [SkeletonProfileHumanoid] has 56 bones. + The size of elements in [BoneMap] updates when changing this property in it's assigned [SkeletonProfile]. + The amount of groups of bones in retargeting section's [BoneMap] editor. For example, [SkeletonProfileHumanoid] has 4 groups. + This property exists to separate the bone list into several sections in the editor. - A name of bone that will be used as the root bone in [AnimationTree]. - [b]Note:[/b] In most cases, it is the bone of the parent of the hips that exists at the world origin in the humanoid model. + A bone name that will be used as the root bone in [AnimationTree]. This should be the bone of the parent of hips that exists at the world origin. - A name of bone which height will be used as the coefficient for normalization. - [b]Note:[/b] In most cases, it is hips in the humanoid model. + A bone name which will use model's height as the coefficient for normalization. For example, [SkeletonProfileHumanoid] defines it as [code]Hips[/code]. -- cgit v1.2.3