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

Jump to bottom

Mention DynamicSceneBuilder in scene example #10441

Merged
merged 1 commit into from
Nov 30, 2023
Merged

Mention DynamicSceneBuilder in scene example #10441

merged 1 commit into from
Nov 30, 2023

Conversation

thepackett
Copy link
Contributor

Objective

Make DynamicSceneBuilder more visible to new bevy learners!
DynamicSceneBuilder is likely to be the most appropriate tool to use when creating dynamic scenes in all but the simplest scenarios. However, it's not mentioned in the scene example. This PR aims to fix this.

Solution

I've modified the comment above where the DynamicScene is created to note that DynamicSceneBuilder can also be used to create the scene. I believe this is the best approach to introduce DynamicSceneBuilder without adding additional complexity to the example.

@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Nov 8, 2023

Welcome, new contributor!

Please make sure you've read our contributing guide and we look forward to reviewing your pull request shortly ✨

alice-i-cecile
alice-i-cecile approved these changes Nov 8, 2023
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

I'd definitely like more examples in this folder, but this is a good place to start :)

@alice-i-cecile alice-i-cecile added A-Scenes Serialized ECS data stored on the disk C-Examples An addition or correction to our examples labels Nov 8, 2023
@Azorlogh
Copy link
Contributor

It would be nice to mention it in the rustdoc comment too I think
https:/bevyengine/bevy/blob/92bbc79bc9cae7c314319149566d45b7b139437c/crates/bevy_scene/src/dynamic_scene.rs#L18C12-L18C12

james7132
james7132 approved these changes Nov 26, 2023
View reviewed changes
Copy link
Member

@james7132 james7132 left a comment

Choose a reason for hiding this comment

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

I agree with @Azorlogh, but will not block on it.

@james7132 james7132 added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Nov 26, 2023
@alice-i-cecile alice-i-cecile mentioned this pull request Nov 28, 2023
Closed
@alice-i-cecile
Copy link
Member

Can you please rebase / merge in main to get the latest CI check running on your PR?

@alice-i-cecile
Copy link
Member

The mentioned comment is being added in #10780

@thepackett
Copy link
Contributor Author

Can you please rebase / merge in main to get the latest CI check running on your PR?

Sorry for the delay. I'm not super familiar with git, but I believe I have rebased scene-example-addition to bevy/main, and the CI is running.

@alice-i-cecile
Copy link
Member

I think this merge has gone a little awry <3
image

Resetting to 92bbc79 and then force pushing would be what I would do to fix this.

@thepackett
Copy link
Contributor Author

image

What can I say, I really want users to know about DynamicSceneBuilder.

Resetting to 92bbc79 and then force pushing would be what I would do to fix this.

Jokes aside, I reset and pushed as you suggested, and I believe it is correct now. Thank you for being patient with me.

@alice-i-cecile
Copy link
Member

All good! Thanks for fighting git for us :)

@alice-i-cecile alice-i-cecile added this pull request to the merge queue Nov 30, 2023
Merged via the queue into bevyengine:main with commit e581d74 Nov 30, 2023
47 checks passed
james7132 pushed a commit to james7132/bevy that referenced this pull request Dec 1, 2023
@thepackett @james7132
Mention DynamicSceneBuilder in scene example (bevyengine#10441)
3db7137 
# Objective

Make ```DynamicSceneBuilder``` more visible to new bevy learners!
```DynamicSceneBuilder``` is likely to be the most appropriate tool to use when creating dynamic scenes in all but the simplest scenarios. However, it's not mentioned in the scene example. This PR aims to fix this.

## Solution

I've modified the comment above where the ```DynamicScene``` is created to note that ```DynamicSceneBuilder``` can also be used to create the scene. I believe this is the best approach to introduce ```DynamicSceneBuilder``` without adding additional complexity to the example.
@thepackett thepackett deleted the scene-example-addition branch December 20, 2023 15:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@james7132 james7132 james7132 approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-Scenes Serialized ECS data stored on the disk C-Examples An addition or correction to our examples S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@thepackett @Azorlogh @alice-i-cecile @james7132