Interface savedPlayerData

interface savedPlayerData {
    dimension?: string | Dimension;
    firstJoined?: number;
    format_version?: string;
    gameMode?: string;
    id: string;
    inputInfo?: {
        lastInputModeUsed: InputMode;
        touchOnlyAffectsHotbar: boolean;
    };
    inputPermissions?: {
        Camera?: boolean;
        cameraEnabled?: boolean;
        Dismount?: boolean;
        Jump?: boolean;
        LateralMovement?: boolean;
        Mount?: boolean;
        MoveBackward?: boolean;
        MoveForward?: boolean;
        MoveLeft?: boolean;
        Movement?: boolean;
        movementEnabled?: boolean;
        MoveRight?: boolean;
        Sneak?: boolean;
    };
    isOp?: boolean;
    items?: {
        ender_chest: undefined
        | savedItem[];
        equipment: undefined | savedItem[];
        inventory: undefined | savedItem[];
    };
    lastOnline: number;
    location?: Vector3;
    maxRenderDistance?: number;
    memoryTier?: MemoryTier;
    name: string;
    nameTag?: string;
    onJoinActions?: SavedPlayerOnJoinActions;
    platformType?: PlatformType;
    player_save_format_version?: string;
    playerPermissions?: Pick<
        Globals.PlayerPermissions,
        | "canUseChatCommands"
        | "admin"
        | "canUseDangerousCommands"
        | "permissionLevel"
        | "canUseScriptEval"
        | "canUseCommands"
        | "canBypassProtectedAreas"
        | "getAllChatCommands",
    >;
    properties?: [id: string, value: string | number | Boolean | Vector3][];
    rotation?: Vector2;
    saveId?: string;
    saveMode?: PlayerDataSaveMode;
    scoreboardIdentity?: number;
    selectedSlotIndex?: number;
    spawnPoint?: DimensionLocation;
    tags?: string[];
}

Properties

dimension? firstJoined? format_version? gameMode? id inputInfo? inputPermissions? isOp? items? lastOnline location? maxRenderDistance? memoryTier? name nameTag? onJoinActions? platformType? player_save_format_version? playerPermissions? properties? rotation? saveId? saveMode? scoreboardIdentity? selectedSlotIndex? spawnPoint? tags?

Properties

Optionaldimension

dimension?: string | Dimension

OptionalfirstJoined

firstJoined?: number

Optionalformat_version

format_version?: string

OptionalgameMode

gameMode?: string

id

id: string

OptionalinputInfo

inputInfo?: { lastInputModeUsed: InputMode; touchOnlyAffectsHotbar: boolean }

Since

format version 1.6.0

Since

v1.28.0-preview.20+BUILD.1

OptionalinputPermissions

inputPermissions?: {
    Camera?: boolean;
    cameraEnabled?: boolean;
    Dismount?: boolean;
    Jump?: boolean;
    LateralMovement?: boolean;
    Mount?: boolean;
    MoveBackward?: boolean;
    MoveForward?: boolean;
    MoveLeft?: boolean;
    Movement?: boolean;
    movementEnabled?: boolean;
    MoveRight?: boolean;
    Sneak?: boolean;
}

Type declaration

  • OptionalCamera?: boolean
  • OptionalcameraEnabled?: boolean

    Deprecated

    Only exists in format versions below 1.6.0.

    Deprecated

    Supercceeded by Camera.

  • OptionalDismount?: boolean
  • OptionalJump?: boolean
  • OptionalLateralMovement?: boolean
  • OptionalMount?: boolean
  • OptionalMoveBackward?: boolean
  • OptionalMoveForward?: boolean
  • OptionalMoveLeft?: boolean
  • OptionalMovement?: boolean
  • OptionalmovementEnabled?: boolean

    Deprecated

    Only exists in format versions below 1.6.0.

    Deprecated

    Supercceeded by Movement.

  • OptionalMoveRight?: boolean
  • OptionalSneak?: boolean

OptionalisOp

isOp?: boolean

Optionalitems

items?: {
    ender_chest: undefined | savedItem[];
    equipment: undefined | savedItem[];
    inventory: undefined | savedItem[];
}

lastOnline

lastOnline: number

Optionallocation

location?: Vector3

OptionalmaxRenderDistance

maxRenderDistance?: number

OptionalmemoryTier

memoryTier?: MemoryTier

name

name: string

OptionalnameTag

nameTag?: string

OptionalonJoinActions

onJoinActions?: SavedPlayerOnJoinActions

Since

format version 1.6.0

Since

v1.28.0-preview.20+BUILD.1

OptionalplatformType

platformType?: PlatformType

Optionalplayer_save_format_version

player_save_format_version?: string

OptionalplayerPermissions

playerPermissions?: Pick<
    Globals.PlayerPermissions,
    | "canUseChatCommands"
    | "admin"
    | "canUseDangerousCommands"
    | "permissionLevel"
    | "canUseScriptEval"
    | "canUseCommands"
    | "canBypassProtectedAreas"
    | "getAllChatCommands",
>

Since

format version 1.6.0

Since

v1.28.0-preview.20+BUILD.1

Optionalproperties

properties?: [id: string, value: string | number | Boolean | Vector3][]

Optionalrotation

rotation?: Vector2

OptionalsaveId

saveId?: string

OptionalsaveMode

saveMode?: PlayerDataSaveMode

Since

format version 1.6.0

Since

v1.33.0-preview.20+BUILD.4

OptionalscoreboardIdentity

scoreboardIdentity?: number

OptionalselectedSlotIndex

selectedSlotIndex?: number

OptionalspawnPoint

spawnPoint?: DimensionLocation

Optionaltags

tags?: string[]

Settings

Member Visibility

On This Page

Properties