-
-
Notifications
You must be signed in to change notification settings - Fork 3.5k
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
Document and rename bevy::scene::Entity #3233
Comments
Yup I generally try to treat Bevy as a "global namespace" and this very clearly breaks that rule of thumb. |
We get a Line 53 in ccee658
(However, we get a |
I've added the |
How can Bevy's documentation be improved?
This type (docs, source) appears to be used to store reflected entities, along with their components in scenes. However, it is a) completely lacking documentation b) very confusingly named:
Entity
is one of our most important types, and this is closely-related but distinct in important ways.At a glance, this seems to be a reflection-powered serializable representation of an entity and its components. The
entity: u32
field is likely for use withEntity::new()
(the standardEntity
type), and the entireDynamicScene
type is used to spawn groups of entities which contain a number of entities, each with their own run-time defined set of components. TheseDynamicScenes
can be written to file, but not read from.Later in the same file,
EntityMap
is used, which contains a map between entities, in the standardbevy_ecs
sense. This naming convention seems to be fine.My first impulse would be to call this
DynamicEntity
, but please, bikeshed me if you disagree.The text was updated successfully, but these errors were encountered: