gossip v1.4.0 Gossip.Client.Core behaviour View Source

Callbacks for the "channels" flag

This is the only required module.

Link to this section Summary

A callback to know when the socket is authenticated

Get the channels you want to subscribe to on start

A new message was received from Gossip on a channel

Get the current names of connected players

Get the game's User Agent.

authenticated() :: :ok

A callback to know when the socket is authenticated

channels() :: [Gossip.channel_name()]

Get the channels you want to subscribe to on start

message_broadcast(Gossip.message()) :: :ok

A new message was received from Gossip on a channel

players() :: [Gossip.player_name()]

Get the current names of connected players

Used in the heartbeat

user_agent() :: Gossip.user_agent()

Get the game's User Agent.

This should return the game name with a version number.