level-loader overview

---

Table of contents

• utils
• Gg2dLevelLoader (class)
  • registerDefaultClasses (method)
  • buildShapeDescriptor (method)
  • createPrimitive (method)
  • createTrigger (method)
• Primitive2DShapeName (type alias)
• PrimitiveSettings (interface)
• TriggerSettings (interface)

---

utils

Gg2dLevelLoader (class)

2D level loader: registers the built-in primitive/trigger entity classes and dispatches LevelJson entities to them (or to custom classes registered via registerClass).

Signature

export declare class Gg2dLevelLoader<TypeDoc> {
  constructor(protected readonly world: Gg2dWorld<TypeDoc>)
}

registerDefaultClasses (method)

Register the built-in classes for primitives and triggers

Signature

private registerDefaultClasses(): void

buildShapeDescriptor (method)

Turn a PrimitiveSettings (shape plus shape-specific fields) into the Shape2DDescriptor consumed by Gg2dWorld.addPrimitiveRigidBody.

Signature

private buildShapeDescriptor(settings: PrimitiveSettings): Shape2DDescriptor

createPrimitive (method)

Create a primitive entity (both display object and physics body) from a shape descriptor

Signature

private createPrimitive(
    world: Gg2dWorld<TypeDoc>,
    shape: Shape2DDescriptor,
    settings: PrimitiveSettings,
  ): Entity2d<TypeDoc>

createTrigger (method)

Create a trigger entity: a Trigger2dEntity wrapping the raw physics trigger component, so the app can subscribe to onEntityEntered/onEntityLeft without any extra wiring - see the base LevelLoader docs for how it's parented for level-lifecycle cleanup.

Signature

private createTrigger(
    world: Gg2dWorld<TypeDoc>,
    settings: TriggerSettings,
  ): Trigger2dEntity<TypeDoc['pTypeDoc']> | undefined

Primitive2DShapeName (type alias)

Shape names accepted by the built-in "Primitive" entity class in a 2D level JSON, via the sibling shape field on the entity (e.g. { class: "Primitive", shape: "SQUARE" }) - the same Shape2DDescriptor['shape'] values used at the engine API level, so no translation is needed between a level JSON and Gg2dWorld.addPrimitiveRigidBody.

Signature

export type Primitive2DShapeName = Shape2DDescriptor['shape']

PrimitiveSettings (interface)

Settings shared by every primitive entity (Square, Circle, ...)

Signature

export interface PrimitiveSettings {
  /**
   * Which primitive shape to construct
   */
  shape: Primitive2DShapeName

  /**
   * Position of the primitive
   */
  position?: Point2

  /**
   * Rotation of the primitive in radians
   */
  rotation?: number

  /**
   * Dimensions of the primitive (for Square)
   */
  dimensions?: Point2

  /**
   * Radius of the primitive (for Circle)
   */
  radius?: number

  /**
   * Material options for the primitive
   */
  material?: DisplayObject2dOpts<any>

  /**
   * Physics body options, merged over sensible defaults
   */
  body?: Partial<Body2DOptions>
}

TriggerSettings (interface)

Settings for a trigger entity

Signature

export interface TriggerSettings {
  /**
   * Position of the trigger
   */
  position?: Point2

  /**
   * Rotation of the trigger in radians
   */
  rotation?: number

  /**
   * Dimensions of the trigger
   */
  dimensions: Point2
}