players

Documentation

Overview

Package players implements a goroutine-safe player list.

Index

• type Players
  • func New() Players
  • func (l Players) AddPlayer(p *player.Player)
  • func (l Players) BroadcastLogin(to *player.Player)
  • func (l Players) BroadcastMessage(msg string)
  • func (l Players) BroadcastPacket(pkt packet.Packet)
  • func (l Players) Copy() map[string]*player.Player
  • func (l Players) GetPlayer(name string) *player.Player
  • func (l Players) Len() int
  • func (l Players) RemPlayer(p *player.Player)

Types

type Players

type Players struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Players is a simple goroutine-safe player list.

func New

func New() Players

func (Players) AddPlayer

func (l Players) AddPlayer(p *player.Player)

AddPlayer adds a player to the list.

func (Players) BroadcastLogin

func (l Players) BroadcastLogin(to *player.Player)

BroadcastLogin initializes all previously online clients to a new player.

func (Players) BroadcastMessage

func (l Players) BroadcastMessage(msg string)

BroadcastMessage send a message to all online players.

func (Players) BroadcastPacket

func (l Players) BroadcastPacket(pkt packet.Packet)

BroadcastPacket sends a packet to all online players.

func (Players) Copy

func (l Players) Copy() map[string]*player.Player

Copy returns a copy of the list.

func (Players) GetPlayer

func (l Players) GetPlayer(name string) *player.Player

GetPlayer gets a player from the list by his/her name.

func (Players) Len

func (l Players) Len() int

Len returns the number of online players.

func (Players) RemPlayer

func (l Players) RemPlayer(p *player.Player)

RemPlayer removes a player from the list.