Class Scene

constructor

• new Scene(renderSystem, physicsSystem, inputSystem, hierarchySystem, soundSystem, animationSystem): Scene

• Parameters

  • renderSystem: RenderSystem
  • physicsSystem: PhysicsSystem
  • inputSystem: InputSystem
  • hierarchySystem: HierarchySystem
  • soundSystem: SoundSystem
  • animationSystem: AnimationSystem

  Returns Scene

ReadonlyanimationSystem

ReadonlyhierarchySystem

ReadonlyinputSystem

ReadonlyphysicsSystem

ReadonlyrenderSystem

ReadonlysoundSystem

Readonlyuuid

entities

• get entities(): IEntity[]

• Returns IEntity[]

shouldDraw

• get shouldDraw(): boolean

• Returns boolean

dispose

• dispose(): void

• Disposes the scene, unregistering all entities components from the corrispective systems and clearing the entities array

  Returns void

draw

• draw(): void

• Sets the scene to draw, registering all entities components into the corrispective systems

  Returns void

hide

• hide(): void

• Sets the scene to not draw, unregistering all entities components from the corrispective systems

  Returns void

loadFromFile

• loadFromFile(filePath): Promise<void>

• Loads the scene from a given file path

  Parameters

  • filePath: string

    path of the scene file to load

  Returns Promise<void>

loadFromJson

• loadFromJson(sceneProps): void

• Loads the scene from a given json object

  Parameters

  • sceneProps: SceneJsonProps

    the json object representing the scene

  Returns void

registerEntity

• registerEntity(entity): void

• Adds entity to the scene and registers the entity's components into the corrispective systems if the scene is set to draw, else it will defer registering the components when draw is set to true

  Parameters

  • entity: IEntity

    The entity to register

  Returns void

toJson

• toJson(): SceneJsonProps

• Returns SceneJsonProps

unregisterEntity

• unregisterEntity(uuid): void

• Removes entity from the scene. Also removes the entity's components from the corrispective systems

  Parameters

  • uuid: string

    The uuid of the entity to unregister

  Returns void