Struct Cardinal 

pub struct Cardinal<N, E, S, W> {
    pub north: N,
    pub east: E,
    pub south: S,
    pub west: W,
}

Available on crate feature input_bei and (crate features input_bei or input_native or leafwing) only.

A preset to 4 map buttons as 2-dimensional input.

In Bevy’s 3D space, the -Z axis points forward and the +Z axis points toward the camera. To map movement correctly in 3D space for Transform::translation, you will need to invert Y and apply it to Z inside your observer.

Fields

north: N

east: E

south: S

west: W

Implementations

impl Cardinal<Binding, Binding, Binding, Binding>

pub fn wasd_keys() -> Cardinal<Binding, Binding, Binding, Binding>

Maps WASD keys as 2-dimensional input.

pub fn arrows() -> Cardinal<Binding, Binding, Binding, Binding>

Maps keyboard arrow keys as 2-dimensional input.

pub fn new( north: impl Into<Binding>, west: impl Into<Binding>, south: impl Into<Binding>, east: impl Into<Binding>, ) -> Cardinal<Binding, Binding, Binding, Binding>

Maps 4 bindings as 2-dimensional input.

pub fn with_mod_keys( self, mod_keys: ModKeys, ) -> Cardinal<Binding, Binding, Binding, Binding>

Applies keyboard modifiers to all bindings.

impl Cardinal<Binding, Binding, Binding, Binding>

pub fn dpad() -> Cardinal<Binding, Binding, Binding, Binding>

Maps D-pad as 2-dimensional input.

Trait Implementations

impl<N, E, S, W> Clone for Cardinal<N, E, S, W>

where N: Clone, E: Clone, S: Clone, W: Clone,

fn clone(&self) -> Cardinal<N, E, S, W>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<N, E, S, W> Copy for Cardinal<N, E, S, W>

where N: Copy, E: Copy, S: Copy, W: Copy,

impl<N, E, S, W> Debug for Cardinal<N, E, S, W>

where N: Debug, E: Debug, S: Debug, W: Debug,

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

Formats the value using the given formatter.

impl<N, E, S, W> SpawnableList<BindingOf> for Cardinal<N, E, S, W>

where N: Bundle, E: Bundle, S: Bundle, W: Bundle,

fn spawn( this: MovingPtr<'_, Cardinal<N, E, S, W>>, world: &mut World, entity: Entity, )

Spawn this list of changes in a given World and relative to a given Entity. This is generally used for spawning “related” entities, such as children.

fn size_hint(&self) -> usize

Returns a size hint, which is used to reserve space for this list in a RelationshipTarget. This should be less than or equal to the actual size of the list. When in doubt, just use 0.

impl<N, E, S, W, T> WithBundle<T> for Cardinal<N, E, S, W>

where T: Clone,

type Output = Cardinal<(N, T), (E, T), (S, T), (W, T)>

fn with(self, bundle: T) -> <Cardinal<N, E, S, W> as WithBundle<T>>::Output

Returns a new instance in which the given bundle is added to each entity spawned by the preset.