Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added remaining animation-related class reference docs #82713

Closed
wants to merge 1 commit into from
Closed

Added remaining animation-related class reference docs #82713

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/classes/AnimationLibrary.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@
</methods>
<members>
<member name="_data" type="Dictionary" setter="_set_data" getter="_get_data" default="{}">
Contains a [Dictionary] of [Animation] resources.
</member>
Comment on lines 58 to 60
Copy link
Member

@akien-mga akien-mga Oct 3, 2023 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a bug that a member starting with an underscore is exposed.

Sounds like this was just meant to serialization, not public access?

CC @godotengine/animation

But well now that it's been exposed I'm not sure we can take it back without breaking compat.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it would be fine. It needs to have its usage changed to PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL. If it needs to be exposed, it needs to be renamed anyway. So we'd be breaking compatibility.

If we do neither, we risk it being accidentally unexposed if we, say, fix the fact that an underscored member is added to the docs (it should be stripped from XMLs by the doctool, the fact that it's not is a bug).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I made #84376

</members>
<signals>
Expand Down
1 change: 1 addition & 0 deletions doc/classes/AnimationNodeStateMachine.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,7 @@
<param index="0" name="name" type="StringName" />
<param index="1" name="node" type="AnimationNode" />
<description>
Replaces the specified animation node with a new animation node.
</description>
</method>
<method name="set_graph_offset">
Expand Down