Class PlayerLevelStorage

Hierarchy (View Summary)

EntityLevelStorage
- PlayerLevelStorage

Constructors

constructor

new PlayerLevelStorage(player: Player, source?: CompoundTag): PlayerLevelStorage
Parameters
- player: Player
- Optionalsource: CompoundTag
Returns PlayerLevelStorage
Overrides EntityLevelStorage.constructor
- Defined in packages/core/src/entity/storage/player.ts:16

Properties

`Readonly`[toStringTag]

"[toStringTag]": string

`Protected` `Readonly`dynamicProperties

dynamicProperties: Map<string, CompoundTag> = ...

The dynamic properties map holding property identifiers and their corresponding CompoundTag representations.

name

name: null | string

The name of the nbt tag.

`Readonly`size

size: number

Returns

the number of elements in the Map.

`Readonly`type

type: Compound = TagType.Compound

The nbt tag type of the data type.

`Static` `Readonly`[species]

"[species]": MapConstructor

`Protected` `Static` `Readonly`DYNAMIC_PROPERTIES_KEY

DYNAMIC_PROPERTIES_KEY: "dynamic_properties"

The storage key for dynamic properties.

Methods

[iterator]

"[iterator]"(): MapIterator<[string, BaseTag]>
Returns an iterable of entries in the map.

Returns MapIterator<[string, BaseTag]>
Inherited from EntityLevelStorage.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

add

add<T extends BaseTag>(tag: T): T
Add a single tag to the compound tag.
Type Parameters
- T extends BaseTag
Parameters
- tag: T
  The tag to add to the compound tag.
Returns T
The tag that was added.
Inherited from EntityLevelStorage.add
- Defined in packages/nbt/dist/index.d.ts:211

addTrait

addTrait(identifier: string): void
Parameters
- identifier: string
Returns void
Inherited from EntityLevelStorage.addTrait
- Defined in packages/core/src/entity/storage/entity.ts:444

clear

clear(): void
Returns void
Inherited from EntityLevelStorage.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:20

delete

delete(key: string): boolean
Parameters
- key: string
Returns boolean
true if an element in the Map existed and has been removed, or false if the element does not exist.
Inherited from EntityLevelStorage.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:24

entries

entries(): MapIterator<[string, BaseTag]>
Returns an iterable of key, value pairs for every entry in the map.

Returns MapIterator<[string, BaseTag]>
Inherited from EntityLevelStorage.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

forEach(
    callbackfn: (
        value: BaseTag,
        key: string,
        map: Map<string, BaseTag>,
    ) => void,
    thisArg?: any,
): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: (value: BaseTag, key: string, map: Map<string, BaseTag>) => void
- OptionalthisArg: any
Returns void
Inherited from EntityLevelStorage.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:28

get

get<T extends BaseTag>(key: string): undefined | T
Get a nbt tag by its key.
Type Parameters
- T extends BaseTag
Parameters
- key: string
  The key of the tag to retrieve.
Returns undefined | T
The tag associated with the key, or undefined if not found.
Inherited from EntityLevelStorage.get
- Defined in packages/nbt/dist/index.d.ts:192

getAbilities

getAbilities(): [AbilityIndex, boolean][]
Returns [AbilityIndex, boolean][]
- Defined in packages/core/src/entity/storage/player.ts:60

getAllDynamicProperties

getAllDynamicProperties(): [string, JSONLikeValue][]
Get all dynamic properties from the level storage.

Returns [string, JSONLikeValue][]
An array of tuples containing property identifier and its value.
Inherited from EntityLevelStorage.getAllDynamicProperties
- Defined in packages/core/src/entity/storage/entity.ts:265

getDynamicProperty

getDynamicProperty<T extends JSONLikeValue>(identifier: string): null | T
Get a dynamic property by its identifier.
Type Parameters
- T extends JSONLikeValue
Parameters
- identifier: string
  The identifier of the dynamic property to retrieve.
Returns null | T
The value of the dynamic property, or null if not found.
Inherited from EntityLevelStorage.getDynamicProperty
- Defined in packages/core/src/entity/storage/entity.ts:308

getIdentifier

getIdentifier(): string
Get the entity identifier from the level storage.

Returns string
The entity identifier as a string or EntityIdentifier.

Throws
Error if the identifier is not found.
Inherited from EntityLevelStorage.getIdentifier
- Defined in packages/core/src/entity/storage/entity.ts:75

getPosition

getPosition(): Vector3f
Get the position of the entity from the level storage.

Returns Vector3f
The position as a Vector3f instance.

Throws
Error if the position tag is not found.
Inherited from EntityLevelStorage.getPosition
- Defined in packages/core/src/entity/storage/entity.ts:127

getRotation

getRotation(): Rotation
Get the rotation of the entity from the level storage.

Returns Rotation
The rotation as a Rotation instance.

Throws
Error if the rotation tag is not found.
Inherited from EntityLevelStorage.getRotation
- Defined in packages/core/src/entity/storage/entity.ts:213

getTraits

getTraits(): string[]
Get the traits of the entity from the level storage.

Returns string[]
An array of trait identifiers.
Inherited from EntityLevelStorage.getTraits
- Defined in packages/core/src/entity/storage/entity.ts:382

getUniqueId

getUniqueId(): bigint
Get the unique ID of the entity from the level storage.

Returns bigint
The unique ID as a bigint.

Throws
Error if the UniqueID tag is not found.
Inherited from EntityLevelStorage.getUniqueId
- Defined in packages/core/src/entity/storage/entity.ts:101

has

has(key: string): boolean
Parameters
- key: string
Returns boolean
boolean indicating whether an element with the specified key exists or not.
Inherited from EntityLevelStorage.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:37

hasDynamicProperty

hasDynamicProperty(identifier: string): boolean
Check if a dynamic property exists in the level storage.
Parameters
- identifier: string
  The identifier of the dynamic property to check.
Returns boolean
True if the property exists, false otherwise.
Inherited from EntityLevelStorage.hasDynamicProperty
- Defined in packages/core/src/entity/storage/entity.ts:299

hasTrait

hasTrait(identifier: string): boolean
Parameters
- identifier: string
Returns boolean
Inherited from EntityLevelStorage.hasTrait
- Defined in packages/core/src/entity/storage/entity.ts:425

isPlayer

isPlayer(): this is PlayerLevelStorage
Returns this is PlayerLevelStorage
Inherited from EntityLevelStorage.isPlayer
- Defined in packages/core/src/entity/storage/entity.ts:66

keys

keys(): MapIterator<string>
Returns an iterable of keys in the map

Returns MapIterator<string>
Inherited from EntityLevelStorage.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

push

push<T extends BaseTag>(...tags: T[]): this
Add multiple tags to the compound tag.
Type Parameters
- T extends BaseTag
Parameters
- ...tags: T[]
  An array of tags to add.
Returns this
The current instance for method chaining.
Inherited from EntityLevelStorage.push
- Defined in packages/nbt/dist/index.d.ts:205

removeDynamicProperty

removeDynamicProperty(identifier: string): void
Remove a dynamic property from the level storage.
Parameters
- identifier: string
  The identifier of the dynamic property to remove.
Returns void
Inherited from EntityLevelStorage.removeDynamicProperty
- Defined in packages/core/src/entity/storage/entity.ts:365

removeTrait

removeTrait(identifier: string): void
Parameters
- identifier: string
Returns void
Inherited from EntityLevelStorage.removeTrait
- Defined in packages/core/src/entity/storage/entity.ts:461

set

set<T extends BaseTag>(key: string, value: T): this
Set a nbt tag with a specific key.
Type Parameters
- T extends BaseTag
Parameters
- key: string
  The key to associate with the tag.
- value: T
  The tag to set.
Returns this
The current instance for method chaining.
Inherited from EntityLevelStorage.set
- Defined in packages/nbt/dist/index.d.ts:199

setAbilities

setAbilities(abilities: [AbilityIndex, boolean][]): void
Parameters
- abilities: [AbilityIndex, boolean][]
Returns void
- Defined in packages/core/src/entity/storage/player.ts:86

setDynamicProperty

setDynamicProperty<T extends JSONLikeValue>(identifier: string, value: T): void
Set a dynamic property in the level storage.
Type Parameters
- T extends JSONLikeValue
Parameters
- identifier: string
  The identifier of the dynamic property to set.
- value: T
  The value of the dynamic property to set.
Returns void
Inherited from EntityLevelStorage.setDynamicProperty
- Defined in packages/core/src/entity/storage/entity.ts:338

setIdentifier

setIdentifier(identifier: string): void
Set the entity identifier in the level storage.
Parameters
- identifier: string
  The entity identifier to set, can be a string or EntityIdentifier.
Returns void
Inherited from EntityLevelStorage.setIdentifier
- Defined in packages/core/src/entity/storage/entity.ts:88

setPosition

setPosition(position: Vector3f): void
Set the position of the player.
Parameters
- position: Vector3f
  The new position to set for the player.
Returns void
Overrides EntityLevelStorage.setPosition
- Defined in packages/core/src/entity/storage/player.ts:45

setRotation

setRotation(rotation: Rotation): void
Set the rotation of the entity in the level storage.
Parameters
- rotation: Rotation
  The rotation to set as a Rotation instance.
Returns void
Inherited from EntityLevelStorage.setRotation
- Defined in packages/core/src/entity/storage/entity.ts:250

setTraits

setTraits(traits: string[]): void
Set traits for the entity in the level storage.
Parameters
- traits: string[]
  An array of trait identifiers to set.
Returns void
Inherited from EntityLevelStorage.setTraits
- Defined in packages/core/src/entity/storage/entity.ts:408

setUniqueId

setUniqueId(uniqueId: bigint): void
Set the unique ID of the entity in the level storage.
Parameters
- uniqueId: bigint
  The unique ID to set as a bigint.
Returns void
Inherited from EntityLevelStorage.setUniqueId
- Defined in packages/core/src/entity/storage/entity.ts:114

toJSON

toJSON(): Record<string, unknown>
Convert the tag to a JSON object.

Returns Record<string, unknown>
Inherited from EntityLevelStorage.toJSON
- Defined in packages/nbt/dist/index.d.ts:186

values

values(): MapIterator<BaseTag>
Returns an iterable of values in the map

Returns MapIterator<BaseTag>
Inherited from EntityLevelStorage.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from EntityLevelStorage.groupBy
- Defined in node_modules/typescript/lib/lib.es2024.collection.d.ts:25

`Static`read

read(stream: BinaryStream, options?: ReadWriteOptions): CompoundTag
Read the nbt tag from the stream.
Parameters
- stream: BinaryStream
  The binary stream to read from.
- Optionaloptions: ReadWriteOptions
  The options for reading the tag.
Returns CompoundTag
Inherited from EntityLevelStorage.read
- Defined in packages/nbt/dist/index.d.ts:212

`Static`write

write(
    stream: BinaryStream,
    value: CompoundTag,
    options?: ReadWriteOptions,
): void
Write the nbt tag to the stream.
Parameters
- stream: BinaryStream
  The binary stream to write to.
- value: CompoundTag
  The value of the tag to write.
- Optionaloptions: ReadWriteOptions
  The options for writing the tag.
Returns void
Inherited from EntityLevelStorage.write
- Defined in packages/nbt/dist/index.d.ts:213

Class PlayerLevelStorage

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns PlayerLevelStorage

Properties

Readonly[toStringTag]

Protected ReadonlydynamicProperties

name

Readonlysize

Returns

Readonlytype

Static Readonly[species]

Protected Static ReadonlyDYNAMIC_PROPERTIES_KEY

Methods

[iterator]

Returns MapIterator<[string, BaseTag]>

add

Type Parameters

Parameters

Returns T

addTrait

Parameters

Returns void

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[string, BaseTag]>

forEach

Parameters

Returns void

get

Type Parameters

Parameters

Returns undefined | T

getAbilities

Returns [AbilityIndex, boolean][]

getAllDynamicProperties

Returns [string, JSONLikeValue][]

getDynamicProperty

Type Parameters

Parameters

Returns null | T

getIdentifier

Returns string

Throws

getPosition

Returns Vector3f

Throws

getRotation

Returns Rotation

Throws

getTraits

Returns string[]

getUniqueId

Returns bigint

Throws

has

Parameters

Returns boolean

hasDynamicProperty

Parameters

Returns boolean

hasTrait

Parameters

Returns boolean

isPlayer

Returns this is PlayerLevelStorage

keys

Returns MapIterator<string>

push

Type Parameters

`Readonly`[toStringTag]

`Protected` `Readonly`dynamicProperties

`Readonly`size

`Readonly`type

`Static` `Readonly`[species]

`Protected` `Static` `Readonly`DYNAMIC_PROPERTIES_KEY

`Static`groupBy

`Static`read

`Static`write