Struct Collider 

pub struct Collider { /* private fields */ }

Represents a collision box. The cardinals denote which INWARD movements are blocked. E.g.: if collider.north = true, then it will not allow something getting into it from the north. However, it will allow moving north from inside of it.

Implementations

impl Collider

pub fn new(north: bool, south: bool, east: bool, west: bool) -> Self

pub fn blocks(&self, movement: &Movement) -> bool

Check if a movement directed towards the collider should be blocked.

pub fn build(template: &str) -> Self

Creates a collider from a template string. The string must have the format ‘nsew’ where each letter represents the collider blocking from a cardinal. If the collider should not block from that direction, use ‘-’ instead.

Examples

use starlib::Collider;
let col1 = Collider::build("ns--");
let col2 = Collider::new(true, true, false, false);
assert_eq!(col1, col2);

Panics

Panics if the value does not match the specified format. E.g.: When it is not 4 chars long, when one of its chars is not ‘n’, ‘s’, ‘e’, ‘w’ or ‘-’ or when those characters aren’t in order.

use starlib::Collider;
Collider::build("nwe-"); // Out of order

use starlib::Collider;
Collider::build("nse"); // Wrong length

use starlib::Collider;
Collider::build("Starlib!"); // Wrong chars

Trait Implementations

impl Add for Collider

If two colliders are added together, their collisions are OR’d.

type Output = Collider

The resulting type after applying the + operator.

fn add(self, other: Self) -> Self::Output

Performs the + operation.

impl Clone for Collider

fn clone(&self) -> Collider

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Collider

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

Formats the value using the given formatter.

impl PartialEq for Collider

fn eq(&self, other: &Collider) -> 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 StructuralPartialEq for Collider