Struct akashi::Player

pub struct Player { /* fields omitted */ }

Represents a player / user.

Strictly speaking, this is just a minimal Entity object.

Methods

impl Player

pub fn new(
    id: Snowflake,
    component_manager: Arc<ComponentManager<Player>>,
    components_attached: HashSet<TypeId>
) -> Player

Create a new Player instance.

pub fn empty(
    snowflake_gen: &mut SnowflakeGenerator,
    component_manager: Arc<ComponentManager<Player>>
) -> Player

Create an 'empty' Player instance with no attached Components and a randomly-generated ID.

pub fn id(&self) -> Snowflake

Get this Player's unique ID.

pub fn component_manager(&self) -> &ComponentManager<Player>

Get a reference to this Player's associated ComponentManager.

Trait Implementations

impl Clone for Player

fn clone(&self) -> Player

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Component<Player> for Inventory

impl Component<Player> for Vec<Snowflake>

impl Component<Player> for Resource

impl Debug for Player

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

Formats the value using the given formatter.

impl Entity for Player

fn new(
    id: Snowflake,
    cm: Arc<ComponentManager<Self>>,
    components: HashSet<TypeId>
) -> Self

fn id(&self) -> Snowflake

Gets the unique ID used to identify this Entity and its Components.

fn component_manager(&self) -> &ComponentManager<Player>

Gets a reference to the ComponentManager used to perform operations on this Entity.

fn components_attached(&self) -> &HashSet<TypeId>

Gets a reference to a HashSet containing the TypeIds of each Component attached to this Entity.

fn components_attached_mut(&mut self) -> &mut HashSet<TypeId>

Gets a mutable reference to the HashSet of attached component TypeIds.

fn dirty(&self) -> bool

Checks whether any Components have been modified on this Entity.

fn dirty_mut(&mut self) -> &mut bool

Get this entity's 'dirty' flag.

fn get_component<T: Component<Self> + 'static>(
    &self
) -> Result<Option<T>, Error>

Gets a Component attached to this Entity.

fn set_component<T: Component<Self> + 'static>(
    &mut self,
    component: T
) -> Result<(), Error>

Attaches a Component to this Entity, or updates an already-attached Component.

fn has_component<T: Component<Self> + 'static>(&self) -> bool

Checks to see if the given Component type has been attached to this Entity.

fn delete_component<T: Component<Self> + 'static>(
    &mut self
) -> Result<(), Error>

Deletes an attached Component from this Entity.

fn clear_components(&mut self) -> Result<(), ClearComponentsError>

Delete all Components attached to this Entity.

impl PartialEq<Player> for Player

fn eq(&self, other: &Self) -> bool

This method tests for self and other values to be equal, and is used by ==.

#[must_use] fn ne(&self, other: &Rhs) -> bool

This method tests for !=.