Class savedPlayer

Constructors

constructor

new savedPlayer(data: savedPlayerData): Globals.modules.playersave.savedPlayer
Parameters
- data: savedPlayerData
Returns Globals.modules.playersave.savedPlayer
- Defined in modules/player_save/classes/savedPlayer.ts:203

Properties

`Optional`dimension

dimension?: string | Dimension

firstJoined

firstJoined: number

format_version

format_version: string = format_version

`Optional`gameMode

gameMode?: string

id

id: string

`Optional`inputInfo

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

Since

format version 1.6.0

Since

v1.28.0-preview.20+BUILD.1

`Optional`inputPermissions

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

`Optional`isOp

isOp?: boolean

`Optional`items

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

lastOnline

lastOnline: number

`Optional`location

location?: Vector3

`Optional`maxRenderDistance

maxRenderDistance?: number

`Optional`memoryTier

memoryTier?: MemoryTier

name

name: string

`Optional`nameTag

nameTag?: string

onJoinActions

onJoinActions: SavedPlayerOnJoinActions = []

Since

format version 1.6.0

Since

v1.28.0-preview.20+BUILD.1

`Optional`platformType

platformType?: PlatformType

player_save_format_version

player_save_format_version: string = player_save_format_version

`Optional`playerPermissions

playerPermissions?: {
    admin: boolean;
    canBypassProtectedAreas: boolean;
    canUseChatCommands: boolean;
    canUseCommands: boolean;
    canUseDangerousCommands: boolean;
    canUseScriptEval: boolean;
    getAllChatCommands: boolean;
    permissionLevel: number;
}

Since

format version 1.6.0

Since

v1.28.0-preview.20+BUILD.1

`Optional`properties

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

`Optional`rotation

rotation?: Vector2

saveId

saveId: string

saveMode

saveMode: PlayerDataSaveMode = "full"

`Optional`scoreboardIdentity

scoreboardIdentity?: number

`Optional`selectedSlotIndex

selectedSlotIndex?: number

`Optional`spawnPoint

spawnPoint?: DimensionLocation

`Optional`tags

tags?: string[]

Accessors

bans

get bans(): {
    all: Globals.modules.bans.ban[];
    expired: Globals.modules.bans.ban[];
    valid: Globals.modules.bans.ban[];
}
Returns {
    all: Globals.modules.bans.ban[];
    expired: Globals.modules.bans.ban[];
    valid: Globals.modules.bans.ban[];
}
- Defined in modules/player_save/classes/savedPlayer.ts:344

hasLegacyInventorySave

get hasLegacyInventorySave(): boolean
Returns true if the player's saved inventory data is using the legacy pre-1.5.0 format, this would be the case if the player's inventory was saved before the 1.5.0 player save format version, or the config.system.useLegacyPlayerInventoryDataSaveSystem option was set to true when the player's inventory was saved.

Returns boolean
- Defined in modules/player_save/classes/savedPlayer.ts:371

hasModernInventorySave

get hasModernInventorySave(): boolean
Returns boolean
- Defined in modules/player_save/classes/savedPlayer.ts:374

idBans

get idBans(): {
    all: Globals.modules.bans.ban[];
    expired: Globals.modules.bans.ban[];
    valid: Globals.modules.bans.ban[];
}
Returns {
    all: Globals.modules.bans.ban[];
    expired: Globals.modules.bans.ban[];
    valid: Globals.modules.bans.ban[];
}
- Defined in modules/player_save/classes/savedPlayer.ts:360

isBanned

get isBanned(): boolean
Returns boolean
- Defined in modules/player_save/classes/savedPlayer.ts:335

isIdBanned

get isIdBanned(): boolean
Returns boolean
- Defined in modules/player_save/classes/savedPlayer.ts:341

isNameBanned

get isNameBanned(): boolean
Returns boolean
- Defined in modules/player_save/classes/savedPlayer.ts:338

isOnline

get isOnline(): boolean
Returns boolean
- Defined in modules/player_save/classes/savedPlayer.ts:332

nameBans

get nameBans(): {
    all: Globals.modules.bans.ban[];
    expired: Globals.modules.bans.ban[];
    valid: Globals.modules.bans.ban[];
}
Returns {
    all: Globals.modules.bans.ban[];
    expired: Globals.modules.bans.ban[];
    valid: Globals.modules.bans.ban[];
}
- Defined in modules/player_save/classes/savedPlayer.ts:352

Methods

addOnJoinAction

addOnJoinAction(action: SavedPlayerOnJoinAction): this
Parameters
- action: SavedPlayerOnJoinAction
Returns this
- Defined in modules/player_save/classes/savedPlayer.ts:275

addOnJoinActions

addOnJoinActions(actions: SavedPlayerOnJoinActions): this
Parameters
- actions: SavedPlayerOnJoinActions
Returns this
- Defined in modules/player_save/classes/savedPlayer.ts:280

executeOnJoinActions

executeOnJoinActions(): Promise<void>
Returns Promise<void>
- Defined in modules/player_save/classes/savedPlayer.ts:290

getItems

getItems(
    sourceLoc: DimensionLocation,
): {
    "0"?: ItemStack;
    "1"?: ItemStack;
    "10"?: ItemStack;
    "11"?: ItemStack;
    "12"?: ItemStack;
    "13"?: ItemStack;
    "14"?: ItemStack;
    "15"?: ItemStack;
    "16"?: ItemStack;
    "17"?: ItemStack;
    "18"?: ItemStack;
    "19"?: ItemStack;
    "2"?: ItemStack;
    "20"?: ItemStack;
    "21"?: ItemStack;
    "22"?: ItemStack;
    "23"?: ItemStack;
    "24"?: ItemStack;
    "25"?: ItemStack;
    "26"?: ItemStack;
    "27"?: ItemStack;
    "28"?: ItemStack;
    "29"?: ItemStack;
    "3"?: ItemStack;
    "30"?: ItemStack;
    "31"?: ItemStack;
    "32"?: ItemStack;
    "33"?: ItemStack;
    "34"?: ItemStack;
    "35"?: ItemStack;
    "4"?: ItemStack;
    "5"?: ItemStack;
    "6"?: ItemStack;
    "7"?: ItemStack;
    "8"?: ItemStack;
    "9"?: ItemStack;
    Chest?: ItemStack;
    Cursor?: ItemStack;
    Feet?: ItemStack;
    Head?: ItemStack;
    Legs?: ItemStack;
    Mainhand?: ItemStack;
    Offhand?: ItemStack;
}
Parameters
- sourceLoc: DimensionLocation
Returns {
    "0"?: ItemStack;
    "1"?: ItemStack;
    "10"?: ItemStack;
    "11"?: ItemStack;
    "12"?: ItemStack;
    "13"?: ItemStack;
    "14"?: ItemStack;
    "15"?: ItemStack;
    "16"?: ItemStack;
    "17"?: ItemStack;
    "18"?: ItemStack;
    "19"?: ItemStack;
    "2"?: ItemStack;
    "20"?: ItemStack;
    "21"?: ItemStack;
    "22"?: ItemStack;
    "23"?: ItemStack;
    "24"?: ItemStack;
    "25"?: ItemStack;
    "26"?: ItemStack;
    "27"?: ItemStack;
    "28"?: ItemStack;
    "29"?: ItemStack;
    "3"?: ItemStack;
    "30"?: ItemStack;
    "31"?: ItemStack;
    "32"?: ItemStack;
    "33"?: ItemStack;
    "34"?: ItemStack;
    "35"?: ItemStack;
    "4"?: ItemStack;
    "5"?: ItemStack;
    "6"?: ItemStack;
    "7"?: ItemStack;
    "8"?: ItemStack;
    "9"?: ItemStack;
    Chest?: ItemStack;
    Cursor?: ItemStack;
    Feet?: ItemStack;
    Head?: ItemStack;
    Legs?: ItemStack;
    Mainhand?: ItemStack;
    Offhand?: ItemStack;
}
- Defined in modules/player_save/classes/savedPlayer.ts:269

remove

remove(): void
Returns void
- Defined in modules/player_save/classes/savedPlayer.ts:266

removeOnJoinActionsOfType

removeOnJoinActionsOfType(
    type:
        | "add_tag"
        | "remove_tag"
        | "add_tags"
        | "remove_tags"
        | "remove_item_in_slot"
        | "clear_inventory"
        | "set_permission"
        | "send_message",
): this
Parameters
- type:
      | "add_tag"
      | "remove_tag"
      | "add_tags"
      | "remove_tags"
      | "remove_item_in_slot"
      | "clear_inventory"
      | "set_permission"
      | "send_message"
Returns this
- Defined in modules/player_save/classes/savedPlayer.ts:285

save

save(): void
Returns void
- Defined in modules/player_save/classes/savedPlayer.ts:263

`Static`getSavedInventory

getSavedInventory(
    playerId: string,
    sourceLoc: DimensionLocation,
    options?: {
        bypassParameterTypeChecks?: boolean;
        rethrowErrorInFinally?: boolean;
    },
): {
    "0"?: ItemStack;
    "1"?: ItemStack;
    "10"?: ItemStack;
    "11"?: ItemStack;
    "12"?: ItemStack;
    "13"?: ItemStack;
    "14"?: ItemStack;
    "15"?: ItemStack;
    "16"?: ItemStack;
    "17"?: ItemStack;
    "18"?: ItemStack;
    "19"?: ItemStack;
    "2"?: ItemStack;
    "20"?: ItemStack;
    "21"?: ItemStack;
    "22"?: ItemStack;
    "23"?: ItemStack;
    "24"?: ItemStack;
    "25"?: ItemStack;
    "26"?: ItemStack;
    "27"?: ItemStack;
    "28"?: ItemStack;
    "29"?: ItemStack;
    "3"?: ItemStack;
    "30"?: ItemStack;
    "31"?: ItemStack;
    "32"?: ItemStack;
    "33"?: ItemStack;
    "34"?: ItemStack;
    "35"?: ItemStack;
    "4"?: ItemStack;
    "5"?: ItemStack;
    "6"?: ItemStack;
    "7"?: ItemStack;
    "8"?: ItemStack;
    "9"?: ItemStack;
    Chest?: ItemStack;
    Cursor?: ItemStack;
    Feet?: ItemStack;
    Head?: ItemStack;
    Legs?: ItemStack;
    Mainhand?: ItemStack;
    Offhand?: ItemStack;
}
Parameters
- playerId: string
- sourceLoc: DimensionLocation
- options: { bypassParameterTypeChecks?: boolean; rethrowErrorInFinally?: boolean } = ...
Returns {
    "0"?: ItemStack;
    "1"?: ItemStack;
    "10"?: ItemStack;
    "11"?: ItemStack;
    "12"?: ItemStack;
    "13"?: ItemStack;
    "14"?: ItemStack;
    "15"?: ItemStack;
    "16"?: ItemStack;
    "17"?: ItemStack;
    "18"?: ItemStack;
    "19"?: ItemStack;
    "2"?: ItemStack;
    "20"?: ItemStack;
    "21"?: ItemStack;
    "22"?: ItemStack;
    "23"?: ItemStack;
    "24"?: ItemStack;
    "25"?: ItemStack;
    "26"?: ItemStack;
    "27"?: ItemStack;
    "28"?: ItemStack;
    "29"?: ItemStack;
    "3"?: ItemStack;
    "30"?: ItemStack;
    "31"?: ItemStack;
    "32"?: ItemStack;
    "33"?: ItemStack;
    "34"?: ItemStack;
    "35"?: ItemStack;
    "4"?: ItemStack;
    "5"?: ItemStack;
    "6"?: ItemStack;
    "7"?: ItemStack;
    "8"?: ItemStack;
    "9"?: ItemStack;
    Chest?: ItemStack;
    Cursor?: ItemStack;
    Feet?: ItemStack;
    Head?: ItemStack;
    Legs?: ItemStack;
    Mainhand?: ItemStack;
    Offhand?: ItemStack;
}
- Defined in modules/player_save/classes/savedPlayer.ts:639

`Static`getSavedPlayer

getSavedPlayer(savedPlayerId: string): Globals.modules.playersave.savedPlayer
Parameters
- savedPlayerId: string
Returns Globals.modules.playersave.savedPlayer
- Defined in modules/player_save/classes/savedPlayer.ts:1421

`Static`getSavedPlayerIds

getSavedPlayerIds(): string[]
Returns string[]
- Defined in modules/player_save/classes/savedPlayer.ts:377

`Static`getSavedPlayers

getSavedPlayers(): Globals.modules.playersave.savedPlayer[]
Returns Globals.modules.playersave.savedPlayer[]
- Defined in modules/player_save/classes/savedPlayer.ts:1428

`Static`getSavedPlayersAlphabeticalOrder

getSavedPlayersAlphabeticalOrder(): Globals.modules.playersave.savedPlayer[]
Returns Globals.modules.playersave.savedPlayer[]
- Defined in modules/player_save/classes/savedPlayer.ts:1436

`Static`saveInventory

saveInventory(
    player: Player,
    options?: {
        bypassParameterTypeChecks?: boolean;
        rethrowErrorInFinally?: boolean;
    },
): void
Parameters
- player: Player
- options: { bypassParameterTypeChecks?: boolean; rethrowErrorInFinally?: boolean } = ...
Returns void
- Defined in modules/player_save/classes/savedPlayer.ts:529

`Static`saveInventoryAsync

saveInventoryAsync(
    player: Player,
    options?: {
        bypassParameterTypeChecks?: boolean;
        rethrowErrorInFinally?: boolean;
    },
): Promise<void>
Parameters
- player: Player
- options: { bypassParameterTypeChecks?: boolean; rethrowErrorInFinally?: boolean } = ...
Returns Promise<void>
- Defined in modules/player_save/classes/savedPlayer.ts:389

`Static`savePlayer

savePlayer(player: Player): string
Parameters
- player: Player
Returns string
- Defined in modules/player_save/classes/savedPlayer.ts:841

`Static`savePlayerAsync

savePlayerAsync(player: Player): Promise<string>
Parameters
- player: Player
Returns Promise<string>
- Defined in modules/player_save/classes/savedPlayer.ts:1123

`Static`savePlayerData

savePlayerData(savedPlayerData: savedPlayerData): string
Parameters
- savedPlayerData: savedPlayerData
Returns string
- Defined in modules/player_save/classes/savedPlayer.ts:382

Class savedPlayer

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Globals.modules.playersave.savedPlayer

Properties

Optionaldimension

firstJoined

format_version

OptionalgameMode

id

OptionalinputInfo

Since

Since

OptionalinputPermissions

Type declaration

OptionalCamera?: boolean

OptionalcameraEnabled?: boolean

Deprecated

Deprecated

OptionalDismount?: boolean

OptionalJump?: boolean

OptionalLateralMovement?: boolean

OptionalMount?: boolean

OptionalMoveBackward?: boolean

OptionalMoveForward?: boolean

OptionalMoveLeft?: boolean

OptionalMovement?: boolean

OptionalmovementEnabled?: boolean

Deprecated

Deprecated

OptionalMoveRight?: boolean

OptionalSneak?: boolean

OptionalisOp

Optionalitems

lastOnline

Optionallocation

OptionalmaxRenderDistance

OptionalmemoryTier

name

OptionalnameTag

onJoinActions

Since

Since

OptionalplatformType

player_save_format_version

OptionalplayerPermissions

Since

Since

Optionalproperties

Optionalrotation

saveId

saveMode

OptionalscoreboardIdentity

OptionalselectedSlotIndex

OptionalspawnPoint

Optionaltags

Accessors

bans

Returns { all: Globals.modules.bans.ban[]; expired: Globals.modules.bans.ban[]; valid: Globals.modules.bans.ban[];}

hasLegacyInventorySave

Returns boolean

hasModernInventorySave

Returns boolean

idBans

Returns { all: Globals.modules.bans.ban[]; expired: Globals.modules.bans.ban[]; valid: Globals.modules.bans.ban[];}

isBanned

Returns boolean

isIdBanned

Returns boolean

isNameBanned

Returns boolean

isOnline

Returns boolean

nameBans

`Optional`dimension

`Optional`gameMode

`Optional`inputInfo

`Optional`inputPermissions

`Optional`Camera?: boolean

`Optional`cameraEnabled?: boolean

`Optional`Dismount?: boolean

`Optional`Jump?: boolean

`Optional`LateralMovement?: boolean

`Optional`Mount?: boolean

`Optional`MoveBackward?: boolean

`Optional`MoveForward?: boolean

`Optional`MoveLeft?: boolean

`Optional`Movement?: boolean

`Optional`movementEnabled?: boolean

`Optional`MoveRight?: boolean

`Optional`Sneak?: boolean

`Optional`isOp

`Optional`items

`Optional`location

`Optional`maxRenderDistance

`Optional`memoryTier

`Optional`nameTag

`Optional`platformType

`Optional`playerPermissions

`Optional`properties

`Optional`rotation

`Optional`scoreboardIdentity

`Optional`selectedSlotIndex

`Optional`spawnPoint

`Optional`tags

Returns {
all: Globals.modules.bans.ban[];
expired: Globals.modules.bans.ban[];
valid: Globals.modules.bans.ban[];
}

Returns {
all: Globals.modules.bans.ban[];
expired: Globals.modules.bans.ban[];
valid: Globals.modules.bans.ban[];
}

Returns {
all: Globals.modules.bans.ban[];
expired: Globals.modules.bans.ban[];
valid: Globals.modules.bans.ban[];
}

`Static`getSavedInventory

`Static`getSavedPlayer

`Static`getSavedPlayerIds

`Static`getSavedPlayers

`Static`getSavedPlayersAlphabeticalOrder

`Static`saveInventory

`Static`saveInventoryAsync

`Static`savePlayer

`Static`savePlayerAsync

`Static`savePlayerData