Class Scene<TBody>

base scene for front end rendering

Type Parameters

TBody extends Body = Body

Hierarchy (view full)

SceneSSR<TBody>
- Scene

Index

Constructors

constructor

Properties

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

Accessors

scene

Constructors

constructor

new Scene<TBody>(__namedParameters?): Scene<TBody>
Type Parameters
- TBody extends Body = Body
Parameters
- __namedParameters: SceneOptions = {}
Returns Scene<TBody>
Overrides SceneSSR.constructor
- Defined in src/scene.ts:39

Properties

animationFrame

animationFrame: number = 0

requestAnimationFrame reference.

children

children: LifecycleProps[] = []

Lifecycles can have children Lifecycles

`Readonly`children$

children$: Subject<Lifecycle> = ...

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.

gameObject

gameObject: GameObjectParent = undefined

Scene doesn't have parent gameObject

isInitialized

isInitialized: boolean = false

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<Renderer>

resources

resources: Resources

stage

stage: Container<ContainerChild> = ...

`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

Accessors

scene

get scene(): undefined
Scene doesn't have parent scene

Returns undefined
Inherited from SceneSSR.scene
- Defined in src/scene-ssr.ts:116

Methods

addChild

addChild(gameObject): void
Parameters
- gameObject: LifecycleProps & {
  body?: TBody;
  sprite?: Container<ContainerChild>;
  }
Returns void
Overrides SceneSSR.addChild
- Defined in src/scene.ts:166

createPixi

createPixi(options): Application<Renderer>
Parameters
- options: Partial<Record<string, any>>
Returns Application<Renderer>
- Defined in src/scene.ts:83

destroy

destroy(): void
Called to destroy can cleanup Lifecycle Object.

Returns void
Overrides SceneSSR.destroy
- Defined in src/scene.ts:141

disableAutoSort

disableAutoSort(): void
Returns void
- Defined in src/scene.ts:188

disableDebug

disableDebug(): void
Returns void
- Defined in src/scene.ts:207

enableAutoSort

enableAutoSort(): void
Returns void
- Defined in src/scene.ts:176

enableDebug

enableDebug(): void
Returns void
- Defined in src/scene.ts:194

getChildOfType

getChildOfType(type): LifecycleProps
Parameters
- type: string
Returns LifecycleProps
Inherited from SceneSSR.getChildOfType
- Defined in src/scene-ssr.ts:185

getChildrenOfType

getChildrenOfType(type): LifecycleProps[]
Parameters
- type: string
Returns LifecycleProps[]
Inherited from SceneSSR.getChildrenOfType
- Defined in src/scene-ssr.ts:189

init

init(options?): Promise<boolean>
Parameters
- Optionaloptions: Partial<Record<string, any>>
Returns Promise<boolean>
Overrides SceneSSR.init
- Defined in src/scene.ts:87

`Protected`onUpdateDebug

onUpdateDebug(graphics): void
Parameters
- graphics: Graphics
Returns void
- Defined in src/scene.ts:227

recursive

recursive(child, callback): void
Parameters
- child: LifecycleProps
- callback: ((deep: LifecycleProps) => void)
  - - (deep): void
    - Parameters
      
      deep: LifecycleProps
      
      Returns void
Returns void
Inherited from SceneSSR.recursive
- Defined in src/game-object.ts:101

removeChild

removeChild(...children): void
Parameters
- Rest...children: LifecycleProps[]
Returns void
Inherited from SceneSSR.removeChild
- Defined in src/scene-ssr.ts:180

resize

resize(): void
Returns void
- Defined in src/scene.ts:273

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
- Defined in src/scene.ts:220

stageAddChild

stageAddChild(...children): void
Parameters
- Rest...children: LifecycleProps[]
Returns void
Overrides SceneSSR.stageAddChild
- Defined in src/scene.ts:146

stageRemoveChild

stageRemoveChild(...children): void
Parameters
- Rest...children: LifecycleProps[]
Returns void
Overrides SceneSSR.stageRemoveChild
- Defined in src/scene.ts:156

start

start(): void
Returns void
Overrides SceneSSR.start
- Defined in src/scene.ts:131

stop

stop(): void
Returns void
Overrides SceneSSR.stop
- Defined in src/scene.ts:136

update

update(deltaTime): void
Parameters
- deltaTime: number
  
  = 1.0 for 60FPS
Returns void
Inherited from SceneSSR.update
- Defined in src/scene-ssr.ts:150

`Static`destroy

destroy(lifecycle): void
Parameters
- lifecycle: LifecycleProps
Returns void
Inherited from SceneSSR.destroy
- Defined in src/lifecycle.ts:76

`Static`getQueryParams

getQueryParams(): Record<string, string>
Returns Record<string, string>
- Defined in src/scene.ts:67

`Static`instantiate

instantiate(prefab): Promise<GameObject>
Parameters
- prefab: Prefab
Returns Promise<GameObject>
Inherited from SceneSSR.instantiate
- Defined in src/game-object.ts:71

`Static`update

update(lifecycle, deltaTime): void
Parameters
- lifecycle: LifecycleProps
- deltaTime: number
Returns void
Inherited from SceneSSR.update
- Defined in src/lifecycle.ts:83

Class Scene<TBody>

Type Parameters

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Scene<TBody>

Properties

animationFrame

children

Readonlychildren$

Readonlydestroy$

ReadonlydisableAutoSort$

ReadonlydisableDebug$

gameObject

isInitialized

label

lastUpdate

Readonlyoptions

physics

pixi

resources

stage

Readonlyupdate$

x

y

Accessors

scene

Returns undefined

Methods

addChild

Parameters

Returns void

createPixi

Parameters

Returns Application<Renderer>

destroy

Returns void

disableAutoSort

Returns void

disableDebug

Returns void

enableAutoSort

Returns void

enableDebug

Returns void

getChildOfType

Parameters

Returns LifecycleProps

getChildrenOfType

Parameters

Returns LifecycleProps[]

init

Parameters

Returns Promise<boolean>

ProtectedonUpdateDebug

Parameters

Returns void

recursive

Parameters

Parameters

Returns void

Returns void

removeChild

Parameters

Returns void

resize

Returns void

showFPS

Parameters

Returns void

stageAddChild

Parameters

Returns void

`Readonly`children$

`Readonly`destroy$

`Readonly`disableAutoSort$

`Readonly`disableDebug$

`Readonly`options

`Readonly`update$

`Protected`onUpdateDebug

`Static`destroy

`Static`getQueryParams

`Static`instantiate

`Static`update