-
Notifications
You must be signed in to change notification settings - Fork 17
update readme to add section on with_hot_patch #20
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
Open
MalekiRe
wants to merge
1
commit into
main
Choose a base branch
from
malek/readme_update
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -175,6 +175,31 @@ Now try changing that string at runtime and then check your logs! | |
| Note that changing the `greet` function's signature at runtime by e.g. adding a new parameter will still require a restart. | ||
| In general, you can only change the code *inside* the function at runtime. See the *Advanced Usage* section for more. | ||
|
|
||
| ## Alternative Method | ||
| ```rust,ignore | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. To keep the readme slim, can we put this behind |
||
| use bevy::prelude::*; | ||
| use bevy_simple_subsecond_system::prelude::*; | ||
|
|
||
| fn main() -> AppExit { | ||
| App::new() | ||
| .add_plugins(DefaultPlugins) | ||
| .add_plugins(SimpleSubsecondPlugin::default()) | ||
| .with_hot_patch(|app: &mut App| { | ||
| app.add_systems(Update, greet) | ||
| }) | ||
| .run() | ||
| } | ||
|
|
||
| fn greet(time: Res<Time>) { | ||
| info_once!( | ||
| "Hello from a hotpatched system! Try changing this string while the app is running! Patched at t = {} s", | ||
| time.elapsed_secs() | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| This method allows you to add/remove new systems at runtime. See `examples/add_systems` for more info. | ||
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Also worth noting that you're allowed to change signatures at runtime, too :) |
||
|
|
||
| ## Examples | ||
|
|
||
| Run the examples with | ||
|
|
||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could you add its caveats? I think
Resources andLocal/EventReaders should be noted there