Class Scene<TBody>

Type Parameters

  • TBody extends Body = Body

Hierarchy (view full)

Constructors

constructor

Properties

animationFrame children children$ destroy$ disableAutoSort$ disableDebug$ label lastUpdate options physics pixi resources scene? stage update$ x y

Methods

addChild destroy disableAutoSort disableDebug enableAutoSort enableDebug getChildOfType getChildrenOfType init removeChild showFPS start stop update getQueryParams instantiate

Constructors

constructor

Properties

animationFrame

animationFrame: number = 0

requestAnimationFrame reference.

children

children: LifecycleProps[] = []

Each GameObject has children Lifecycle Objects.

Readonly children$

children$: Subject<void> = ...

When Scene Object has children amount changed, it emits this subject.

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.

Readonly disableAutoSort$

disableAutoSort$: Subject<void> = ...

When disableAutoSort is called, it emits this subject.

Readonly disableDebug$

disableDebug$: Subject<void> = ...

When disableDebug is called, it emits this subject.

label

label: string

Each Lifecycle Object has label for pixi debugging.

lastUpdate

lastUpdate: number

Scene has last update unix time stored.

Readonly options

options: SceneOptions

Options are assigned at creation.

physics

physics: System<TBody>

Reference to Collision Detection System.

pixi

pixi: Application

resources

resources: Resources

Optional scene

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

Lifecycle Object may be added to a Scene Object.

stage

stage: Container<ContainerChild>

Top Level Container.

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.

x

x: number

position x

y

y: number

position y

Methods

addChild

destroy

disableAutoSort

disableDebug

enableAutoSort

enableDebug

getChildOfType

getChildrenOfType

init

  • init(options?): Promise<void>

  • Parameters

    • Optional options: Partial<ApplicationOptions>

    Returns Promise<void>

removeChild

showFPS

  • showFPS(style?): void

  • add body font family to set font of pixi-stats

    Parameters

    • style: string = 'position: fixed; top: 0; right: 0; z-index: 1000;'

    Returns void

start

stop

update

  • update(deltaTime): void

  • Updates the Lifecycle Object with actual deltaTime ~60fps

    Parameters

    • deltaTime: number

    Returns void

Static getQueryParams

  • getQueryParams(): Record<string, string>

  • Returns Record<string, string>

Static instantiate

Settings

Member Visibility

Theme

On This Page

constructor animationFrame children children$ destroy$ disableAutoSort$ disableDebug$ label lastUpdate options physics pixi resources scene stage update$ x y addChild destroy disableAutoSort disableDebug enableAutoSort enableDebug getChildOfType getChildrenOfType init removeChild showFPS start stop update getQueryParams instantiate