Struct bevy_state_curves::ObjectState

pub struct ObjectState { /* private fields */ }

A component that contains all of this ObjectIds curves

Implementations

impl ObjectState

pub fn new(tick: GameTick) -> Self

Constructs a new empty ObjectState

pub fn created_tick(&self) -> GameTick

Returns the tick that this Object was created

pub fn destroyed_tick(&self) -> Option<GameTick>

Returns the tick that this Object was destroyed

pub fn is_destroyed(&self) -> bool

Returns whether this object has been destroyed or not

pub fn is_alive(&self) -> bool

Returns whether this object is still alive or not

pub fn destroy(&mut self, tick: GameTick)

Sets the tick that this object has been destroyed on

pub fn get_curves(&self, curve_name: &str) -> Option<&(CurveInfo, CurveData)>

Gets a reference to the CurveData of this object

pub fn register_new_curve( &mut self, curve_name: &str, curve_type: CurveType, component_type_name: String )

Registers a new curve under the given curve_name with the given curve_type for the given component_type_name. Is automatically called by [add_keyframe] as needed

pub fn add_keyframe( &mut self, curve_name: &str, tick: GameTick, keyframe: CurveKeyFrame )

Adds a new keyframe to the curve for the given GameTick.

Panics

• If the insert keyframe does not match the registered component type

TODO: See if theres a way to make this generic to accept a T of any keyframe and it automatically inserts it

pub fn add_stepped_keyframe<T: SteppedKeyframe>( &mut self, curve_name: &str, tick: GameTick, keyframe: T )

Helper function to insert a [SteppedKeyFrame] into a curve for a specific tick

pub fn add_linear_keyframe<T: LinearKeyFrame>( &mut self, curve_name: &str, tick: GameTick, keyframe: T )

Helper function to insert a LinearKeyFrame into a curve for a specific tick

pub fn add_pulse_keyframe<T: PulseKeyframe>( &mut self, curve_name: &str, tick: GameTick, keyframe: T )

Helper function to insert a PulseKeyframe into a curve for a specific tick

pub fn remove_keyframe(&mut self, curve_name: &str, tick: GameTick)

Removes the keyframe from the given GameTick and returns it if it exists.

Silently fails if the curve has not been registered or if the keyframe does not exist

pub fn get_keyframes_in_tick( &self, tick: GameTick ) -> Vec<(String, CurveKeyFrame)>

Returns all keyframes that exist in this tick.

Note

This does NOT return an accurate state of the object for the given tick. This just returns all keyframes that exists in the given tick. Use ObjectState::get_object_state_for_tick to get the canonical state for a tick.

pub fn get_object_state_for_tick( &self, tick: GameTick ) -> Vec<(String, CurveKeyFrame)>

Returns a vec of what the calculated objects state should be for this tick

Trait Implementations

impl Component for ObjectStatewhere Self: Send + Sync + 'static,

type Storage = TableStorage

A marker type indicating the storage type used for this component. This must be either [TableStorage] or [SparseStorage].