Skip to content

@temporary-escape/mod-sdk / ShipLocationData

Class: ShipLocationData ​

Defined in: schemas.ts:191

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 ​

Constructors ​

Constructor ​

ts
new ShipLocationData(): ShipLocationData;

Returns ​

ShipLocationData

Inherited from ​

Serializable.constructor

Properties ​

PropertyModifierTypeDefault valueDefined in
fromGalaxyIdpublicnumber0schemas.ts:200
fromSectorIdpublicnumber0schemas.ts:198
fromSystemIdpublicnumber0schemas.ts:199
galaxyIdpublicnumber0schemas.ts:196
sectorIdpublicnumber0schemas.ts:195
shipIdpublicnumber0schemas.ts:194
systemIdpublicnumber0schemas.ts:197
warpDurationpublicnumber0schemas.ts:202
warpStartpublicnumber0schemas.ts:201
kSchemaNamereadonlystring"ShipLocation"schemas.ts:192

Methods ​

pack() ​

ts
pack(_enc: CborEncoder): void;

Defined in: cbor.ts:1452

Parameters ​

ParameterType
_encCborEncoder

Returns ​

void

Inherited from ​

Serializable.pack


unpack() ​

ts
unpack(_dec: CborVisitor): void;

Defined in: cbor.ts:1456

Parameters ​

ParameterType
_decCborVisitor

Returns ​

void

Inherited from ​

Serializable.unpack