Skip to content

@temporary-escape/mod-sdk / SystemPlanetData

Class: SystemPlanetData ​

Defined in: schemas.ts:99

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

Returns ​

SystemPlanetData

Inherited from ​

Serializable.constructor

Properties ​

PropertyModifierTypeDefault valueDefined in
namepublicstring""schemas.ts:103
parentpublicOptionalU64undefinedschemas.ts:107
pospublicVector3fundefinedschemas.ts:104
radiuspublicnumber0schemas.ts:106
ringOrientationpublicQuaternionundefinedschemas.ts:111
ringScalepublicnumber0schemas.ts:110
ringTexturepublicAssetTexture | nullnullschemas.ts:109
seedpublicnumber0schemas.ts:108
systemIdpublicnumber0schemas.ts:102
typepublicAssetPlanet | nullnullschemas.ts:105
kSchemaNamereadonlystring"SystemPlanet"schemas.ts:100

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