Kalevala.Event.Movement.Voting (kalevala v0.1.0) View Source

A voting event tracks the state of a character wishing to change rooms

Link to this section Summary

Types

t()

An event to allow for rooms to abort or commit the character moving.

Functions

Generate an abort event after voting has occurred

Generate a commit event after voting has occurred

Link to this section Types

Specs

t() :: %Kalevala.Event.Movement.Voting{
  aborted: term(),
  character: term(),
  exit_name: term(),
  from: term(),
  reason: term(),
  to: term()
}

An event to allow for rooms to abort or commit the character moving.

Each room has a chance to reject movement

  • state is an enum, one of the following atoms: :request, :commit, or :abort
  • character is the character performing the action
  • to is the room the character is going towards
  • from is the room the character is going away from
  • exit_name is the name of the exit_name that the player is using
  • reason is an atom such as :no_exit for why the movement is aborted

Link to this section Functions

Generate an abort event after voting has occurred

Generate a commit event after voting has occurred