Interface LifecycleProps

interface LifecycleProps {
    destroy$: Subject<void>;
    gameObject?: GameObject;
    label: string;
    scene?: SceneBase<Body> | Scene<Body>;
    update$: Subject<number>;
    destroy(): void;
    update(deltaTime): void;
}

Implemented by

Properties

destroy$ gameObject? label scene? update$

Methods

destroy update

Properties

Readonly destroy$

destroy$: Subject<void>

When Lifecycle Object is destroyed, it emits and closes this subject. Along with destroying his children, which in turn behave the same.

Optional Readonly gameObject

gameObject?: GameObject

Parent GameObject is assigned at creation. BaseScene & Scene don't have parent gameObject

label

label: string

Each Lifecycle Object has label for pixi debugging.

Optional scene

scene?: SceneBase<Body> | Scene<Body>

Lifecycle Object may be added to a Scene Object.

Readonly update$

update$: Subject<number>

When Lifecycle Object is updated, it emits this subject. Along with updating his children, which in turn behave the same.

Methods

destroy

  • destroy(): void

  • Called to destroy can cleanup Lifecycle Object.

    Returns void

update

  • update(deltaTime): void

  • Updates the Lifecycle Object with actual deltaTime ~60fps

    Parameters

    • deltaTime: number

    Returns void

Settings

Member Visibility

Theme

On This Page

destroy$ gameObject label scene update$ destroy update