@temporary-escape/mod-sdk / PlayerData

Class: PlayerData

Defined in: schemas.ts:23

Base class for CBOR-serializable documents. The pack/unpack members are usually generated from the field declarations by the SDK AssemblyScript transform (see sdk/transform.js), which is why this is a class with concrete defaults rather than an interface: the IDE sees the inherited members and does not flag a class Foo extends Serializable as missing them.

The defaults abort, so a document whose members were never generated fails loudly at runtime instead of silently serializing nothing.

Extends

• Serializable

Constructors

Constructor

new PlayerData(): PlayerData;

Returns

PlayerData

Inherited from

Serializable.constructor

Properties

Property	Modifier	Type	Default value	Defined in
activeShipId	public	number	0	schemas.ts:29
admin	public	bool	false	schemas.ts:28
fingerprint	public	Uint8Array	undefined	schemas.ts:27
name	public	string	""	schemas.ts:26
kSchemaName	readonly	string	"Player"	schemas.ts:24

Methods

pack()

pack(_enc: CborEncoder): void;

Defined in: cbor.ts:1452

Parameters

Parameter	Type
_enc	CborEncoder

Returns

void

Inherited from

Serializable.pack

---

unpack()

unpack(_dec: CborVisitor): void;

Defined in: cbor.ts:1456

Parameters

Parameter	Type
_dec	CborVisitor

Returns

void

Inherited from

Serializable.unpack