packet

Documentation

Index

• type AvailableCommands
  • func (*AvailableCommands) ID() uint32
  • func (pk *AvailableCommands) Marshal(io protocol.IO)

Types

type AvailableCommands

type AvailableCommands struct {
	// EnumValues is a slice of all enum values of any enum in the
	// AvailableCommands packet. EnumValues generally should contain each
	// possible value only once. Enums are built by pointing to entries in this
	// slice.
	EnumValues []string
	// Suffixes, like EnumValues, is a slice of all suffix values of any command
	// parameter in the AvailableCommands packet.
	Suffixes []string
	// Enums is a slice of all (fixed) command enums present in any of the
	// commands.
	Enums []protocol.CommandEnum
	// Commands is a list of all commands that the client should show
	// client-side. The AvailableCommands packet replaces any commands sent
	// before. It does not only add the commands that are sent in it.
	Commands []types.Command
	// DynamicEnums is a slice of dynamic command enums. These command enums can
	// be changed during runtime without having to resend an AvailableCommands
	// packet.
	DynamicEnums []protocol.DynamicEnum
	// Constraints is a list of constraints that should be applied to certain
	// options of enums in the commands above.
	Constraints []protocol.CommandEnumConstraint
}

AvailableCommands is sent by the server to send a list of all commands that the player is able to use on the server. This packet holds all the arguments of each commands as well, making it possible for the client to provide auto-completion and command usages. AvailableCommands packets can be resent, but the packet is often very big, so doing this very often should be avoided.

func (*AvailableCommands) ID

func (*AvailableCommands) ID() uint32

ID ...

func (*AvailableCommands) Marshal

func (pk *AvailableCommands) Marshal(io protocol.IO)