Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/BunnyNabbit/celaria-formats/llms.txt

Use this file to discover all available pages before exploring further.

TutorialHologram is a display object used in tutorial levels to render instructional holograms in the game world. It carries a type identifier that determines which hologram is shown, along with the standard transform properties — position, scale, and rotation. TutorialHologram extends Instance and has an instanceId of 128.

​
Constructor

new TutorialHologram(type)
​
type
number
required
The hologram type identifier. This value determines which instructional hologram is displayed in-game. There is no default — type must always be provided.

​
Properties

​
position
[number, number, number]
World-space position of the hologram, inherited from Instance. Defaults to [0, 0, 0]. Z is the gravity axis.
​
scale
[number, number, number]
The display scale of the hologram along each axis. Defaults to [0, 0, 0].
​
rotation
number
Rotation of the hologram around the Z axis, in radians. Defaults to 0.
​
type
number
The hologram type identifier passed to the constructor. This value selects which instructional content is rendered by the game engine.

​
Getters

​
instanceId
128
Always returns 128. Used during binary serialization to identify this object as a TutorialHologram.

​
Example

​
Placing a tutorial hologram in a map

import { TutorialHologram, EditableCelariaMap } from "celaria-formats"

const map = new EditableCelariaMap()
map.name = "Tutorial Level"

const hologram = new TutorialHologram(1)
hologram.position = [0, 5, 2]
hologram.scale = [1, 1, 1]
hologram.rotation = 0

map.instances.push(hologram)

​
Reading holograms from a parsed map

import { CelariaMap, TutorialHologram } from "celaria-formats"
import fs from "node:fs"

const buffer = fs.readFileSync("./myMap.cmap")
const map = CelariaMap.parse(buffer)

const holograms = map.instances.filter(instance => instance instanceof TutorialHologram)

for (const holo of holograms) {
  console.log(`Hologram type ${holo.type} at`, holo.position)
}

Instance

Abstract base class that TutorialHologram extends.

Map objects guide

Overview of all map object types and how to use them.

Block

Rectangular geometry block used to build level structure.

Types reference

Vector3 and other type definitions.

Build docs developers (and LLMs) love

Get started for freeTalk to us