Class CelariaMap

I represent a Celaria map. Unlike EditableCelariaMap, my checkpoint and goal blocks include medal times.

Hierarchy

BaseCelariaMap
- CelariaMap

Index

Constructors

Properties

checkpointOrder instances mode previewCamera sunRotationHorizontal sunRotationVertical version fileSignature gameModes

Accessors

Methods

serialize instanceTypeIsSupported parse

Constructors

constructor

new CelariaMap(): CelariaMap
Returns CelariaMap
Overrides BaseCelariaMap.constructor
- Defined in CelariaMap.mjs:14

Properties

checkpointOrder

checkpointOrder: OrderedSet<Block>

The order of checkpoint blocks in the map.

instances

instances: (Block | Sphere | PlayerSpawnPoint | Barrier | TutorialHologram)[]

The object instances in the map.

mode

mode: number

previewCamera

previewCamera: { from: Vector3; to: Vector3 }

sunRotationHorizontal

sunRotationHorizontal: number

sunRotationVertical

sunRotationVertical: number

version

version: number

`Static`fileSignature

fileSignature: string = "celaria_map"

`Static`gameModes

gameModes: { freeRoam: number; timeTrial: number } = ...

Accessors

name

get name(): string
Returns string
Inherited from BaseCelariaMap.name
- Defined in BaseCelariaMap.mjs:46
set name(newName: string): void
Parameters
- newName: string
Returns void
Inherited from BaseCelariaMap.name
- Defined in BaseCelariaMap.mjs:41

Methods

serialize

serialize(version?: number): Buffer<ArrayBufferLike>
Serializes the map into a buffer.

Checkpoints and goal blocks are modified in place if they aren't specified in my checkpointOrder. And the blocks that are will also be modified.
Parameters
- Optionalversion: number = 2
  Default is 2
Returns Buffer<ArrayBufferLike>
- Defined in CelariaMap.mjs:192

`Static`instanceTypeIsSupported

instanceTypeIsSupported(instanceType: any, version: number): boolean
Parameters
- instanceType: any
- version: number
Returns boolean
Todo
Yet to be documented.
- Defined in CelariaMap.mjs:351

`Static`parse

parse(buffer: Buffer<ArrayBufferLike>): CelariaMap
Parses a buffer into a CelariaMap.
Parameters
- buffer: Buffer<ArrayBufferLike>
  The buffer to parse.
Returns CelariaMap
Throws
If a checkpoint or goal Block is missing its Block.medalTimes

Throws
If a Barrier can't figure out if it's a wall or a floor.
- Defined in CelariaMap.mjs:29