player

Documentation

Index

• type Communicator
• type FingerPoint
  • func (fp *FingerPoint) String() string
• type LogCommunicator
  • func NewLogCommunicator() *LogCommunicator
  • func (mc *LogCommunicator) Close() error
  • func (mc *LogCommunicator) ReadMessage() (int, []byte, error)
  • func (mc *LogCommunicator) WriteMessage(messageType int, data []byte) error
• type MockCommunicator
  • func NewMockCommunicator() *MockCommunicator
  • func (mc *MockCommunicator) Close() error
  • func (mc *MockCommunicator) ReadMessage() (int, []byte, error)
  • func (mc *MockCommunicator) WriteMessage(messageType int, data []byte) error
• type Player
  • func NewPlayer(socket Communicator) *Player
  • func (p *Player) AddView(v *View)
  • func (p *Player) Message(t server.MessageType, payload interface{}) error
  • func (p *Player) Play()
  • func (p *Player) Reconnect(c Communicator)
  • func (p *Player) Reveal() *server.RevealedPlayer
  • func (p *Player) SetGameChannel(gc gamechannel.GameChannel)
  • func (p *Player) SetName(name string)
  • func (p *Player) SetRole(r *role.Role)
  • func (p *Player) String() string
• type View
  • func NewAttributeView(p *Player, a role.Attribute, hit bool, phase int) *View
  • func NewRoleView(p *Player, r *role.Role, phase int) *View
  • func (v *View) For() string

Types

type Communicator

type Communicator interface {
	ReadMessage() (messageType int, p []byte, err error)
	WriteMessage(messageType int, data []byte) error
	Close() error
}

A Communicator is an interface that is satisfied by github.com/gorilla/websocket and can be implemented by mocked/stubbed structs for testing and web-independent purposes.

type FingerPoint

type FingerPoint struct {
	From *Player
	To   *Player
}

A FingerPoint represents one player "pointing" at another in a real-life game of Werewolf. It can be used for both votes and night actions.

func (*FingerPoint) String

func (fp *FingerPoint) String() string

type LogCommunicator

type LogCommunicator struct {
}

func NewLogCommunicator

func NewLogCommunicator() *LogCommunicator

func (*LogCommunicator) Close

func (mc *LogCommunicator) Close() error

func (*LogCommunicator) ReadMessage

func (mc *LogCommunicator) ReadMessage() (int, []byte, error)

func (*LogCommunicator) WriteMessage

func (mc *LogCommunicator) WriteMessage(messageType int, data []byte) error

type MockCommunicator

type MockCommunicator struct {
	mock.Mock
}

func NewMockCommunicator

func NewMockCommunicator() *MockCommunicator

func (*MockCommunicator) Close

func (mc *MockCommunicator) Close() error

func (*MockCommunicator) ReadMessage

func (mc *MockCommunicator) ReadMessage() (int, []byte, error)

func (*MockCommunicator) WriteMessage

func (mc *MockCommunicator) WriteMessage(messageType int, data []byte) error

type Player

type Player struct {
	ID    uuid.UUID  `json:"id"`
	Name  string     `json:"name"`
	Role  *role.Role `json:"-"`
	Views []*View    `json:"-"`
	// contains filtered or unexported fields
}

func NewPlayer

func NewPlayer(socket Communicator) *Player

func (*Player) AddView

func (p *Player) AddView(v *View)

func (*Player) Message

func (p *Player) Message(t server.MessageType, payload interface{}) error

Message handles sending a message to the client, wrapping it in error handling

func (*Player) Play

func (p *Player) Play()

func (*Player) Reconnect

func (p *Player) Reconnect(c Communicator)

func (*Player) Reveal

func (p *Player) Reveal() *server.RevealedPlayer

func (*Player) SetGameChannel

func (p *Player) SetGameChannel(gc gamechannel.GameChannel)

func (*Player) SetName

func (p *Player) SetName(name string)

func (*Player) SetRole

func (p *Player) SetRole(r *role.Role)

func (*Player) String

func (p *Player) String() string

type View

type View struct {
	Player    *Player
	Attribute role.Attribute
	Role      *role.Role
	Hit       bool
	GamePhase int
}

A View represents a player's knowledge of another's role. It can be both a nighttime viewing (such as a seer viewing for max evil) or a generic "this player now knows the roles of one or more other players" (such as the wolves at the start of the game). It may not be successful, as in the case of a seer viewing a non-max, and it may even be incorrect, if there are tinkers!

func NewAttributeView

func NewAttributeView(p *Player, a role.Attribute, hit bool, phase int) *View

func NewRoleView

func NewRoleView(p *Player, r *role.Role, phase int) *View

func (*View) For

func (v *View) For() string