kalevala v0.1.0 Kalevala.Character.Conn View Source

t() :: %Kalevala.Character.Conn{
  assigns: term(),
  character: term(),
  events: term(),
  options: term(),
  output: term(),
  params: term(),
  private: term(),
  session: term()
}

Link to this section Functions

assign(conn, key, value)

Add to the assignment map on the conn

character(conn, opts \\ [])

Get the character out of the conn

If the character has been updated, this character will be returned

delay_event(conn, delay, topic, data \\ %{})

Delay an event

event(conn, topic, data \\ %{})

Send the foreman an in-game event

get_session(conn, key)

Get a value out of the session data

halt(conn)

Mark the connection for termination

move(conn, direction, room_id, view, template, assigns)

Creates an even to move from one room to another

prompt(conn, view, template, assigns \\ %{})

Render a prompt to the conn

publish_message(conn, channel_name, text, options, error_fun)

Request to publish a message to a channel

Available options for altering the message, these also get passed along to the channel callbacks.

type, defaults to "speech"
meta, defaults to %{}

put_action(conn, action)

Put an action to be performed

This should be a Kalevala.Character.Action struct to save which action module should be run, along with any delay and params.

put_character(conn, character)

Update the character in state

put_controller(conn, controller)

Put the new controller that the foreman should swap to

put_meta(conn, key, value)

Update a key in a character's meta map

put_session(conn, key, value)

Put a value into the session data

render(conn, view, template, assigns \\ %{})

Render text to the conn

request_item_drop(conn, item_instance)

Sends a request to drop an item into the room

request_item_pickup(conn, item_name)

Sends a request to get an item from the room

request_movement(conn, exit_name)

Request the room to move via the exit

send_option(conn, name, value)

Send a telnet option

unsubscribe(conn, channel_name, options, error_fun)

Request to unsubscribe from a channel