Struct Spawn 

pub struct Spawn { /* private fields */ }

Defines the initial state of a Character that is being created or moved into a Space.

TODO: This is lacking a full set of accessor methods to be viewable+editable.

Serialization stability warning

This type implements serde::Serialize and serde::Deserialize, but serialization support is still experimental (as is the game data model in general). We do not guarantee that future versions of all-is-cubes will be able to deserialize data which is serialized by this version.

Additionally, the serialization schema is designed with serde_json in mind. It is not guaranteed that using a different data format crate, which may use a different subset of the information exposed via serde::Serialize, will produce stable results.

Implementations

impl Spawn

pub fn default_for_new_space(bounds: GridAab) -> Self

Create the default Spawn configuration for a Space.

TODO: There is no good default, really: we don’t know if it is better to be outside the space looking in or to be within it at some particular position. Come up with some kind of hint that we can use to configure this better without necessarily mandating a specification.

pub fn set_eye_position(&mut self, position: impl Into<FreePoint>)

Sets the position at which the character will appear, in terms of its viewpoint.

pub fn set_bounds(&mut self, bounds: GridAab)

Sets the bounds within which the character may be placed is allowed.

pub fn set_look_direction(&mut self, direction: impl Into<FreeVector>)

Sets the direction the character should be facing, or looking at.

The results are unspecified but harmless if the direction is zero or NaN.

pub fn set_inventory(&mut self, inventory: Vec<Slot>)

Sets the starting inventory items.

Trait Implementations

impl<'arbitrary> Arbitrary<'arbitrary> for Spawn

fn arbitrary(u: &mut Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the given unstructured data.

fn arbitrary_take_rest(u: Unstructured<'arbitrary>) -> Result<Self>

Generate an arbitrary value of Self from the entirety of the given unstructured data.

fn size_hint(depth: usize) -> (usize, Option<usize>)

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

fn try_size_hint( depth: usize, ) -> Result<(usize, Option<usize>), MaxRecursionReached>

Get a size hint for how many bytes out of an Unstructured this type needs to construct itself.

impl Clone for Spawn

fn clone(&self) -> Spawn

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Spawn

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Spawn

Available on crate feature save only.

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Spawn

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

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Spawn

Available on crate feature save only.

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl VisitHandles for Spawn

fn visit_handles(&self, visitor: &mut dyn HandleVisitor)

For each Handle contained within self that is reachable without traversing another Handle, call visitor with a reference to it.

impl Eq for Spawn

impl StructuralPartialEq for Spawn