messages

Documentation

Index

• Constants
• type AudienceType
• type CharacterJoinedRoom
• type CharacterLeftRoom
• type CharacterSelected
• type EnterRoomMessage
  • func NewEnterRoomMessage(room *rooms.Room, user *entities.User, game def.GameCtrl) *EnterRoomMessage
• type IncomingMessage
• type Message
  • func NewMessage(fromUser *e.User, data string) *Message
  • func (msg *Message) Reply(message string) MessageResponse
• type MessageResponder
• type MessageResponse
  • func NewCreateCharacterMessage(user string) MessageResponse
  • func NewRoomBasedMessage(user string, message string) MessageResponse
  • func Reply(userID string, message string) MessageResponse
  • func (m MessageResponse) GetAudience() AudienceType
  • func (m MessageResponse) GetAudienceID() string
  • func (m MessageResponse) GetMessage() string
  • func (m MessageResponse) GetOriginID() string
• type MessageType
• type MultiResponse
  • func NewMultiResponse(responses ...MessageResponse) MultiResponse
• type UserJoined
  • func NewUserJoined(user *e.User) *UserJoined
• type UserQuit
  • func NewUserQuit(user *e.User) *UserQuit

Constants

const (
	MessageTypeDefault           = "message"
	MessageTypeEnterRoom         = "enterRoom"
	MessageTypeCreateCharacter   = "createCharacter"
	MessageTypeSelectCharacter   = "selectCharacter"
	MessageTypeCharacterSelected = "characterSelected"

	MessageTypePing = "ping"
)

const (
	MessageAudienceOrigin = iota + 1
	MessageAudienceUser
	MessageAudienceRoom
	MessageAudienceRoomWithoutOrigin
	MessageAudienceGlobal
	MessageAudienceSystem
)

Types

type AudienceType

type AudienceType int

AudienceType type

type CharacterJoinedRoom

type CharacterJoinedRoom struct {
	MessageResponse
}

CharacterJoinedRoom ... asdd

type CharacterLeftRoom

type CharacterLeftRoom struct {
	MessageResponse
}

CharacterLeftRoom ... asdd

type CharacterSelected

type CharacterSelected struct {
	MessageResponse
	Character *characters.Character `json:"character"`
}

CharacterSelected ...

type EnterRoomMessage

type EnterRoomMessage struct {
	MessageResponse
	Room rooms.Room `json:"room"`
}

EnterRoomMessage ... Define our message object

func NewEnterRoomMessage

func NewEnterRoomMessage(room *rooms.Room, user *entities.User, game def.GameCtrl) *EnterRoomMessage

NewEnterRoomMessage ...

type IncomingMessage

type IncomingMessage struct {
	Message string `json:"message"`
}

IncomingMessage ...

type Message

type Message struct {
	FromUser  *e.User
	Character *characters.Character

	Data string
}

Message ... main message container to pass data from e to server and back

func NewMessage

func NewMessage(fromUser *e.User, data string) *Message

NewMessage ... creates a new message

func (*Message) Reply

func (msg *Message) Reply(message string) MessageResponse

Reply o a message

type MessageResponder

type MessageResponder interface {
	GetAudience() AudienceType
	GetAudienceID() string
	GetOriginID() string
	GetMessage() string
}

MessageResponder ...

type MessageResponse

type MessageResponse struct {
	Audience   AudienceType `json:"-"`
	AudienceID string       `json:"-"`
	OriginID   string       `json:"-"`

	Type     MessageType `json:"type"`
	Username string      `json:"username"`
	Message  string      `json:"message"`
}

MessageResponse ... Define our message object

func NewCreateCharacterMessage

func NewCreateCharacterMessage(user string) MessageResponse

NewCreateCharacterMessage ...

func NewRoomBasedMessage

func NewRoomBasedMessage(user string, message string) MessageResponse

NewRoomBasedMessage ... creates a new Websocket message

func Reply

func Reply(userID string, message string) MessageResponse

Reply ... creates a reply message

func (MessageResponse) GetAudience

func (m MessageResponse) GetAudience() AudienceType

GetAudience ,,,

func (MessageResponse) GetAudienceID

func (m MessageResponse) GetAudienceID() string

GetAudienceID ,,,

func (MessageResponse) GetMessage

func (m MessageResponse) GetMessage() string

GetMessage ,,,

func (MessageResponse) GetOriginID

func (m MessageResponse) GetOriginID() string

GetOriginID ,,,

type MessageType

type MessageType string

MessageType type

type MultiResponse

type MultiResponse struct {
	Responses []MessageResponse
}

MultiResponse ...

func NewMultiResponse

func NewMultiResponse(responses ...MessageResponse) MultiResponse

NewMultiResponse ...

type UserJoined

type UserJoined struct{ User *e.User }

UserJoined ... player joined event

func NewUserJoined

func NewUserJoined(user *e.User) *UserJoined

NewUserJoined ... creates a new User Joined event

type UserQuit

type UserQuit struct{ User *e.User }

UserQuit ... player joined event

func NewUserQuit

func NewUserQuit(user *e.User) *UserQuit

NewUserQuit ... creates a new User Joined event