Struct all_is_cubes::block::BlockAttributes

pub struct BlockAttributes {
    pub display_name: ArcStr,
    pub selectable: bool,
    pub rotation_rule: RotationPlacementRule,
    pub tick_action: Option<TickAction>,
    pub activation_action: Option<Operation>,
    pub animation_hint: AnimationHint,
}

Collection of miscellaneous attribute data for blocks that doesn’t come in variants.

BlockAttributes::default() will produce a reasonable set of defaults for “ordinary” blocks.

Fields

display_name: ArcStr

The name that should be displayed to players.

The default value is the empty string. The empty string should be considered a reasonable choice for solid-color blocks with no special features.

selectable: bool

Whether players’ cursors target it or pass through it.

The default value is true.

rotation_rule: RotationPlacementRule

Rule about how this block should be rotated, or not, when placed in a Space by some agent not otherwise specifying rotation.

The default value is RotationPlacementRule::Never.

tick_action: Option<TickAction>

Something this block does when time passes.

activation_action: Option<Operation>

Something this block does when activated with Activate.

animation_hint: AnimationHint

Advice to the renderer about how to expect this block to change, and hence what rendering strategy to use.

Note: This is automatically augmented for Primitive::Recur blocks if they contain voxels with animation hints themselves.

Implementations

impl BlockAttributes

pub const fn default() -> BlockAttributes

Block attributes suitable as default values for in-game use.

This function differs from the Default::default trait implementation only in that it is a const fn.

Trait Implementations

impl<'a> Arbitrary<'a> for BlockAttributes

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

Generate an arbitrary value of Self from 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 arbitrary_take_rest(u: Unstructured<'a>) -> Result<Self, Error>

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

impl Clone for BlockAttributes

fn clone(&self) -> BlockAttributes

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for BlockAttributes

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

Only attributes which differ from the default are shown.

impl Default for BlockAttributes

fn default() -> BlockAttributes

Block attributes suitable as default values for in-game use.

impl Hash for BlockAttributes

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq for BlockAttributes

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

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

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

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

impl VisitHandles for BlockAttributes

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 BlockAttributes

impl StructuralPartialEq for BlockAttributes