Struct tiny_rpg::entity::Entity

pub struct Entity { /* fields omitted */ }

An Entity can be nearly anything. A field, a wall, a creature. It has values to allow interactions to intermingle. Maybe walls can be teleported, or broken down. Maybe someone can capture a creature and use it later on.

Methods

impl Entity

Implementations for Entity that create standard default entities, such as,

• Player
• Specific Enemies
• Walls

pub fn new_player(x: i32, y: i32) -> Entity

Creates a good default player. Asks for a position.

pub fn new_slimer_entity(x: i32, y: i32) -> Entity

Creates an evil slimer entity.

pub fn new_wall(x: i32, y: i32, height: u32, width: u32) -> Entity

Creates a wall where you specify height, width and position.

impl Entity

Implementations of movement for the entity.

pub fn get_move(&self, movement: Point) -> Rectangle

Returns a rectangle of the entity if it moved by movement amount.

pub fn get_move_left(&self) -> Rectangle

Returns movement if the entity moved 1 left.

pub fn get_move_right(&self) -> Rectangle

Returns movement if the entity moved 1 right.

pub fn get_move_up(&self) -> Rectangle

Returns movement if the entity moved 1 up.

pub fn get_move_down(&self) -> Rectangle

Returns movement if the entity moved 1 down.

pub fn move_left(&mut self)

Moves the entity one left. Should usually be used with get_move_left first. May be removed in future versions.

pub fn move_right(&mut self)

Moves the entity one right. Should usually be used with get_move_right first. May be removed in future versions.

pub fn move_up(&mut self)

Moves the entity one up. Should usually be used with get_move_up first. May be removed in future versions.

pub fn move_down(&mut self)

Moves the entity one down. Should usually be used with get_move_down first. May be removed in future versions.

impl Entity

pub fn new() -> EntityBuilder

Creates an instance of EntityBuilder to start building and Entity.

pub fn get_position(&self) -> Point

Returns the current position of the entity.

pub fn get_size(&self) -> Dimension

Returns the size of the entity.

pub fn get_rectangle(&self) -> Rectangle

Returns both the size and position of an entity using a Rectangle.

pub fn get_skin(&self) -> Skin

Returns the skin of the entity.

pub fn get_abilities(&self) -> &Abilities

Returns a reference to the abilities of an entity.

impl Entity

AI logic here. Should only need to call perform_turn for the object to do what it thinks is best. Almost certainly will become a trait.

pub fn perform_turn(&mut self, data: &mut Data)

The entity performs an action based on its environment.

Trait Implementations

impl Clone for Entity

fn clone(&self) -> Entity

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<Entity> for Entity

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

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

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

This method tests for !=.

impl Debug for Entity

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

Formats the value using the given formatter.