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.

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

Improve documentation for Model vs SkinnedModel vs AnimatedModel vs StaticModel. #1725

Open
wants to merge 3 commits into
base: master
Choose a base branch
from

Conversation

Menotdan
Copy link
Contributor

Since it was quite confusing.

@mafiesto4 mafiesto4 added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 17, 2023
@mafiesto4
Copy link
Member

What about using Animated Model/Static Model instead of AnimatedModel/StaticModel for Editor Display label?

@Menotdan
Copy link
Contributor Author

What about using Animated Model/Static Model instead of AnimatedModel/StaticModel for Editor Display label?

Maybe, but I was trying to make clear the connection between the class and the display in the editor.

@MineBill
Copy link
Contributor

MineBill commented Oct 17, 2023

I think this change might make it even more confusing because while there is an actor named "StaticModel", the model asset that it uses will be displayed under a "StaticModel" header in the properties. If this PR is a response to the discussion in the #scripting discord channel yesterday, i think the biggest issue is people assuming(and rightly so) that the panels in the properties window represent components, while in reality they are just groupings of properties the actor has. This is a bigger issue and requires much more detailed docs explaining that actors use a hierarchy and need the appropriate handling while scripts act more like components.

@Menotdan
Copy link
Contributor Author

I think this change might make it even more confusing because while there is an actor named "StaticModel", the model asset that it uses will be displayed under a "StaticModel" header in the properties. If this PR is a response to the discussion in the #scripting discord channel yesterday, i think the biggest issue is people assuming(and rightly so) that the panels in the properties window represent components, while in reality they are just groupings of properties the actor has. This is a bigger issue and requires much more detailed docs explaining that actors use a hierarchy and need the appropriate handling while scripts act more like components.

How about "StaticModel Properties" and "AnimatedModel Properties"? I think a change should take place in the editor display somehow, because I have seen many people get confused by the current naming.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants