Skip to main content

StaticSystemParam

Struct StaticSystemParam 

Source
pub struct StaticSystemParam<S: SystemParamState> { /* private fields */ }
Expand description

A system parameter that provides access to its inner state directly.

StaticSystemParam is useful when you want to store data in the parameter state and access it during system execution. Unlike Local<T>, this stores the data in the system’s state rather than per-system instance.

§Example

use goud_engine::ecs::World;
use goud_engine::ecs::query::Access;
use goud_engine::ecs::system::{SystemParam, SystemParamState, StaticSystemParam};

// State that tracks how many times the system ran
#[derive(Default)]
struct RunCountState {
    count: u32,
}

impl SystemParamState for RunCountState {
    fn init(_world: &mut World) -> Self {
        Self::default()
    }
}

// The parameter type
type RunCount = StaticSystemParam<RunCountState>;

Trait Implementations§

Source§

impl<S: Debug + SystemParamState> Debug for StaticSystemParam<S>

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<S: SystemParamState + 'static> SystemParam for StaticSystemParam<S>

Source§

type State = StaticSystemParamState<S>

The cached state for this parameter. Read more
Source§

type Item<'w, 's> = &'s mut S

The type of value this parameter produces. Read more
Source§

fn update_access(_state: &Self::State, _access: &mut Access)

Updates the access pattern for this parameter. Read more
Source§

fn get_param<'w, 's>( state: &'s mut Self::State, _world: &'w World, ) -> Self::Item<'w, 's>

Extracts the parameter value from the World. Read more
Source§

fn get_param_mut<'w, 's>( state: &'s mut Self::State, world: &'w mut World, ) -> Self::Item<'w, 's>

Extracts the parameter value from a mutable World reference. Read more

Auto Trait Implementations§

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<S> FromSample<S> for S

Source§

fn from_sample_(s: S) -> S

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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<F, T> IntoSample<T> for F
where T: FromSample<F>,

Source§

fn into_sample(self) -> T

Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> ToSample<U> for T
where U: FromSample<T>,

Source§

fn to_sample_(self) -> U

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.
Source§

impl<S, T> Duplex<S> for T
where T: FromSample<S> + ToSample<S>,

Source§

impl<T> Event for T
where T: Send + Sync + 'static,

Source§

impl<T> Resource for T
where T: Send + Sync + 'static,