JSPrismarine

API reference / @jsprismarine/nbt / NBTTagCompound

Class: NBTTagCompound ​

Defined in: NBTTagCompound.ts:27

Constructors ​

Constructor ​

new NBTTagCompound(name?): NBTTagCompound

Defined in: NBTTagCompound.ts:41

Parameters ​

name? ​

string | null = null

Returns ​

NBTTagCompound

Properties ​

children ​

readonly children: Map<string, any>

Defined in: NBTTagCompound.ts:29

Methods ​

addChild() ​

addChild(tag): void

Defined in: NBTTagCompound.ts:61

Parameters ​

tag ​

NBTTagCompound

Returns ​

void

addValue() ​

addValue(name, value): void

Defined in: NBTTagCompound.ts:53

Parameters ​

name ​

string

value ​

any

Returns ​

void

entries() ​

entries(): IterableIterator<[string, any]>

Defined in: NBTTagCompound.ts:142

Returns ​

IterableIterator<[string, any]>

equals() ​

equals(that): boolean

Defined in: NBTTagCompound.ts:155

Parameters ​

that ​

NBTTagCompound

Returns ​

boolean

getByte() ​

getByte(name, defaultValue): number

Defined in: NBTTagCompound.ts:99

Parameters ​

name ​

string

defaultValue ​

number

Returns ​

number

getCompound() ​

getCompound(name, insert): NBTTagCompound | null

Defined in: NBTTagCompound.ts:79

Parameters ​

name ​

string

insert ​

boolean

Returns ​

NBTTagCompound | null

getDouble() ​

getDouble(name, defaultValue): number

Defined in: NBTTagCompound.ts:120

Parameters ​

name ​

string

defaultValue ​

number

Returns ​

number

getFloat() ​

getFloat(name, defaultValue): number

Defined in: NBTTagCompound.ts:116

Parameters ​

name ​

string

defaultValue ​

number

Returns ​

number

getList() ​

getList(name, insert): Set<any> | null

Defined in: NBTTagCompound.ts:65

Parameters ​

name ​

string

insert ​

boolean

Returns ​

Set<any> | null

getLong() ​

getLong(name, defaultValue): bigint

Defined in: NBTTagCompound.ts:111

Parameters ​

name ​

string

defaultValue ​

bigint

Returns ​

bigint

getName() ​

getName(): string | null

Defined in: NBTTagCompound.ts:49

Returns ​

string | null

getNumber() ​

getNumber(name, defaultValue): number

Defined in: NBTTagCompound.ts:107

Parameters ​

name ​

string

defaultValue ​

number

Returns ​

number

getShort() ​

getShort(name, defaultValue): number

Defined in: NBTTagCompound.ts:103

Parameters ​

name ​

string

defaultValue ​

number

Returns ​

number

getString() ​

getString(name, defaultValue): string

Defined in: NBTTagCompound.ts:124

Parameters ​

name ​

string

defaultValue ​

string

Returns ​

string

has() ​

has(key): boolean

Defined in: NBTTagCompound.ts:146

Parameters ​

key ​

string

Returns ​

boolean

remove() ​

remove(key): boolean

Defined in: NBTTagCompound.ts:138

Parameters ​

key ​

string

Returns ​

boolean

setName() ​

setName(name): void

Defined in: NBTTagCompound.ts:45

Parameters ​

name ​

string

Returns ​

void

size() ​

size(): number

Defined in: NBTTagCompound.ts:150

Returns ​

number

writeToStream() ​

writeToStream(out, byteOrder, varints?): void

Defined in: NBTTagCompound.ts:93

Parameters ​

out ​

BinaryStream

byteOrder ​

ByteOrder

varints? ​

boolean = false

Returns ​

void

readFromFile() ​

static readFromFile(path, byteOrder): NBTTagCompound

Defined in: NBTTagCompound.ts:31

Parameters ​

path ​

string

byteOrder ​

ByteOrder

Returns ​

NBTTagCompound

readFromStream() ​

static readFromStream(input, byteOrder, varints?): NBTTagCompound

Defined in: NBTTagCompound.ts:35

Parameters ​

input ​

BinaryStream

byteOrder ​

ByteOrder

varints? ​

boolean = false

Returns ​

NBTTagCompound