Struct Progress 

pub struct Progress { /* private fields */ }

Kept as one set of names per list rather than one set of kind:name keys: the stage list asks after every tile every frame, and a key built for each lookup was a hundred-odd allocations a frame on a screen where nothing moves.

Implementations

impl Progress

pub fn is_cleared(&self, kind: CampaignKind, name: &str) -> bool

pub fn mark(&mut self, kind: CampaignKind, name: &str) -> bool

Records a clear; true when this was the first time.

pub fn cleared_count(&self) -> usize

How many stages are cleared, over both lists.

pub fn clear_all(&mut self)

Forget every cleared stage, both lists at once: they share this one record, and half a reset would leave Beach Day open on a beach the player just asked to start over.

pub fn unlocked(&self, campaign: &Campaign, index: usize) -> bool

The classic rule: the first stage is always open, so is any stage you have already cleared, so is the one right after a cleared stage. Player-made levels sit past the built-ins and are never locked: they are yours, and the editor plays them anyway.

pub fn cleared_in(&self, campaign: &Campaign, range: Range<usize>) -> usize

How many of this list’s stages are cleared, over one shelf of it. The stage select counts the shipped campaign and the player’s own levels separately: they are two lists on one screen, and one bar over both of them measured nothing in particular.

pub fn furthest_open(&self, campaign: &Campaign) -> usize

The furthest stage that is open to play, for resuming the list.

pub fn to_text(&self) -> String

pub fn parse(text: &str) -> Progress

Lenient parse, in the style of the other save files: anything that is not a cleared: line naming a list this build has is ignored rather than fatal.

Trait Implementations

impl Component for Progress

where Self: Send + Sync + 'static,

const STORAGE_TYPE: StorageType = ::bevy::ecs::component::StorageType::SparseSet

A constant indicating the storage type used for this component.

type Mutability = Mutable

A marker type to assist Bevy with determining if this component is mutable, or immutable. Mutable components will have Component<Mutability = Mutable>, while immutable components will instead have Component<Mutability = Immutable>.

fn register_required_components( _requiree: ComponentId, required_components: &mut RequiredComponentsRegistrator<'_, '_>, )

Registers required components.

fn clone_behavior() -> ComponentCloneBehavior

Called when registering this component, allowing to override clone function (or disable cloning altogether) for this component.

fn relationship_accessor() -> Option<ComponentRelationshipAccessor<Self>>

Returns ComponentRelationshipAccessor required for working with relationships in dynamic contexts.

fn on_add() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_add ComponentHook for this Component if one is defined.

fn on_insert() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_insert ComponentHook for this Component if one is defined.

fn on_discard() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_discard ComponentHook for this Component if one is defined.

fn on_remove() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_remove ComponentHook for this Component if one is defined.

fn on_despawn() -> Option<for<'w> fn(DeferredWorld<'w>, HookContext)>

Gets the on_despawn ComponentHook for this Component if one is defined.

fn map_entities<E>(_this: &mut Self, _mapper: &mut E)

where E: EntityMapper,

Maps the entities on this component using the given EntityMapper. This is used to remap entities in contexts like scenes and entity cloning. When deriving Component, this is populated by annotating fields containing entities with #[entities]

impl Default for Progress

fn default() -> Progress

Returns the “default value” for a type.

impl Resource for Progress

where Self: Send + Sync + 'static,