State

Struct State 

Source
pub struct State;
Expand description

The main server state.

This struct is passed to systems and event handlers. It provides access to entities, components, blocks, resources, etc.

Implementations§

Source§

impl State

Source

pub fn entity(&self, _id: EntityId) -> Result<EntityRef, EntityDead>

Gets an EntityRef from an EntityId.

Returns an error if the entity no longer exists.

Source

pub fn block(&self, _pos: BlockPosition) -> Result<BlockId, ChunkNotLoaded>

Gets the block at the given position.

Returns an error if the block’s chunk is not loaded.

Source

pub fn set_block( &self, _pos: BlockPosition, _block: BlockId, ) -> Result<(), ChunkNotLoaded>

Sets the block at the given position.

Returns an error if the block’s chunk is not loaded.

Source

pub fn resource<T: Resource>(&self) -> Result<&T, MissingResource>

Gets a reference to a resource.

Returns an error if the resource does not exist.

Source

pub fn resource_mut<T: Resource>(&self) -> Result<&mut T, MissingResource>

Gets a mutable reference to a resource.

Returns an error if the resource does not exist.

Source§

impl State

Source

pub fn player_by_name(&self, _name: &str) -> Option<EntityRef>

Gets an online player by their username.

Source

pub fn entity_by_uuid(&self, _uuid: Uuid) -> Option<EntityRef>

Gets an online entity by their UUID.

This function works for all entities, not just players.

Trait Implementations§

Source§

impl Debug for State

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl Freeze for State

§

impl RefUnwindSafe for State

§

impl Send for State

§

impl Sync for State

§

impl Unpin for State

§

impl UnwindSafe for State

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<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, 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<T> Component for T
where T: Send + Sync + 'static,

Source§

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