player

Documentation

Index

• Variables
• type ChatMode
• type MainHand
• type Settings
  • func NewSettings(packet *packet.ClientSettings) Settings
• type SkinParts
  • func (bitmask SkinParts) Cape() bool
  • func (bitmask SkinParts) Hat() bool
  • func (bitmask SkinParts) Jacket() bool
  • func (bitmask SkinParts) LeftPants() bool
  • func (bitmask SkinParts) LeftSleeve() bool
  • func (bitmask SkinParts) RightPants() bool
  • func (bitmask SkinParts) RightSleeve() bool

Variables

var DefaultSettings = NewSettings(&packet.ClientSettings{
	Locale:       "en_US",
	ViewDistance: 10,
	ChatColors:   true,
	SkinParts:    127,
	MainHand:     1,
})

Types

type ChatMode

type ChatMode string

const (
	ShownChatMode ChatMode = "shown"
	CommandsOnly  ChatMode = "commandsOnly"
	Hidden        ChatMode = "hidden"
)

type MainHand

type MainHand string

const (
	LeftMainHand  MainHand = "left"
	RightMainHand MainHand = "right"
)

type Settings

type Settings interface {
	Locale() language.Tag // Locale of the Minecraft client.
	// ViewDistance returns the client's view distance. This does not guarantee the client will see this many
	// chunks, since your servers are responsible for sending the chunks.
	ViewDistance() uint8
	ChatMode() ChatMode   // The chat setting of the client.
	ChatColors() bool     // Whether the client has chat colors disabled.
	SkinParts() SkinParts // The parts of player skin the client will show.
	MainHand() MainHand   // The primary hand of the client.
	// ClientListing returns whether the client explicitly
	// allows listing on the TabList in anonymous tab list mode.
	//
	// This feature was introduced in 1.18.
	ClientListing() bool
}

Settings are the client settings the player gave us.

func NewSettings

func NewSettings(packet *packet.ClientSettings) Settings

type SkinParts

type SkinParts byte

func (SkinParts) Cape

func (bitmask SkinParts) Cape() bool

func (SkinParts) Hat

func (bitmask SkinParts) Hat() bool

func (SkinParts) Jacket

func (bitmask SkinParts) Jacket() bool

func (SkinParts) LeftPants

func (bitmask SkinParts) LeftPants() bool

func (SkinParts) LeftSleeve

func (bitmask SkinParts) LeftSleeve() bool

func (SkinParts) RightPants

func (bitmask SkinParts) RightPants() bool

func (SkinParts) RightSleeve

func (bitmask SkinParts) RightSleeve() bool