Class Cube

Cube represents the main cubic structure in Nocturna, serving as the central environment for gameplay.

Responsibilities:

Creates and manages the six faces of the cube, each as a Face object.
Handles physics setup for each face, including collision detection (especially for the bottom/lava face).
Supports observer pattern for collision events (CubeCollisionObserver).
Provides serialization for saving/loading cube state.
Supports multiplayer setup by adding separators and portal effects for multi-mode.
Manages cleanup and disposal of all cube resources.

Index

Constructors

Properties

Methods

dispose getFaces getMesh getSize removePhysics serialize setCollisionObserver setupMulti create

Constructors

constructor

new Cube(scene: Scene, size: number): Cube
Constructs a new Cube.
Parameters
- scene: Scene
  The Babylon.js scene.
- size: number
  The size of the cube.
Returns Cube
- Defined in Cube.ts:32

Properties

`Static` `Readonly`Type

Type: string = "Cube"

Methods

dispose

dispose(): void
Disposes all resources associated with the cube, including faces, meshes, materials, and observers.

Returns void
- Defined in Cube.ts:144

getFaces

getFaces(): Face[]
Returns all faces of the cube.

Returns Face[]
- Defined in Cube.ts:272

getMesh

getMesh(): any
Returns the main mesh of the cube.

Returns any
- Defined in Cube.ts:265

getSize

getSize(): number
Returns the size of the cube.

Returns number
- Defined in Cube.ts:48

removePhysics

removePhysics(): void
Removes physics bodies from all cube faces.

Returns void
- Defined in Cube.ts:176

serialize

serialize(): any
Serializes the cube's position and size for saving or exporting.

Returns any
An object containing the cube's position and size.
- Defined in Cube.ts:280

setCollisionObserver

setCollisionObserver(observer: CubeCollisionObserver): void
Sets the collision observer for the cube.
Parameters
- observer: CubeCollisionObserver
  The observer to notify on bottom face collisions.
Returns void
- Defined in Cube.ts:41

setupMulti

setupMulti(): void
Sets up the cube for multiplayer mode by adding separator platforms and portal effects. Adds physics and materials to the separators.

Returns void
- Defined in Cube.ts:189

`Static`create

create(scene: Scene, position?: Vector3, size: number): Cube
Static factory to create and initialize a Cube in the scene.
Parameters
- scene: Scene
  The Babylon.js scene.
- position: Vector3 = ...
  The position of the cube.
- size: number
  The size of the cube.
Returns Cube
The created Cube instance.
- Defined in Cube.ts:59