@temporary-escape/mod-sdk / FactionHomeData

Class: FactionHomeData

Defined in: schemas.ts:161

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 FactionHomeData(): FactionHomeData;

Returns

FactionHomeData

Inherited from

Serializable.constructor

Properties

Property	Modifier	Type	Default value	Defined in
faction	public	AssetFaction | null	null	schemas.ts:165
systemId	public	number	0	schemas.ts:164
kSchemaName	readonly	string	"FactionHome"	schemas.ts:162

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