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

Document how to configure FixedUpdate #10564

Merged
merged 3 commits into from
Nov 16, 2023
Merged

Document how to configure FixedUpdate #10564

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
26c81d4
Document how to configure FixedUpdate
stepancheg Nov 15, 2023
5c857bf
Better doc link
alice-i-cecile Nov 15, 2023
eb254a5
Link to latest, not main
alice-i-cecile Nov 15, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions crates/bevy_app/src/main_schedule.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,9 @@ pub struct RunFixedUpdateLoop;
///
/// The exclusive `run_fixed_update_schedule` system runs this schedule.
/// This is run by the [`RunFixedUpdateLoop`] schedule.
///
/// Frequency of execution is configured by inserting `Time<Fixed>` resource, 64 Hz by default.
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we link to the time type with the generic? maybe as two links?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

bevy_app does not depend on bevy_time. We can only link to docs.rs I think?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hah, didn't expect that, but makes sense. I don't think we need to link to it then :)

/// See [this example](https://github.com/bevyengine/bevy/blob/latest/examples/time/time.rs).
#[derive(ScheduleLabel, Clone, Debug, PartialEq, Eq, Hash)]
pub struct FixedUpdate;

Expand Down