Struct bevy::ecs::schedule::SystemDescriptor

pub struct SystemDescriptor { /* private fields */ }

Encapsulates a system and information on when it run in a SystemStage.

Systems can be inserted into 4 different groups within the stage:

• Parallel, accepts non-exclusive systems.
• At start, accepts exclusive systems; runs before parallel systems.
• Before commands, accepts exclusive systems; runs after parallel systems, but before their command buffers are applied.
• At end, accepts exclusive systems; runs after parallel systems’ command buffers have been applied.

Systems can have one or more labels attached to them; other systems in the same group can then specify that they have to run before or after systems with that label using the before and after methods.

Example

#[derive(SystemLabel, Debug, Clone, PartialEq, Eq, Hash)]
struct Something;

SystemStage::parallel()
    .with_system(do_something.label(Something))
    .with_system(do_the_other_thing.after(Something))
    .with_system(do_something_else.at_end());

Trait Implementations

impl Debug for SystemDescriptor

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl IntoSystemDescriptor<()> for SystemDescriptor

fn with_run_criteria<Marker>(
    self,
    run_criteria: impl IntoRunCriteria<Marker>
) -> SystemDescriptor

Assigns a run criteria to the system. Can be a new descriptor or a label of a run criteria defined elsewhere.

fn label(self, label: impl SystemLabel) -> SystemDescriptor

Assigns a label to the system; there can be more than one, and it doesn’t have to be unique.

fn before<Marker>(self, label: impl AsSystemLabel<Marker>) -> SystemDescriptor

Specifies that the system should run before systems with the given label.

fn after<Marker>(self, label: impl AsSystemLabel<Marker>) -> SystemDescriptor

Specifies that the system should run after systems with the given label.

fn ambiguous_with<Marker>(
    self,
    label: impl AsSystemLabel<Marker>
) -> SystemDescriptor

Marks this system as ambiguous with any system with the specified label. This means that execution order between these systems does not matter, which allows some warnings to be silenced.

fn ignore_all_ambiguities(self) -> SystemDescriptor

Specifies that this system should opt out of execution order ambiguity detection.

fn at_start(self) -> SystemDescriptor

Specifies that the system should run with other exclusive systems at the start of stage.

fn before_commands(self) -> SystemDescriptor

Specifies that the system should run with other exclusive systems after the parallel systems and before command buffer application.

fn at_end(self) -> SystemDescriptor

Specifies that the system should run with other exclusive systems at the end of stage.

fn into_descriptor(self) -> SystemDescriptor