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

[Merged by Bors] - Remove AssetServer::watch_for_changes() #5968

Closed
wants to merge 6 commits into from
Closed

[Merged by Bors] - Remove AssetServer::watch_for_changes() #5968

wants to merge 6 commits into from

Conversation

tim-blackbird
Copy link
Contributor

@tim-blackbird tim-blackbird commented Sep 12, 2022 •
edited
Loading

Objective

AssetServer::watch_for_changes() is racy and redundant with AssetServerSettings.
Closes #5964.

Changelog

  • Remove AssetServer::watch_for_changes()
  • Add AssetServerSettings to the prelude.
  • Minor cleanup.

Migration Guide

AssetServer::watch_for_changes() was removed.
Instead, use the AssetServerSettings resource.

app // AssetServerSettings must be inserted before adding the AssetPlugin or DefaultPlugins.
	.insert_resource(AssetServerSettings {
		watch_for_changes: true,
		..default()
	})

@IceSentry IceSentry added A-Rendering Drawing game state to the screen M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide A-Assets Load files from disk to use for things like images, models, and sounds and removed A-Rendering Drawing game state to the screen labels Sep 12, 2022
nicopap
nicopap approved these changes Sep 12, 2022
View reviewed changes
Copy link
Contributor

@nicopap nicopap left a comment •
edited
Loading

Choose a reason for hiding this comment

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

LGTM, but could we have a

impl AssetServerSettings {
  fn hot_reloading() -> Self { Self { watch_for_changes: true, ..default } }
}

method so that enabling hot reloading doesn't require 4 lines of boilerplate?

Maybe consider deprecating?

IceSentry
IceSentry approved these changes Sep 12, 2022
View reviewed changes
examples/shader/post_processing.rs Outdated
let mut app = App::new();
app.add_plugins(DefaultPlugins)
App::new()
.insert_resource(AssetServerSettings {
Copy link
Contributor

Choose a reason for hiding this comment

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

I'm not sure this example actually needs this. It's not necessary to showcase post_processing. I think people should just add it manually if they want to play with it. Otherwise we might as well just add it to all examples with assets.

Same thing applies for the shader_instancing example

@tim-blackbird
Copy link
Contributor Author

could we have a method so that enabling hot reloading doesn't require 4 lines of boilerplate?

It's tempting to add a method like that, but then it becomes awkward when trying to set other settings, requiring a refactor.

Maybe consider deprecating?

Francois argues that we should just break things. It makes sense to me to avoid the maintenance cost of deprecation :)

@rparrett rparrett 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 Sep 13, 2022
@alice-i-cecile
Copy link
Member

bors r+

bors bot pushed a commit that referenced this pull request Sep 19, 2022
@tim-blackbird
Remove AssetServer::watch_for_changes() (#5968)
4f879ae 
# Objective
`AssetServer::watch_for_changes()` is racy and redundant with `AssetServerSettings`.
Closes #5964.

## Changelog

* Remove `AssetServer::watch_for_changes()`
* Add `AssetServerSettings` to the prelude.
* Minor cleanup.

## Migration Guide
`AssetServer::watch_for_changes()` was removed.
Instead, use the `AssetServerSettings` resource.
```rust
app // AssetServerSettings must be inserted before adding the AssetPlugin or DefaultPlugins.
	.insert_resource(AssetServerSettings {
		watch_for_changes: true,
		..default()
	})
```


Co-authored-by: devil-ira <[email protected]>
@bors
Copy link
Contributor

bors bot commented Sep 19, 2022

Build failed (retrying...):

bors bot pushed a commit that referenced this pull request Sep 19, 2022
@tim-blackbird
Remove AssetServer::watch_for_changes() (#5968)
3df6be2 
# Objective
`AssetServer::watch_for_changes()` is racy and redundant with `AssetServerSettings`.
Closes #5964.

## Changelog

* Remove `AssetServer::watch_for_changes()`
* Add `AssetServerSettings` to the prelude.
* Minor cleanup.

## Migration Guide
`AssetServer::watch_for_changes()` was removed.
Instead, use the `AssetServerSettings` resource.
```rust
app // AssetServerSettings must be inserted before adding the AssetPlugin or DefaultPlugins.
	.insert_resource(AssetServerSettings {
		watch_for_changes: true,
		..default()
	})
```


Co-authored-by: devil-ira <[email protected]>
@bors
Copy link
Contributor

bors bot commented Sep 19, 2022

Build failed (retrying...):

bors bot pushed a commit that referenced this pull request Sep 19, 2022
@tim-blackbird
Remove AssetServer::watch_for_changes() (#5968)
28205fd 
# Objective
`AssetServer::watch_for_changes()` is racy and redundant with `AssetServerSettings`.
Closes #5964.

## Changelog

* Remove `AssetServer::watch_for_changes()`
* Add `AssetServerSettings` to the prelude.
* Minor cleanup.

## Migration Guide
`AssetServer::watch_for_changes()` was removed.
Instead, use the `AssetServerSettings` resource.
```rust
app // AssetServerSettings must be inserted before adding the AssetPlugin or DefaultPlugins.
	.insert_resource(AssetServerSettings {
		watch_for_changes: true,
		..default()
	})
```


Co-authored-by: devil-ira <[email protected]>
@bors
Copy link
Contributor

bors bot commented Sep 19, 2022

Pull request successfully merged into main.

Build succeeded:

@bors bors bot changed the title Remove AssetServer::watch_for_changes() [Merged by Bors] - Remove AssetServer::watch_for_changes() Sep 19, 2022
@bors bors bot closed this Sep 19, 2022
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 19, 2022
@tim-blackbird @james7132
Remove AssetServer::watch_for_changes() (bevyengine#5968)
256c895 
# Objective
`AssetServer::watch_for_changes()` is racy and redundant with `AssetServerSettings`.
Closes bevyengine#5964.

## Changelog

* Remove `AssetServer::watch_for_changes()`
* Add `AssetServerSettings` to the prelude.
* Minor cleanup.

## Migration Guide
`AssetServer::watch_for_changes()` was removed.
Instead, use the `AssetServerSettings` resource.
```rust
app // AssetServerSettings must be inserted before adding the AssetPlugin or DefaultPlugins.
	.insert_resource(AssetServerSettings {
		watch_for_changes: true,
		..default()
	})
```


Co-authored-by: devil-ira <[email protected]>
@tim-blackbird tim-blackbird deleted the yeet branch October 21, 2022 15:09
james7132 pushed a commit to james7132/bevy that referenced this pull request Oct 28, 2022
@tim-blackbird @james7132
Remove AssetServer::watch_for_changes() (bevyengine#5968)
04478cf 
# Objective
`AssetServer::watch_for_changes()` is racy and redundant with `AssetServerSettings`.
Closes bevyengine#5964.

## Changelog

* Remove `AssetServer::watch_for_changes()`
* Add `AssetServerSettings` to the prelude.
* Minor cleanup.

## Migration Guide
`AssetServer::watch_for_changes()` was removed.
Instead, use the `AssetServerSettings` resource.
```rust
app // AssetServerSettings must be inserted before adding the AssetPlugin or DefaultPlugins.
	.insert_resource(AssetServerSettings {
		watch_for_changes: true,
		..default()
	})
```


Co-authored-by: devil-ira <[email protected]>
@jakobhellermann jakobhellermann mentioned this pull request Nov 1, 2022
Closed
ItsDoot pushed a commit to ItsDoot/bevy that referenced this pull request Feb 1, 2023
@tim-blackbird @ItsDoot
Remove AssetServer::watch_for_changes() (bevyengine#5968)
00ba707 
# Objective
`AssetServer::watch_for_changes()` is racy and redundant with `AssetServerSettings`.
Closes bevyengine#5964.

## Changelog

* Remove `AssetServer::watch_for_changes()`
* Add `AssetServerSettings` to the prelude.
* Minor cleanup.

## Migration Guide
`AssetServer::watch_for_changes()` was removed.
Instead, use the `AssetServerSettings` resource.
```rust
app // AssetServerSettings must be inserted before adding the AssetPlugin or DefaultPlugins.
	.insert_resource(AssetServerSettings {
		watch_for_changes: true,
		..default()
	})
```


Co-authored-by: devil-ira <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@afonsolage afonsolage afonsolage approved these changes

@IceSentry IceSentry IceSentry approved these changes

@nicopap nicopap nicopap approved these changes

Assignees
No one assigned
Labels
A-Assets Load files from disk to use for things like images, models, and sounds M-Needs-Migration-Guide A breaking change to Bevy's public API that needs to be noted in a migration guide 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.

Hot reloading is broken in the post_processing example
6 participants
@tim-blackbird @alice-i-cecile @afonsolage @IceSentry @nicopap @rparrett