Skip to main content

World

Struct World 

Source
pub struct World {
    pub globals: Vec<Value>,
    pub visit_counts: HashMap<DefinitionId, u32>,
    pub turn_counts: HashMap<DefinitionId, u32>,
    pub turn_index: u32,
    pub rng_seed: i32,
    pub previous_random: i32,
    /* private fields */
}
Expand description

Shared game state that lives above individual flows.

Holds globals, visit/turn tracking, and RNG state. This is the natural serialization boundary for save/load (deferred).

Multiple FlowInstances can share a single World (matching inklecate’s semantics where flow writes are immediately visible to other flows), or each flow can hold its own cloned World if the consumer wants fork/branch/rollback semantics. The runtime’s step functions take &mut World (or any &mut impl ContextAccess) without prescribing where it lives.

Fields§

§globals: Vec<Value>§visit_counts: HashMap<DefinitionId, u32>§turn_counts: HashMap<DefinitionId, u32>§turn_index: u32§rng_seed: i32§previous_random: i32

Implementations§

Source§

impl World

Source

pub fn new(program: &Program, policy: &WorldPolicy) -> Result<Self, PolicyError>

Create a fresh World for program, resolving policy against the program’s symbol table.

Globals are initialized from the program’s declared defaults; visit counts, turn counts, turn index, and RNG state start zeroed — identical to FlowInstance::new_at’s inline construction. Fails if policy names a variable or knot/stitch the program doesn’t declare (PolicyError::UnknownName).

WorldPolicy::default() (all-World) always resolves — see ResolvedPolicy::all_world — so passing it here can’t produce a PolicyError.

Source

pub fn new_for_testing( globals: Vec<Value>, visit_counts: HashMap<DefinitionId, u32>, turn_counts: HashMap<DefinitionId, u32>, turn_index: u32, rng_seed: i32, previous_random: i32, ) -> Self

Construct a World directly from its field values, with the all-World policy. Only for test fixtures that need to hand-build a World without a Program (e.g. bevy-brink’s commit-merge tests) — production code should go through World::new.

Trait Implementations§

Source§

impl Clone for World

Source§

fn clone(&self) -> World

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl ContextAccess for World

Source§

fn global(&self, idx: u32) -> &Value

Source§

fn set_global(&mut self, idx: u32, value: Value)

Source§

fn visit_count(&self, id: DefinitionId) -> u32

Source§

fn increment_visit(&mut self, id: DefinitionId)

Source§

fn set_visit_count(&mut self, id: DefinitionId, count: u32)

Set a visit count directly, rather than incrementing it. Used by crate::load_state to reconcile a durable save, whose entries carry absolute counts rather than deltas.
Source§

fn turn_count(&self, id: DefinitionId) -> Option<u32>

Source§

fn set_turn_count(&mut self, id: DefinitionId, turn: u32)

Source§

fn turn_index(&self) -> u32

Source§

fn increment_turn_index(&mut self)

Source§

fn set_turn_index(&mut self, index: u32)

Set the turn index directly, rather than incrementing it. Used by crate::load_state to restore a saved turn index.
Source§

fn rng_seed(&self) -> i32

Source§

fn set_rng_seed(&mut self, seed: i32)

Source§

fn previous_random(&self) -> i32

Source§

fn set_previous_random(&mut self, val: i32)

Source§

fn next_random<R: StoryRng>(&self, seed: i32) -> i32

Source§

fn random_sequence<R: StoryRng>(&self, seed: i32, count: usize) -> Vec<i32>

Source§

impl Debug for World

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for World

§

impl RefUnwindSafe for World

§

impl Send for World

§

impl Sync for World

§

impl Unpin for World

§

impl UnsafeUnpin for World

§

impl UnwindSafe for World

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.