Interface SceneOptions

For configuring the properties of a Scene

SceneOptions

Example

 const options: SceneOptions = {
     fpsMonitoringEnabled: true,
     lighting: true,
     lightOptions: {
         fog: 1.3,
         ambient: 0.2
     },
     GPUsettings: {
          mode: "webgl"
     },
     physics: true,
     physicsOptions: {
          gravity: {
             x: 0,
             y: 1,
             scale: 0.001
         }
     },
     update: () => {
         // do something
     },
     clear: false,
     bounds: [500, 500],
     FPS_BUFFER_SIZE: 60,
     bindCameraTo: gameObject
 }
interface SceneOptions {
    FPS_BUFFER_SIZE?: number;
    GPUsettings?: GPUsettings;
    backgroundColor?: string;
    bindCameraTo?: GameObject;
    bounds?: Vec2;
    clear?: boolean;
    fpsMonitoringEnabled?: boolean;
    layers?: Layer[];
    lightOptions?: lightingOptions;
    lighting?: boolean;
    physics?: boolean;
    physicsOptions?: WorldPhysicsOptions;
    update?: Function;
}

Properties

FPS_BUFFER_SIZE? GPUsettings? backgroundColor? bindCameraTo? bounds? clear? fpsMonitoringEnabled? layers? lightOptions? lighting? physics? physicsOptions? update?

Properties

Optional FPS_BUFFER_SIZE

FPS_BUFFER_SIZE?: number

Size of the buffer used to calculate FPS, default is 60

Optional GPUsettings

GPUsettings?: GPUsettings

Settings for GPU.js, default {} (empty object)

Optional backgroundColor

backgroundColor?: string

Background color of the scene

Optional bindCameraTo

bindCameraTo?: GameObject

Bind the camera to a GameObject, by default camera is static

Optional bounds

bounds?: Vec2

Set the bounds of the scene, by default bounds are not enabled

Optional clear

clear?: boolean

Set to false to disable clearing the canvas on every tick, default is true

Optional fpsMonitoringEnabled

fpsMonitoringEnabled?: boolean

Set to true to enable an FPS counter in top-left, default is false

Optional layers

layers?: Layer[]

Layers in the scene. Will be rendered in the order they are in the array

Optional lightOptions

lightOptions?: lightingOptions

Options for lighting, default {} (empty object)

Optional lighting

lighting?: boolean

True to enable lighting, default is false

Optional physics

physics?: boolean

Set to true to enable physics (Uses matter.js under the hood), default is false. If true and no layers are specified, a default layer will be created with physics enabled. Othewise, physics is handled by each individual layer.

Optional physicsOptions

physicsOptions?: WorldPhysicsOptions

Options passed to matter.js engine

Optional update

update?: Function

Function to run on every tick, default is an empty function

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc