Class WorldEntity

WorldEntity represents a scrollable world with a viewport. It extends Canvas2DEntity and provides methods for adding blocks, managing collisions, and scrolling the viewport.

Export

WorldEntity

Hierarchy (view full)

Constructors

constructor

Properties

action? barListeners? beatListeners? canvas ctx durationInMs? h? name props scene? startTimeinMs? tickListeners? transitionIn? transitionOut? w?

Methods

addBlock addBlocks addCollisionDetector addPostProcessor bindToScene checkCollisions copyToCanvas findBlock getScene onBar onBeat onTick setViewportX update

Constructors

constructor

Properties

Optionalaction

action?: ((time: number, ctx: CanvasRenderingContext2D, properties: IWorldProps, sequence?: Sequence, entity?: Canvas2DEntity<IWorldProps>) => void)

The action function that defines the entity's behavior.

OptionalbarListeners

barListeners?: ((time: number, count: number, propertyBag?: IWorldProps) => void)[] = []

OptionalbeatListeners

beatListeners?: ((time: number, count: number, propertyBag?: IWorldProps) => void)[] = []

canvas

canvas: HTMLCanvasElement

ctx

ctx: CanvasRenderingContext2D

OptionaldurationInMs

durationInMs?: number

Optionalh

h?: number

The height of the entity's canvas.

name

name: string

The name of the entity.

props

props: IWorldProps

The properties of the world entity.

Optionalscene

scene?: Scene

OptionalstartTimeinMs

startTimeinMs?: number

OptionaltickListeners

tickListeners?: ((time: number, count: number, propertyBag?: IWorldProps) => void)[] = []

OptionaltransitionIn

transitionIn?: ((ctx: CanvasRenderingContext2D, progress: number) => void)

OptionaltransitionOut

transitionOut?: ((ctx: CanvasRenderingContext2D, progress: number) => void)

Optionalw

w?: number

The width of the entity's canvas.

Methods

addBlock

  • addBlock(block, startTime?, duration?): this

  • Adds a block to the world.

    Parameters

    • block: ICompositeEntity<any>

      The block to add.

    • OptionalstartTime: number

      The optional start time of the block within the scene (in milliseconds).

    • Optionalduration: number

      The optional duration of the block within the scene (in milliseconds).

    Returns this

    The WorldEntity instance for chaining.

addBlocks

  • addBlocks(...blocks): this

  • Adds multiple blocks to the world.

    Parameters

    Returns this

    The WorldEntity instance for chaining.

addCollisionDetector

  • addCollisionDetector<A, B>(targetKey, sourceKey, detectorFn, onCollision): void

  • Adds a collision detector to the entity.

    Type Parameters

    • A
    • B

    Parameters

    • targetKey: string

      The key of the target block.

    • sourceKey: string

      The key of the source block.

    • detectorFn: ((a: A, b: B) => boolean)

      The collision detection function.

        • (a, b): boolean

        • Parameters

          Returns boolean

    • onCollision: ((target: A, source: B) => void)

      The callback function to be executed when a collision is detected.

        • (target, source): void

        • Parameters

          • target: A
          • source: B

          Returns void

    Returns void

addPostProcessor

  • addPostProcessor(processor): void

  • Adds a post-processing function to the entity.

    Parameters

    • processor: ((ctx: CanvasRenderingContext2D, sequence: Sequence) => void)

      The post-processing function to add.

        • (ctx, sequence): void

        • Parameters

          • ctx: CanvasRenderingContext2D
          • sequence: Sequence

          Returns void

    Returns void

bindToScene

checkCollisions

  • checkCollisions(): void

  • Checks for collisions between the registered collision detectors.

    Returns void

copyToCanvas

  • copyToCanvas(targetCanvas, sequence): void

  • Copies the entity's canvas to the target canvas and applies post-processors.

    Parameters

    • targetCanvas: HTMLCanvasElement

      The target canvas to copy to.

    • sequence: Sequence

      The Sequence instance.

    Returns void

findBlock

getScene

onBar

  • onBar<T>(listener): this

  • Adds an event listener for when a bar is complete.

    Type Parameters

    • T

    Parameters

    • listener: ((ts: number, count: number, propertyBag?: T) => void)

      The function to call when a bar is complete.

        • (ts, count, propertyBag?): void

        • Parameters

          • ts: number
          • count: number
          • OptionalpropertyBag: T

          Returns void

    Returns this

    The Entity instance for chaining.

onBeat

  • onBeat<T>(listener): this

  • Adds an event listener for when a beat occurs.

    Type Parameters

    • T

    Parameters

    • listener: ((time: number, count: number, propertyBag?: T) => void)

      The function to call when a beat occurs.

        • (time, count, propertyBag?): void

        • Parameters

          • time: number
          • count: number
          • OptionalpropertyBag: T

          Returns void

    Returns this

    The Entity instance for chaining.

onTick

  • onTick<T>(listener): this

  • Adds an event listener for when a tick occurs.

    Type Parameters

    • T

    Parameters

    • listener: ((time: number, count: number, propertyBag?: T) => void)

      The function to call when a tick occurs.

        • (time, count, propertyBag?): void

        • Parameters

          • time: number
          • count: number
          • OptionalpropertyBag: T

          Returns void

    Returns this

    The Entity instance for chaining.

setViewportX

  • setViewportX(x): void

  • Scrolls the viewport horizontally.

    Parameters

    • x: number

      The new x-coordinate of the viewport.

    Returns void

update

  • update(timeStamp): void

  • Updates the entity's state, clears the canvas, and calls the action function.

    Parameters

    • timeStamp: number

      The current timestamp in the animation.

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods