Interface IEngineConfig

Engine Config

interface IEngineConfig {
    audio: boolean;
    autoClear: null | number;
    bgColor: string | number;
    bgOpacity: number;
    camera: ICamera;
    dice: Partial<IDiceConfig>;
    drawDebug?: {
        infoPane: boolean;
        clearColor: boolean;
        collisionMeshes: boolean;
    };
    light: ILight;
    physics: IPhysics;
    persistRolls?: boolean;
}

Properties

audio autoClear bgColor bgOpacity camera dice drawDebug? light physics persistRolls?

Properties

audio

audio: boolean

Audio enabled (default: true)

autoClear

autoClear: null | number

Seconds to wait before auto clearing roll. Null means do not auto clear

bgColor

bgColor: string | number

Canvas Background Color

bgOpacity

bgOpacity: number

Canvas Background Opacity

camera

camera: ICamera

Camera Configuration

dice

dice: Partial<IDiceConfig>

Dice Configuration

Optional drawDebug

drawDebug?: {
    infoPane: boolean;
    clearColor: boolean;
    collisionMeshes: boolean;
}

Debug

Type declaration

  • infoPane: boolean
  • clearColor: boolean
  • collisionMeshes: boolean

light

light: ILight

Light Configuration

physics

physics: IPhysics

Physics Configuration

Optional persistRolls

persistRolls?: boolean

Persist Rolls

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc