server

Documentation

Index

• Variables
• type Config
• type Player
  • func NewPlayer(srv *Server, conn *protocol.Conn, username string, uuid uuid.UUID) Player
  • func (p *Player) Disconnect()
  • func (p *Player) Start()
• type Server
  • func New(config Config) *Server
  • func (srv *Server) RegisterOnShutdown(f func())
  • func (srv *Server) Serve() error
  • func (srv *Server) Shutdown() error

Variables

var (
	ErrServerClosed = errors.New("piston: server already closed or closing")
)

Types

type Config

type Config struct {
	Address string
}

type Player

type Player struct {
	Username string
	UUID     uuid.UUID

	X int32
	Y int32
	Z int32

	Yaw   uint8
	Pitch uint8
	// contains filtered or unexported fields
}

Player is save for concurrent use

func NewPlayer

func NewPlayer(srv *Server, conn *protocol.Conn, username string, uuid uuid.UUID) Player

Creates a new Player. conn should not be used after passing it to NewPlayer

func (*Player) Disconnect

func (p *Player) Disconnect()

Disconnects a player and closes the connetion

func (*Player) Start

func (p *Player) Start()

Let the player play. This blocks until p.Disconnect is called or the client disconnects.

type Server

type Server struct {
	Overworld *world.World
	// contains filtered or unexported fields
}

Keep a minecraft server Server is save for concurrent use

File Structure: worlds/[name]/[chunk-x]-[chunk-y].gob

func New

func New(config Config) *Server

Initialize a server and load worlds

func (*Server) RegisterOnShutdown

func (srv *Server) RegisterOnShutdown(f func())

Execute f when srv.Shutdown is called. The server will not wait for f to finish

func (*Server) Serve

func (srv *Server) Serve() error

Listen for connections on srv.config.Address

func (*Server) Shutdown

func (srv *Server) Shutdown() error

Shuts the currently running server down. Blocks until srv.Serve() returns