Documentation
¶
Index ¶
Constants ¶
View Source
const ( InputFlagAscend = 1 << iota InputFlagDescend InputFlagNorthJump InputFlagJumpDown InputFlagSprintDown InputFlagChangeHeight InputFlagJumping InputFlagAutoJumpingInWater InputFlagSneaking InputFlagSneakDown InputFlagUp InputFlagDown InputFlagLeft InputFlagRight InputFlagUpLeft InputFlagUpRight InputFlagWantUp InputFlagWantDown InputFlagWantDownSlow InputFlagWantUpSlow InputFlagSprinting InputFlagAscendBlock InputFlagDescendBlock InputFlagSneakToggleDown InputFlagPersistSneak InputFlagStartSprinting InputFlagStopSprinting InputFlagStartSneaking InputFlagStopSneaking InputFlagStartSwimming InputFlagStopSwimming InputFlagStartJumping InputFlagStartGliding InputFlagStopGliding InputFlagPerformItemInteraction InputFlagPerformBlockActions InputFlagPerformItemStackRequest InputFlagHandledTeleport InputFlagEmoting InputFlagMissedSwing InputFlagStartCrawling InputFlagStopCrawling InputFlagStartFlying InputFlagStopFlying InputFlagClientAckServerData InputFlagClientPredictedVehicle )
View Source
const ( InputModeMouse = iota + 1 InputModeTouch InputModeGamePad InputModeMotionController )
View Source
const ( PlayModeNormal = iota PlayModeScreen PlayModeViewer PlayModeReality PlayModePlacement PlayModeLivingRoom PlayModeExitLevel PlayModeExitLevelLivingRoom PlayModeNumModes )
View Source
const ( InteractionModelTouch = iota InteractionModelCrosshair InteractionModelClassic )
View Source
const ( PlayerListActionAdd = iota PlayerListActionRemove )
Variables ¶
This section is empty.
Functions ¶
func NewClientPool ¶
func NewServerPool ¶
Types ¶
type LevelChunk ¶
type LevelChunk struct {
// Position contains the X and Z coordinates of the chunk sent. You can convert a block coordinate to a chunk
// coordinate by right-shifting it four bits.
Position protocol.ChunkPos
// HighestSubChunk is the highest sub-chunk at the position that is not all air. It is only set if the
// SubChunkCount is set to protocol.SubChunkRequestModeLimited.
HighestSubChunk uint16
// SubChunkCount is the amount of sub-chunks that are part of the chunk
// sent. Depending on if the cache is enabled, a list of blob hashes will be
// sent, or, if disabled, the sub-chunk data. SubChunkCount may be set to
// protocol.SubChunkRequestModeLimited or
// protocol.SubChunkRequestModeLimitless to prompt the client to send a
// SubChunkRequest in response. If this field is set to
// protocol.SubChunkRequestModeLimited, HighestSubChunk is used.
SubChunkCount uint32
// CacheEnabled specifies if the client blob cache should be enabled. This system is based on hashes of
// blobs which are consistent and saved by the client in combination with that blob, so that the server
// does not have the same chunk multiple times. If the client does not yet have a blob with the hash sent,
// it will send a ClientCacheBlobStatus packet containing the hashes is does not have the data of.
CacheEnabled bool
// BlobHashes is a list of all blob hashes used in the chunk. It is composed of SubChunkCount + 1 hashes,
// with the first SubChunkCount hashes being those of the sub-chunks and the last one that of the biome
// of the chunk.
// If CacheEnabled is set to false, BlobHashes can be left empty.
BlobHashes []uint64
// RawPayload is a serialised string of chunk data. The data held depends on if CacheEnabled is set to
// true. If set to false, the payload is composed of multiple sub-chunks, each of which carry a version
// which indicates the way they are serialised, followed by biomes, border blocks and tile entities. If
// CacheEnabled is true, the payload consists out of the border blocks and tile entities only.
RawPayload []byte
}
LevelChunk is sent by the server to provide the client with a chunk of a world data (16xYx16 blocks). Typically, a certain amount of chunks is sent to the client before sending it the spawn PlayStatus packet, so that the client spawns in a loaded world.
func (*LevelChunk) Marshal ¶
func (pk *LevelChunk) Marshal(io protocol.IO)
type PlayerAuthInput ¶
type PlayerAuthInput struct {
// Pitch and Yaw hold the rotation that the player reports it has.
Pitch, Yaw float32
// Position holds the position that the player reports it has.
Position mgl32.Vec3
// MoveVector is a Vec2 that specifies the direction in which the player moved, as a combination of X/Z
// values which are created using the WASD/controller stick state.
MoveVector mgl32.Vec2
// HeadYaw is the horizontal rotation of the head that the player reports it has.
HeadYaw float32
// InputData is a combination of bit flags that together specify the way the player moved last tick. It
// is a combination of the flags above.
InputData uint64
// InputMode specifies the way that the client inputs data to the screen. It is one of the constants that
// may be found above.
InputMode uint32
// PlayMode specifies the way that the player is playing. The values it holds, which are rather random,
// may be found above.
PlayMode uint32
// InteractionModel is a constant representing the interaction model the player is using. It is one of the
// constants that may be found above.
InteractionModel int32
// GazeDirection is the direction in which the player is gazing, when the PlayMode is PlayModeReality: In
// other words, when the player is playing in virtual reality.
GazeDirection mgl32.Vec3
// Tick is the server tick at which the packet was sent. It is used in relation to
// CorrectPlayerMovePrediction.
Tick uint64
// Delta was the delta between the old and the new position. There isn't any practical use for this field
// as it can be calculated by the server itself.
Delta mgl32.Vec3
// ItemInteractionData is the transaction data if the InputData includes an item interaction.
ItemInteractionData protocol.UseItemTransactionData
// ItemStackRequest is sent by the client to change an item in their inventory.
ItemStackRequest protocol.ItemStackRequest
// BlockActions is a slice of block actions that the client has interacted with.
BlockActions []protocol.PlayerBlockAction
// AnalogueMoveVector is a Vec2 that specifies the direction in which the player moved, as a combination
// of X/Z values which are created using an analogue input.
AnalogueMoveVector mgl32.Vec2
}
PlayerAuthInput is sent by the client to allow for server authoritative movement. It is used to synchronise the player input with the position server-side. The client sends this packet when the ServerAuthoritativeMovementMode field in the StartGame packet is set to true, instead of the MovePlayer packet. The client will send this packet once every tick.
func (*PlayerAuthInput) Marshal ¶
func (pk *PlayerAuthInput) Marshal(io protocol.IO)
type PlayerList ¶
type PlayerList struct {
// ActionType is the action to execute upon the player list. The entries that follow specify which entries
// are added or removed from the player list.
ActionType byte
// Entries is a list of all player list entries that should be added/removed from the player list,
// depending on the ActionType set.
Entries []PlayerListEntry
}
PlayerList is sent by the server to update the client-side player list in the in-game menu screen. It shows the icon of each player if the correct XUID is written in the packet. Sending the PlayerList packet is obligatory when sending an AddPlayer packet. The added player will not show up to a client if it has not been added to the player list, because several properties of the player are obtained from the player list, such as the skin.
func (*PlayerList) Marshal ¶
func (pk *PlayerList) Marshal(io protocol.IO)
type PlayerListEntry ¶
type PlayerListEntry struct {
// UUID is the UUID of the player as sent in the Login packet when the client joined the server. It must
// match this UUID exactly for the correct XBOX Live icon to show up in the list.
UUID uuid.UUID
// EntityUniqueID is the unique entity ID of the player. This ID typically stays consistent during the
// lifetime of a world, but servers often send the runtime ID for this.
EntityUniqueID int64
// Username is the username that is shown in the player list of the player that obtains a PlayerList
// packet with this entry. It does not have to be the same as the actual username of the player.
Username string
// XUID is the XBOX Live user ID of the player, which will remain consistent as long as the player is
// logged in with the XBOX Live account.
XUID string
// PlatformChatID is an identifier only set for particular platforms when chatting (presumably only for
// Nintendo Switch). It is otherwise an empty string, and is used to decide which players are able to
// chat with each other.
PlatformChatID string
// BuildPlatform is the platform of the player as sent by that player in the Login packet.
BuildPlatform int32
// Skin is the skin of the player that should be added to the player list. Once sent here, it will not
// have to be sent again.
Skin protocol.Skin
// Teacher is a Minecraft: Education Edition field. It specifies if the player to be added to the player
// list is a teacher.
Teacher bool
// Host specifies if the player that is added to the player list is the host of the game.
Host bool
}
PlayerListEntry is an entry found in the PlayerList packet. It represents a single player using the UUID found in the entry, and contains several properties such as the skin.
func DowngradePlayerEntries ¶
func DowngradePlayerEntries(entries []protocol.PlayerListEntry) []PlayerListEntry
func (*PlayerListEntry) Marshal ¶
func (x *PlayerListEntry) Marshal(r protocol.IO)
Marshal encodes/decodes a PlayerListEntry.
Source Files
Click to show internal directories.
Click to hide internal directories.