From 915199243235db8d380ee6eaa3b0d177aec7589c Mon Sep 17 00:00:00 2001
From: seenloitering <55366994+seenloitering@users.noreply.github.com>
Date: Wed, 5 Feb 2020 07:19:27 -0500
Subject: [PATCH] Add documentation for Skeleton2D
Signal bone_setup_changed remains undocumented. I took a quick look at
the cpp code, but its purpose remained unclear to me. If anyone can
steer me in the right direction, I'm happy to flesh this out.
---
doc/classes/Skeleton2D.xml | 5 ++++-
1 file changed, 4 insertions(+), 1 deletion(-)
diff --git a/doc/classes/Skeleton2D.xml b/doc/classes/Skeleton2D.xml
index ccae59d72c0..558ba840686 100644
--- a/doc/classes/Skeleton2D.xml
+++ b/doc/classes/Skeleton2D.xml
@@ -4,6 +4,7 @@
Skeleton for 2D characters and animated objects.
+ Skeleton2D parents a hierarchy of [Bone2D] objects. It is a requirement of [Bone2D]. Skeleton2D holds a reference to the rest pose of its children and acts as a single point of access to its bones.
https://docs.godotengine.org/en/latest/tutorials/animation/2d_skeletons.html
@@ -15,19 +16,21 @@
+ Returns a [Bone2D] from the node hierarchy parented by Skeleton2D. The object to return is identified by the parameter [code]idx[/code]. Bones are indexed by descending the node hierarchy from top to bottom, adding the children of each branch before moving to the next sibling.
- Returns the amount of bones in the skeleton.
+ Returns the number of [Bone2D] nodes in the node hierarchy parented by Skeleton2D.
+ Returns the [RID] of a Skeleton2D instance.