@serenityjs/protocol 0.2.2-beta-20240428205839 → 0.2.2-beta-20240430005134

package/dist/index.d.ts

@@ -229,7 +229,7 @@ declare enum MoveMode {
     Rotation = 3
 }
 
-declare enum RecordAction {
+declare enum PlayerListAction {
     Add = 0,
     Remove = 1
 }
@@ -1589,7 +1589,8 @@ declare class Vector3f extends DataType {
      *
      * @returns The 3D vector with the coordinates floored.
      */
-    floor(): this;
+    floor(): Vector3f;
+    subtract(other: Vector3f): Vector3f;
     /**
      * Reads a 3D vector from the stream.
      *
@@ -1674,20 +1675,300 @@ declare class TeleportCause extends DataType {
     static write(stream: BinaryStream, value: TeleportCause, endian: Endianness, mode: MoveMode): void;
 }
 
-declare class Records extends DataType {
-    buildPlatform?: number;
-    entityUniqueId?: bigint;
-    isHost?: boolean;
-    isTeacher?: boolean;
-    isSubclient?: boolean;
-    platformChatId?: string;
-    skin?: Buffer$1;
-    username?: string;
-    uuid: string;
-    xuid?: string;
-    constructor(uuid: string, buildPlatform?: number, entityUniqueId?: bigint, isHost?: boolean, isTeacher?: boolean, isSubclient?: boolean, platformChatId?: string, skin?: Buffer$1, username?: string, xuid?: string);
-    static read(stream: BinaryStream, endian: Endianness, action: RecordAction): Array<Records>;
-    static write(stream: BinaryStream, value: Array<Records>, endian: Endianness, action: RecordAction): void;
+/**
+ * Represents a skin related image.
+ */
+declare class SkinImage extends DataType {
+    /**
+     * The width of the image.
+     */
+    readonly width: number;
+    /**
+     * The height of the image.
+     */
+    readonly height: number;
+    /**
+     * The data of the image.
+     */
+    readonly data: string;
+    /**
+     * Creates a new skin image.
+     *
+     * @param width The width of the image.
+     * @param height The height of the image.
+     * @param data The data of the image.
+     */
+    constructor(width: number, height: number, data: string);
+    static read(stream: BinaryStream): SkinImage;
+    static write(stream: BinaryStream, image: SkinImage): void;
+}
+
+/**
+ * Represents an animation of a skin.
+ */
+declare class SkinAnimation extends DataType {
+    /**
+     * The image of the animation.
+     */
+    readonly image: SkinImage;
+    /**
+     * The type of the animation.
+     */
+    readonly type: number;
+    /**
+     * The amount of frames of the animation.
+     */
+    readonly frames: number;
+    /**
+     * The type of the expression of the animation.
+     */
+    readonly expression: number;
+    /**
+     * Creates a new skin animation.
+     *
+     * @param image The image of the animation.
+     * @param type The type of the animation.
+     * @param frames The amount of frames of the animation.
+     * @param expression The type of the expression of the animation.
+     */
+    constructor(image: SkinImage, type: number, frames: number, expression: number);
+    static read(stream: BinaryStream): SkinAnimation;
+    static write(stream: BinaryStream, animation: SkinAnimation): void;
+}
+
+/**
+ * Represents a piece of a persona skin.
+ */
+declare class SkinPersonaPiece extends DataType {
+    /**
+     * The identifier of the piece.
+     */
+    readonly identifier: string;
+    /**
+     * The type of the piece.
+     */
+    readonly type: string;
+    /**
+     * The pack identifier of the piece.
+     */
+    readonly packIdentifier: string;
+    /**
+     * The is default state of the piece.
+     */
+    readonly isDefault: boolean;
+    /**
+     * The product identifier of the piece.
+     */
+    readonly productIdentifier: string;
+    /**
+     * Creates a new piece of a persona skin.
+     *
+     * @param identifier The identifier of the piece.
+     * @param type The type of the piece.
+     * @param packIdentifier The pack identifier of the piece.
+     * @param isDefault The is default state of the piece.
+     * @param productIdentifier The product identifier of the piece.
+     */
+    constructor(identifier: string, type: string, packIdentifier: string, isDefault: boolean, productIdentifier: string);
+    static read(stream: BinaryStream): SkinPersonaPiece;
+    static write(stream: BinaryStream, piece: SkinPersonaPiece): void;
+}
+
+/**
+ * Represents a tint piece of a persona skin.
+ */
+declare class SkinPersonaTintPiece extends DataType {
+    /**
+     * The identifier of the tint piece.
+     */
+    readonly type: string;
+    /**
+     * The colors of the tint piece.
+     */
+    readonly colors: Array<string>;
+    /**
+     * Creates a new tint piece of a persona skin.
+     *
+     * @param type The identifier of the tint piece.
+     * @param colors The colors of the tint piece.
+     */
+    constructor(type: string, colors: Array<string>);
+    static read(stream: BinaryStream): SkinPersonaTintPiece;
+    static write(stream: BinaryStream, tintPiece: SkinPersonaTintPiece): void;
+}
+
+/**
+ * Represents a skin.
+ */
+declare class SerializedSkin extends DataType {
+    /**
+     * The identifier of the skin.
+     */
+    readonly identifier: string;
+    /**
+     * The playfab identifier of the skin.
+     */
+    readonly playFabIdentifier: string;
+    /**
+     * The resource patch of the skin.
+     */
+    readonly resourcePatch: string;
+    /**
+     * The skin image.
+     */
+    readonly skinImage: SkinImage;
+    /**
+     * The animations of the skin.
+     */
+    readonly animations: Array<SkinAnimation>;
+    /**
+     * The cape image.
+     */
+    readonly capeImage: SkinImage;
+    /**
+     * The geometry data of the skin.
+     */
+    readonly geometryData: string;
+    /**
+     * The geometry version of the skin.
+     */
+    readonly geometryVersion: string;
+    /**
+     * The animation data of the skin.
+     */
+    readonly animationData: string;
+    /**
+     * The animation engine of the skin.
+     */
+    readonly capeIdentifier: string;
+    /**
+     * The full identifier of the skin.
+     */
+    readonly fullIdentifier: string;
+    /**
+     * The arm size of the skin.
+     */
+    readonly armSize: string;
+    /**
+     * The skin color of the skin.
+     */
+    readonly skinColor: string;
+    /**
+     * The persona pieces of the skin.
+     */
+    readonly personaPieces: Array<SkinPersonaPiece>;
+    /**
+     * The tint pieces of the skin.
+     */
+    readonly tintPieces: Array<SkinPersonaTintPiece>;
+    /**
+     * If the skin is premium.
+     */
+    readonly isPremium: boolean;
+    /**
+     * If the skin is persona.
+     */
+    readonly isPersona: boolean;
+    /**
+     * If there is a persona cape on classic skin.
+     */
+    readonly isPersonaCapeOnClassic: boolean;
+    /**
+     * If the skin is used by its primary user.
+     */
+    readonly isPrimaryUser: boolean;
+    /**
+     * If the skin will override the player appearance.
+     */
+    readonly overridingPlayerAppearance: boolean;
+    /**
+     * Creates a new serialized skin.
+     *
+     * @param identifier The identifier of the skin.
+     * @param playFabIdentifier The playfab identifier of the skin.
+     * @param resourcePatch The resource patch of the skin.
+     * @param skinImage The skin image.
+     * @param animations The animations of the skin.
+     * @param capeImage The cape image.
+     * @param geometryData The geometry data of the skin.
+     * @param geometryVersion The geometry version of the skin.
+     * @param animationData The animation data of the skin.
+     * @param capeIdentifier The cape identifier of the skin.
+     * @param fullIdentifier The full identifier of the skin.
+     * @param armSize The arm size of the skin.
+     * @param skin
+     * @param personaPieces The persona pieces of the skin.
+     * @param tintPieces The tint pieces of the skin.
+     * @param isPremium If the skin is premium.
+     * @param isPersona If the skin is persona.
+     * @param isPersonaCapeOnClassic If there is a persona cape on classic skin.
+     * @param isPrimaryUser If the skin is used by its primary user.
+     * @param overridingPlayerAppearance If the skin will override the player appearance.
+     * @returns A new serialized skin.
+     */
+    constructor(identifier: string, playFabIdentifier: string, resourcePatch: string, skinImage: SkinImage, animations: Array<SkinAnimation>, capeImage: SkinImage, geometryData: string, geometryVersion: string, animationData: string, capeIdentifier: string, fullIdentifier: string, armSize: string, skinColor: string, personaPieces: Array<SkinPersonaPiece>, tintPieces: Array<SkinPersonaTintPiece>, isPremium: boolean, isPersona: boolean, isPersonaCapeOnClassic: boolean, isPrimaryUser: boolean, overridingPlayerAppearance: boolean);
+    static read(stream: BinaryStream): SerializedSkin;
+    static write(stream: BinaryStream, skin: SerializedSkin): void;
+}
+
+declare class PlayerListRecord extends DataType {
+    /**
+     * The uuid of the player.
+     */
+    readonly uuid: string;
+    /**
+     * The unique actor id of the player.
+     */
+    readonly uniqueId: bigint | null;
+    /**
+     * The username of the player.
+     */
+    readonly username: string | null;
+    /**
+     * The xbox user id of the player.
+     */
+    readonly xuid: string | null;
+    /**
+     * The platform chat identifier of the player.
+     */
+    readonly platformChatIdentifier: string | null;
+    /**
+     * The platform build of the player.
+     */
+    readonly platformBuild: number | null;
+    /**
+     * The skin of the player.
+     */
+    readonly skin: SerializedSkin | null;
+    /**
+     * Whether the player is a teacher.
+     */
+    readonly isTeacher: boolean | null;
+    /**
+     * Whether the player is a host.
+     */
+    readonly isHost: boolean | null;
+    /**
+     * Whether the player is a visitor.
+     */
+    readonly isVisitor: boolean | null;
+    /**
+     * Creates a new player record.
+     *
+     * @param uuid The uuid of the player.
+     * @param uniqueId The unique actor id of the player.
+     * @param username The username of the player.
+     * @param xuid The xbox user id of the player.
+     * @param platformChatIdentifier The platform chat identifier of the player.
+     * @param platformBuild The platform build of the player.
+     * @param skin The skin of the player.
+     * @param isTeacher Whether the player is a teacher.
+     * @param isHost Whether the player is a host.
+     * @param isVisitor Whether the player is a visitor.
+     */
+    constructor(uuid: string, uniqueId?: bigint | null, username?: string | null, xuid?: string | null, platformChatIdentifier?: string | null, platformBuild?: number | null, skin?: SerializedSkin | null, isTeacher?: boolean | null, isHost?: boolean | null, isVisitor?: boolean | null);
+    static read(stream: BinaryStream, _endian: Endianness, action: PlayerListAction): Array<PlayerListRecord>;
+    static write(stream: BinaryStream, records: Array<PlayerListRecord>, _endian: Endianness, action: PlayerListAction): void;
 }
 
 interface AbilityFlag {
@@ -2773,8 +3054,8 @@ declare class PlayerHotbarPacket extends DataPacket {
 }
 
 declare class PlayerListPacket extends DataPacket {
-    action: RecordAction;
-    records: Array<Records>;
+    action: PlayerListAction;
+    records: Array<PlayerListRecord>;
 }
 
 declare class RemoveEntityPacket extends DataPacket {
@@ -3103,4 +3384,4 @@ declare const PROTOCOL_VERSION = 671;
 declare const MINECRAFT_VERSION = "1.20.80";
 declare const MINECRAFT_TICK_SPEED = 50;
 
-export { AbilityLayerFlag, AbilityLayerType, AbilityLayers, AbilitySet, ActionIds, AddEntityPacket, AddItemActorPacket, AddPlayerPacket, AnimateAction, AnimateId, AnimatePacket, Attribute, AvailableCommandsPacket, BehaviorPackInfo, BiomeDefinitionListPacket, BlockCoordinates, BlockFace, BlockPickRequestPacket, BlockProperties, ChainedSubcommandValues, ChangeDimensionPacket, ChunkCoords, ChunkRadiusUpdatePacket, CommandOriginData, CommandOutputData, CommandOutputMessage, CommandOutputPacket, CommandParameterType, CommandPermissionLevel, CommandRequestPacket, Commands, ComplexInventoryTransaction, ComponentItem, CompressionMethod, ContainerClosePacket, ContainerId, ContainerName, ContainerOpenPacket, ContainerType, CreativeContentPacket, CreativeItems, DataPacket, DeviceOS, Difficulty, DimensionType, DisconnectPacket, DisconnectReason, DynamicEnums, EntityAttributes, EntityProperties, EnumConstraints, EnumValues, Enums, Experiments, Framer, GameRuleType, GameRules, Gamemode, InteractActions, InteractPacket, InteractPosition, InventoryAction, InventoryContentPacket, InventorySlotPacket, InventorySource, InventorySourceType, InventoryTransaction, InventoryTransactionPacket, ItemComponentPacket, ItemData, ItemInstanceUserData, ItemReleaseInventoryTransaction, ItemReleaseInventoryTransactionType, type ItemStackAction, ItemStackActionType, type ItemStackContainer, ItemStackRequestPacket, ItemStackRequests, ItemStackResponsePacket, ItemStackResponses, ItemStackStatus, ItemStacks, ItemUseInventoryTransaction, ItemUseInventoryTransactionType, ItemUseOnEntityInventoryTransaction, ItemUseOnEntityInventoryTransactionType, LegacyTransaction, LevelChunkPacket, LevelEvent, LevelEventPacket, LevelSoundEvent, LevelSoundEventPacket, Links, LoginPacket, LoginTokens, MINECRAFT_TICK_SPEED, MINECRAFT_VERSION, MetadataDictionary, MetadataFlags, MetadataKey, MetadataType, MobEquipmentPacket, ModalFormCanceled, ModalFormCanceledReason, ModalFormData, ModalFormRequestPacket, ModalFormResponsePacket, ModalFormType, MoveActorAbsolutePacket, MoveMode, MovePlayerPacket, NetworkChunkPublisherUpdatePacket, NetworkItemInstanceDescriptor, NetworkItemStackDescriptor, NetworkSettingsPacket, PROTOCOL_VERSION, PackLinks, PackType, Packet, PacketViolationWarningPacket, Packets, PermissionLevel, PlayStatus, PlayStatusPacket, PlayerActionPacket, PlayerAttributes, PlayerAuthInputPacket, PlayerHotbarPacket, PlayerListPacket, PostFixes, RecordAction, Records, RemoveEntityPacket, RequestChunkRadiusPacket, RequestNetworkSettingsPacket, ResourceIdVersions, ResourcePackChunkDataPacket, ResourcePackChunkRequestPacket, ResourcePackClientResponsePacket, ResourcePackDataInfoPacket, ResourcePackIds, ResourcePackResponse, ResourcePackStackPacket, ResourcePacksInfoPacket, RespawnPacket, RespawnState, Rotation, ScriptMessagePacket, SetActorMotionPacket, SetCommandsEnabledPacket, SetEntityDataPacket, SetLocalPlayerAsInitializedPacket, SetPlayerGameTypePacket, SetTimePacket, SetTitlePacket, StackRequestSlotInfo, StartGamePacket, Subcommands, TeleportCause, TextPacket, TextPacketType, TextParameters, TextSource, TexturePackInfo, TitleTypes, ToastRequestPacket, TransactionSourceType, UpdateAbilitiesPacket, UpdateAdventureSettingsPacket, UpdateAttributesPacket, UpdateBlockFlagsType, UpdateBlockLayerType, UpdateBlockPacket, VariableStringArray as VarStringArray, VarintArray, Vector2f, Vector3f, ViolationSeverity, ViolationType, getPacketId };
+export { AbilityLayerFlag, AbilityLayerType, AbilityLayers, AbilitySet, ActionIds, AddEntityPacket, AddItemActorPacket, AddPlayerPacket, AnimateAction, AnimateId, AnimatePacket, Attribute, AvailableCommandsPacket, BehaviorPackInfo, BiomeDefinitionListPacket, BlockCoordinates, BlockFace, BlockPickRequestPacket, BlockProperties, ChainedSubcommandValues, ChangeDimensionPacket, ChunkCoords, ChunkRadiusUpdatePacket, CommandOriginData, CommandOutputData, CommandOutputMessage, CommandOutputPacket, CommandParameterType, CommandPermissionLevel, CommandRequestPacket, Commands, ComplexInventoryTransaction, ComponentItem, CompressionMethod, ContainerClosePacket, ContainerId, ContainerName, ContainerOpenPacket, ContainerType, CreativeContentPacket, CreativeItems, DataPacket, DeviceOS, Difficulty, DimensionType, DisconnectPacket, DisconnectReason, DynamicEnums, EntityAttributes, EntityProperties, EnumConstraints, EnumValues, Enums, Experiments, Framer, GameRuleType, GameRules, Gamemode, InteractActions, InteractPacket, InteractPosition, InventoryAction, InventoryContentPacket, InventorySlotPacket, InventorySource, InventorySourceType, InventoryTransaction, InventoryTransactionPacket, ItemComponentPacket, ItemData, ItemInstanceUserData, ItemReleaseInventoryTransaction, ItemReleaseInventoryTransactionType, type ItemStackAction, ItemStackActionType, type ItemStackContainer, ItemStackRequestPacket, ItemStackRequests, ItemStackResponsePacket, ItemStackResponses, ItemStackStatus, ItemStacks, ItemUseInventoryTransaction, ItemUseInventoryTransactionType, ItemUseOnEntityInventoryTransaction, ItemUseOnEntityInventoryTransactionType, LegacyTransaction, LevelChunkPacket, LevelEvent, LevelEventPacket, LevelSoundEvent, LevelSoundEventPacket, Links, LoginPacket, LoginTokens, MINECRAFT_TICK_SPEED, MINECRAFT_VERSION, MetadataDictionary, MetadataFlags, MetadataKey, MetadataType, MobEquipmentPacket, ModalFormCanceled, ModalFormCanceledReason, ModalFormData, ModalFormRequestPacket, ModalFormResponsePacket, ModalFormType, MoveActorAbsolutePacket, MoveMode, MovePlayerPacket, NetworkChunkPublisherUpdatePacket, NetworkItemInstanceDescriptor, NetworkItemStackDescriptor, NetworkSettingsPacket, PROTOCOL_VERSION, PackLinks, PackType, Packet, PacketViolationWarningPacket, Packets, PermissionLevel, PlayStatus, PlayStatusPacket, PlayerActionPacket, PlayerAttributes, PlayerAuthInputPacket, PlayerHotbarPacket, PlayerListAction, PlayerListPacket, PlayerListRecord, PostFixes, RemoveEntityPacket, RequestChunkRadiusPacket, RequestNetworkSettingsPacket, ResourceIdVersions, ResourcePackChunkDataPacket, ResourcePackChunkRequestPacket, ResourcePackClientResponsePacket, ResourcePackDataInfoPacket, ResourcePackIds, ResourcePackResponse, ResourcePackStackPacket, ResourcePacksInfoPacket, RespawnPacket, RespawnState, Rotation, ScriptMessagePacket, SerializedSkin, SetActorMotionPacket, SetCommandsEnabledPacket, SetEntityDataPacket, SetLocalPlayerAsInitializedPacket, SetPlayerGameTypePacket, SetTimePacket, SetTitlePacket, SkinAnimation, SkinImage, SkinPersonaPiece, SkinPersonaTintPiece, StackRequestSlotInfo, StartGamePacket, Subcommands, TeleportCause, TextPacket, TextPacketType, TextParameters, TextSource, TexturePackInfo, TitleTypes, ToastRequestPacket, TransactionSourceType, UpdateAbilitiesPacket, UpdateAdventureSettingsPacket, UpdateAttributesPacket, UpdateBlockFlagsType, UpdateBlockLayerType, UpdateBlockPacket, VariableStringArray as VarStringArray, VarintArray, Vector2f, Vector3f, ViolationSeverity, ViolationType, getPacketId };