Struct pokemon_rust::systems::character_movement_system::CharacterMovementSystem

pub struct CharacterMovementSystem;

A system responsible for executing character movements. It finds characters that contain a CharacterMovement component (typically added by a CharacterSingleMoveEvent or by a CharacterMoveEvent ) and performs the movement described by it.

This system is not perfectly equivalent for human players and NPCs. The following effects only apply to human players:

• If the destination tile is blocked, the movement is canceled;
• After the movement is completed, the following map events happen, in this order:
  • If the movement includes a map change, OnMapEnter is triggered on the new map;
  • OnTileChange map events are triggered;
  • OnStep tile events are triggered.

As for NPCs, the following effects are exclusive:

• If the destination tile is blocked, the movement is suspended until the tile becomes available again. In particular, this makes CharacterSingleMoveEvent and CharacterMoveEvent "hang" until that happens.
• During the movement, the interaction tile (i.e the tile that triggers interaction with this NPC) moves along with the NPC at the start of the movement.

Trait Implementations

impl<'a> System<'a> for CharacterMovementSystem

type SystemData = (WriteStorage<'a, Character>, WriteStorage<'a, CharacterMovement>, ReadStorage<'a, AllowedMovements>, WriteStorage<'a, Transform>, WriteStorage<'a, AnimationTable<CharacterAnimation>>, WriteStorage<'a, SpriteRender>, Entities<'a>, ReadExpect<'a, PlayerEntity>, WriteExpect<'a, MapHandler>, Write<'a, EventQueue>, Read<'a, Time>)

The resource bundle required to execute this system.

fn run(
    &mut self,
    (characters, movements, allowed_movements_storage, transforms, animation_tables, sprite_renders, entities, player_entity, map, event_queue, time): Self::SystemData
)

Executes the system with the required system data.

fn running_time(&self) -> RunningTime

Returns a hint how long the system needs for running. This is used to optimize the way they're executed (might allow more parallelization).

fn accessor(&'b self) -> AccessorCow<'a, 'b, Self>

Return the accessor from the [SystemData].

fn setup(&mut self, world: &mut World)

Sets up the World using Self::SystemData::setup.

fn dispose(self, world: &mut World)

Performs clean up that requires resources from the World. This commonly removes components from world which depend on external resources.