Kalevala.Character.Controller behaviour (kalevala v0.1.0) View Source

Kalevala controllers are the current set of actions for the user

For instance, you might have a LoginController that handles authentication, that then passes to a CommandController to start processing player commands after they signed in.

Link to this section Summary

Functions

__using__(opts)

Marks the module as a controller and imports controller functions

Callbacks

display(arg1, arg2)

Called when a Kalevala.Character.Event.Display is sent to the foreman process

event(arg1, arg2)

Called when a Kalevala.Character.Event is sent to the foreman process

init(arg1)

Called when the controller is first switched to

recv(arg1, arg2)

Called when text is received from the player

recv_event(arg1, any)

Called when the connection receives an event (e.g. incoming GMCP)

Link to this section Functions

using(opts)

(macro)

Marks the module as a controller and imports controller functions

Link to this section Callbacks

display(arg1, arg2)

Specs

display(Kalevala.Character.Conn.t(), Kalevala.Character.Event.t()) ::
  Kalevala.Character.Conn.t()

Called when a Kalevala.Character.Event.Display is sent to the foreman process

event(arg1, arg2)

Specs

event(Kalevala.Character.Conn.t(), Kalevala.Character.Event.t()) ::
  Kalevala.Character.Conn.t()

Called when a Kalevala.Character.Event is sent to the foreman process

init(arg1)

Specs

init(Kalevala.Character.Conn.t()) :: Kalevala.Character.Conn.t()

Called when the controller is first switched to

recv(arg1, arg2)

Specs

recv(Kalevala.Character.Conn.t(), String.t()) :: Kalevala.Character.Conn.t()

Called when text is received from the player

recv_event(arg1, any)

Specs

recv_event(Kalevala.Character.Conn.t(), any()) :: Kalevala.Character.Conn.t()

Called when the connection receives an event (e.g. incoming GMCP)