Scene | DuckEngine

classdesc: Creates a DuckEngine Scene
description: The Scene Class. Main rendering happens here
since: 1.0.0-beta

Hierarchy

Render
- Scene

Index

Constructors

constructor

new Scene(key: string, game: Game, visible?: boolean): Scene

Overrides Render.constructor
- Defined in core/scene.ts:408
description
Creates a Scene instance

since
1.0.0-beta

Parameters
- key: string
  
  Key/Identifier or name of scene
- game: Game
  
  Game instance
- Optional visible: boolean
Returns Scene

Properties

add

add: { gameobject: { misc: { canvasModulate: any }; circle: any; existing: any; rect: any; roundRect: any; sprite: any }; light: { staticLight: any }; map: { tileLayer: any; tilemap: any; tileset: any }; misc: { area: any }; presetEffect: { explosionEffect: any; smokeEffect: any }; ui: { button: any; text: any }; camera: any; cutscene: any; effect: any; group: any; input: any; mainCamera: any; particle: any; particleEmitter: any; soundPlayer: any }

memberof: Scene
description: Used to add GameObjects and more to the scene
since: 1.0.0-beta

Type declaration

gameobject: { misc: { canvasModulate: any }; circle: any; existing: any; rect: any; roundRect: any; sprite: any }
- misc: { canvasModulate: any }
  - canvasModulate:function
    - canvasModulate(x: number, y: number, w: number, h: number, fillColor: string): CanvasModulate
    - Defined in core/scene.ts:179
      Parameters
      - x: number
      - y: number
      - w: number
      - h: number
      - fillColor: string
      Returns CanvasModulate
- circle:function
  - circle(x: number, y: number, r: number, fillColor: string): Circle
  - - Defined in core/scene.ts:206
    Parameters
    - x: number
    - y: number
    - r: number
    - fillColor: string
    Returns Circle
- existing:function
  - existing<t>(gameobject: GameObject<t>): GameObject<t>
  - - Defined in core/scene.ts:187
    Type parameters
    - t: Duck.Types.Texture.Type
    Parameters
    - gameobject: GameObject<t>
    Returns GameObject<t>
- rect:function
  - rect(x: number, y: number, w: number, h: number, fillColor: string): Rect
  - - Defined in core/scene.ts:199
    Parameters
    - x: number
    - y: number
    - w: number
    - h: number
    - fillColor: string
    Returns Rect
- roundRect:function
  - roundRect(x: number, y: number, w: number, h: number, r: number, fillColor: string): RoundRect
  - - Defined in core/scene.ts:212
    Parameters
    - x: number
    - y: number
    - w: number
    - h: number
    - r: number
    - fillColor: string
    Returns RoundRect
- sprite:function
  - sprite(x: number, y: number, w: number, h: number, textureKey: string, currentRow?: number, currentCol?: number): Sprite
  - - Defined in core/scene.ts:190
    Parameters
    - x: number
    - y: number
    - w: number
    - h: number
    - textureKey: string
    - Optional currentRow: number
    - Optional currentCol: number
    Returns Sprite
light: { staticLight: any }
- staticLight:function
  - staticLight(x: number, y: number, r: number, fillColor: string, alpha: AlphaRange): StaticLight
  - - Defined in core/scene.ts:251
    Parameters
    - x: number
    - y: number
    - r: number
    - fillColor: string
    - alpha: AlphaRange
    Returns StaticLight
map: { tileLayer: any; tilemap: any; tileset: any }
- tileLayer:function
  - tileLayer(tileset: Tileset, map: number[][], zIndex?: number, visible?: boolean): TileLayer
  - - Defined in core/scene.ts:290
    Parameters
    - tileset: Tileset
    - map: number[][]
    - Optional zIndex: number
    - Optional visible: boolean
    Returns TileLayer
- tilemap:function
  - tilemap(origin: Vector2Like, tilelayers: TileLayer[]): TileMap
  - - Defined in core/scene.ts:279
    Parameters
    - origin: Vector2Like
    - tilelayers: TileLayer[]
    Returns TileMap
- tileset:function
  - tileset(textureKey: string, tileW: number, tileH: number, rows: number, cols: number): Tileset
  - - Defined in core/scene.ts:283
    Parameters
    - textureKey: string
    - tileW: number
    - tileH: number
    - rows: number
    - cols: number
    Returns Tileset
misc: { area: any }
- area:function
  - area(x: number, y: number, w: number, h: number, collisionFilter: PhysicsBody<Duck.Types.Texture.Type>[]): Area
  - - Defined in core/scene.ts:222
    Parameters
    - x: number
    - y: number
    - w: number
    - h: number
    - collisionFilter: PhysicsBody<Duck.Types.Texture.Type>[]
    Returns Area
presetEffect: { explosionEffect: any; smokeEffect: any }
- explosionEffect:function
  - explosionEffect(rangeX: Range, rangeY: Range, particleAmount: undefined | number, speedRange: undefined | [1, 1], maxAge: undefined | number, color: undefined | string): ExplosionEffect
  - - Defined in core/scene.ts:303
    Parameters
    - rangeX: Range
    - rangeY: Range
    - particleAmount: undefined | number
    - speedRange: undefined | [1, 1]
    - maxAge: undefined | number
    - color: undefined | string
    Returns ExplosionEffect
- smokeEffect:function
  - smokeEffect(rangeX: Range, rangeY: Range, particleAmount: undefined | number, speedRangeX: undefined | [-0.1, 0.4], speedRangeY: undefined | [-0.1, 0.4], maxAge: undefined | number, color: undefined | "#2e2e2e", interval: undefined | 50): SmokeEffect
  - - Defined in core/scene.ts:311
    Parameters
    - rangeX: Range
    - rangeY: Range
    - particleAmount: undefined | number
    - speedRangeX: undefined | [-0.1, 0.4]
    - speedRangeY: undefined | [-0.1, 0.4]
    - maxAge: undefined | number
    - color: undefined | "#2e2e2e"
    - interval: undefined | 50
    Returns SmokeEffect
ui: { button: any; text: any }
- button:function
  - button(shape: Shape, x: number, y: number, w: number, h: number, r: number, fillColor: string, text: Text): Button
  - - Defined in core/scene.ts:232
    Parameters
    - shape: Shape
    - x: number
    - y: number
    - w: number
    - h: number
    - r: number
    - fillColor: string
    - text: Text
    Returns Button
- text:function
  - text(text: string, config: Duck.Types.UI.Text.Config): Text
  - - Defined in core/scene.ts:231
    Parameters
    - text: string
    - config: Duck.Types.UI.Text.Config
    Returns Text
camera:function
- camera(): Camera
- - Defined in core/scene.ts:248
  Returns Camera
cutscene:function
- cutscene(config: Duck.Types.Cutscene.Config, instructions: Instructions): Cutscene
- - Defined in core/scene.ts:274
  Parameters
  - config: Duck.Types.Cutscene.Config
  - instructions: Instructions
  Returns Cutscene
effect:function
- effect(rangeX: Range, rangeY: Range, particleEmitter: ParticleEmitter): Effect
- - Defined in core/scene.ts:297
  Parameters
  - rangeX: Range
  - rangeY: Range
  - particleEmitter: ParticleEmitter
  Returns Effect
group:function
- group<t>(name: string, defaultValues?: t[]): Group<t>
- - Defined in core/scene.ts:259
  Type parameters
  - t
  Parameters
  - name: string
  - Optional defaultValues: t[]
  Returns Group<t>
input:function
- input(): Input
- - Defined in core/scene.ts:247
  Returns Input
mainCamera:function
- mainCamera(): Camera
- - Defined in core/scene.ts:249
  Returns Camera
particle:function
- particle(shape: ShapeString, w: number, h: number, r: number, fillColor: string): Particle
- - Defined in core/scene.ts:260
  Parameters
  - shape: ShapeString
  - w: number
  - h: number
  - r: number
  - fillColor: string
  Returns Particle
particleEmitter:function
- particleEmitter(particle: Particle, rangeX: Range, rangeY: Range, amount: number, autoCreate?: boolean): ParticleEmitter
- - Defined in core/scene.ts:267
  Parameters
  - particle: Particle
  - rangeX: Range
  - rangeY: Range
  - amount: number
  - Optional autoCreate: boolean
  Returns ParticleEmitter
soundPlayer:function
- soundPlayer(path: string, options?: Duck.Types.Sound.Config): SoundPlayer
- - Defined in core/scene.ts:243
  Parameters
  - path: string
  - Optional options: Duck.Types.Sound.Config
  Returns SoundPlayer

cameras

cameras: Camera[]

memberof: Scene
description: An array of cameras that the scene holds
since: 1.0.0-beta

currentCamera

currentCamera: undefined | Camera

memberof: Scene
description: The current camera being updated
since: 1.0.0-beta

Readonly default

default: boolean

memberof: Scene
description: Determines if the Scene is visible by default
since: 1.0.0-beta

displayList

displayList: DisplayList

memberof: Scene
description: A DisplayList instance, holds and manages Renderables
since: 2.0.0

Protected game

game: Game

memberof: Scene
description: The game instance the scene is added to
since: 1.0.0-beta

Readonly key

key: string

memberof: Scene
description: The key of the Scene, used to identify the Scene
since: 1.0.0-beta

loader

loader: Loader

memberof: Scene
description: A Loader instance, used to load assets in Scene.preload method that you override
since: 2.0.0

mainCamera

mainCamera: undefined | Camera

memberof: Scene
description: The main camera of the scene
since: 1.0.0-beta

onSceneActive

onSceneActive: () => void

Type declaration

- (): void
- memberof
  Scene
  
  description
  A property that is a function that gets called when the scene is switched to being visible
  
  since
  2.1.0
  
  Returns void

onSceneInactive

onSceneInactive: () => void

Type declaration

- (): void
- memberof
  Scene
  
  description
  A property that is a function that gets called when the scene is switched to not being visible
  
  since
  2.1.0
  
  Returns void

physicsList

physicsList: PhysicsList

memberof: Scene
description: A PhysicsList instance, holds and manages PhysicsBodies
since: 2.0.0

physicsServer

physicsServer: undefined | PhysicsServer

memberof: Scene
description: A PhysicsServer instance, manages and updates all the physics for the Scene.PhysicsList. It is set to undefined if Game.config.physics.customTick is truthy
since: 2.0.0

tools

tools: { color: { convert: { hex: { toHsl: any; toRgb: any; toRgba: any }; rgb: { toHsl: any; toRgba: any }; rgba: { toHsla: any; toRgb: any } }; is: { hex: any; hsl: any; rgb: any }; random: any; randomWithAlpha: any }; loader: typeof Loader; math: { vector: typeof Vector2; clamp: any; createVector: any; lerp: any; randomFloat: any; randomInt: any }; physics: { circleToRectIntersect: any; rectToRectIntersect: any } }

memberof: Scene
description: Misc tools, contains color, physics, and math related tools
since: 1.0.0-beta

Type declaration

color: { convert: { hex: { toHsl: any; toRgb: any; toRgba: any }; rgb: { toHsl: any; toRgba: any }; rgba: { toHsla: any; toRgb: any } }; is: { hex: any; hsl: any; rgb: any }; random: any; randomWithAlpha: any }
- convert: { hex: { toHsl: any; toRgb: any; toRgba: any }; rgb: { toHsl: any; toRgba: any }; rgba: { toHsla: any; toRgb: any } }
  - hex: { toHsl: any; toRgb: any; toRgba: any }
    - toHsl:function
      - toHsl(hex: string): string
      - Defined in core/scene.ts:362
        Parameters
        hex: string
        Returns string
    - toRgb:function
      - toRgb(hex: string): null | string
      - Defined in core/scene.ts:361
        Parameters
        hex: string
        Returns null | string
    - toRgba:function
      - toRgba(hex: string, alpha: AlphaRange): string
      - Defined in core/scene.ts:357
        Parameters
        hex: string
        alpha: AlphaRange
        Returns string
  - rgb: { toHsl: any; toRgba: any }
    - toHsl:function
      - toHsl(r: number, g: number, b: number): string
      - Defined in core/scene.ts:341
        Parameters
        r: number
        g: number
        b: number
        Returns string
    - toRgba:function
      - toRgba(color: string, alpha: AlphaRange): string
      - Defined in core/scene.ts:342
        Parameters
        color: string
        alpha: AlphaRange
        Returns string
  - rgba: { toHsla: any; toRgb: any }
    - toHsla:function
      - toHsla(r: string | number, g: string | number, b: string | number, a: AlphaRange): string
      - Defined in core/scene.ts:348
        Parameters
        r: string | number
        g: string | number
        b: string | number
        a: AlphaRange
        Returns string
    - toRgb:function
      - toRgb(rgba: string): string
      - Defined in core/scene.ts:354
        Parameters
        rgba: string
        Returns string
- is: { hex: any; hsl: any; rgb: any }
  - hex:function
    - hex(str: string): boolean
    - Defined in core/scene.ts:335
      Parameters
      - str: string
      Returns boolean
  - hsl:function
    - hsl(str: string): boolean
    - Defined in core/scene.ts:336
      Parameters
      - str: string
      Returns boolean
  - rgb:function
    - rgb(str: string): boolean
    - Defined in core/scene.ts:337
      Parameters
      - str: string
      Returns boolean
- random:function
  - random(): string
  - - Defined in core/scene.ts:332
    Returns string
- randomWithAlpha:function
  - randomWithAlpha(alpha?: AlphaRange): string
  - - Defined in core/scene.ts:333
    Parameters
    - Optional alpha: AlphaRange
    Returns string
loader: typeof Loader
math: { vector: typeof Vector2; clamp: any; createVector: any; lerp: any; randomFloat: any; randomInt: any }
- vector: typeof Vector2
- clamp:function
  - clamp(x: number, min: number, max: number): number
  - - Defined in core/scene.ts:393
    Parameters
    - x: number
    - min: number
    - max: number
    Returns number
- createVector:function
  - createVector(x?: number, y?: number): Vector2
  - - Defined in core/scene.ts:391
    Parameters
    - Optional x: number
    - Optional y: number
    Returns Vector2
- lerp:function
  - lerp(start: number, end: number, amount: number): number
  - - Defined in core/scene.ts:394
    Parameters
    - start: number
    - end: number
    - amount: number
    Returns number
- randomFloat:function
  - randomFloat(min: number, max: number, fixed?: number): number
  - - Defined in core/scene.ts:396
    Parameters
    - min: number
    - max: number
    - Optional fixed: number
    Returns number
- randomInt:function
  - randomInt(min: number, max: number): number
  - - Defined in core/scene.ts:395
    Parameters
    - min: number
    - max: number
    Returns number
physics: { circleToRectIntersect: any; rectToRectIntersect: any }
- circleToRectIntersect:function
  - circleToRectIntersect(circle: Circle | { h: number; position: { x: number; y: number }; r: number; w: number }, rect: Sprite | Rect | { h: number; position: { x: number; y: number }; w: number }): boolean
  - - Defined in core/scene.ts:371
    Parameters
    - circle: Circle | { h: number; position: { x: number; y: number }; r: number; w: number }
    - rect: Sprite | Rect | { h: number; position: { x: number; y: number }; w: number }
    Returns boolean
- rectToRectIntersect:function
  - rectToRectIntersect(rect: Sprite | Rect, rect2: Sprite | Rect): boolean
  - - Defined in core/scene.ts:367
    Parameters
    - rect: Sprite | Rect
    - rect2: Sprite | Rect
    Returns boolean

visible

visible: boolean

memberof: Scene
description: The state of the Scene being visible, determines if the Scene.displayList, physicsList, update, and __tick, is being called/used in the game loop
since: 1.0.0-beta

Methods

__tick

__tick(): void

- Defined in core/scene.ts:890
memberof
Scene

description
Calls physics server __tick method if game.config.physics.enabled is true and game.config.physics.customTick is false Do not call manually, this is called in GAME LOOP

since
2.0.0

Returns void

createTimer

createTimer(ms: number, cb: (...args: unknown[]) => unknown, args: unknown[], repeat: number): default

- Defined in core/scene.ts:996
memberof
Scene

description
Creates and returns a Timer instance

since
2.1.0

Parameters
- ms: number
  
  Milliseconds, converted to seconds which is used to check if the target time is reached in Timer.count
- cb: (...args: unknown[]) => unknown
  
  Callback to call every time the timer reaches its target
  - - (...args: unknown[]): unknown
    - Parameters
      - Rest ...args: unknown[]
      Returns unknown
- args: unknown[]
  
  Arguments to pass to the callback
- repeat: number
  
  Amount of times to repeat, set to infinity to repeat forever
Returns default

once

once(func: (...args: unknown[]) => unknown, run?: boolean): default

- Defined in core/scene.ts:963
memberof
Scene

description
Runs a function once no matter if it is in a loop or not

since
1.0.0

Parameters
- func: (...args: unknown[]) => unknown
  
  Function to run
  - - (...args: unknown[]): unknown
    - Parameters
      - Rest ...args: unknown[]
      Returns unknown
- Optional run: boolean
Returns default

runAmount

runAmount(func: (currentCount: number) => void, maxAmount: number, run?: boolean): default

- Defined in core/scene.ts:977
memberof
Scene

description
Allows a function to only be ran a max amount of times

since
1.1.0

Parameters
- func: (currentCount: number) => void
  
  Function to call
  - - (currentCount: number): void
    - Parameters
      - currentCount: number
      Returns void
- maxAmount: number
  
  Max amount of times to allow the function to be called
- Optional run: boolean
Returns default

setMainCamera

setMainCamera(camera: Camera): void

- Defined in core/scene.ts:948
memberof
Scene

description
Sets a camera as the main camera

since
1.0.0-beta

Parameters
- camera: Camera
  
  Camera to set the main camera as
Returns void

setVisible

setVisible(visible: boolean): void

- Defined in core/scene.ts:905
memberof
Scene

description
Sets the visible property and calls the game.renderer.pipeline.pool method to immediately update the visibility

Note: this calls Game.renderer.pipeline.pool to immediately update the visibility

since
2.1.0

Parameters
- visible: boolean
  
  What to set the visible property to
Returns void

switchCamera

switchCamera(camera: Camera): void

- Defined in core/scene.ts:916
memberof
Scene

description
Switches the active camera to a passed camera

memberof
1.0.0-beta

Parameters
- camera: Camera
  
  Camera to switch to
Returns void

switchToMainCamera

switchToMainCamera(): void

- Defined in core/scene.ts:935
memberof
Scene

description
Switches the active camera to the main camera

since
1.0.0-beta

Returns void

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

key: string

game: Game

Optional visible: boolean

Returns Scene

Properties

add

Type declaration

gameobject: { misc: { canvasModulate: any }; circle: any; existing: any; rect: any; roundRect: any; sprite: any }

misc: { canvasModulate: any }

canvasModulate:function

Parameters

x: number

y: number

w: number

h: number

fillColor: string

Returns CanvasModulate

circle:function

Parameters

x: number

y: number

r: number

fillColor: string

Returns Circle

existing:function

Type parameters

t: Duck.Types.Texture.Type

Parameters

gameobject: GameObject<t>

Returns GameObject<t>

rect:function

Parameters

x: number

y: number

w: number

h: number

fillColor: string

Returns Rect

roundRect:function

Parameters

x: number

y: number

w: number

h: number

r: number

fillColor: string

Returns RoundRect

sprite:function

Parameters

x: number

y: number

w: number

h: number

textureKey: string

Optional currentRow: number

Optional currentCol: number

Returns Sprite

light: { staticLight: any }

staticLight:function

Parameters

x: number

y: number

r: number

fillColor: string

alpha: AlphaRange

Returns StaticLight

map: { tileLayer: any; tilemap: any; tileset: any }

tileLayer:function

Parameters

tileset: Tileset

map: number[][]

Optional zIndex: number