Skip to main content

@palco-2d/core / ScenePlugin

Class: ScenePlugin

Defined in: src/ScenePlugin.ts:5

Constructors​

new ScenePlugin()​

new ScenePlugin(scene): ScenePlugin

Defined in: src/ScenePlugin.ts:10

Parameters​

scene​

Scene

Returns​

ScenePlugin

Properties​

activeSelectionHandler​

activeSelectionHandler: ActiveSelectionManager

Defined in: src/ScenePlugin.ts:8

running​

running: boolean = false

Defined in: src/ScenePlugin.ts:6

scene​

scene: Scene

Defined in: src/ScenePlugin.ts:7

Methods​

init()​

init(): void

Defined in: src/ScenePlugin.ts:34

Returns​

void

onActiveSelectionUpdate()​

protected onActiveSelectionUpdate(entity, entities): void

Defined in: src/ScenePlugin.ts:55

Called when the active selection changes. This is where you can implement your own logic to handle what's happening when an entity is selected or deselected.

Parameters​

entity​

BaseEntity

entities​

BaseEntity[]

Returns​

void

onActiveUISelectionUpdate()​

protected onActiveUISelectionUpdate(entity, entities): void

Defined in: src/ScenePlugin.ts:72

Called when the active UI selection changes. This is where you can implement your own logic to handle what's happening when an entity is selected or deselected.

Parameters​

entity​

BaseEntity

entities​

BaseEntity[]

Returns​

void

onClearSelection()​

protected onClearSelection(): void

Defined in: src/ScenePlugin.ts:65

Called when active selection is clear (no entity selected) this is where you can implement your when logic to handle side effects when the user deselect all entities

Returns​

void

onClearUISelection()​

protected onClearUISelection(): void

Defined in: src/ScenePlugin.ts:82

Called when the active UI selection is cleared. This is where you can implement your own logic to handle what's happening when the user deselects all entities.

Returns​

void

render()​

render(ctx): void

Defined in: src/ScenePlugin.ts:48

Called every frame to render the plugin.

Parameters​

ctx​

CanvasRenderingContext2D

The canvas rendering context.

Returns​

void

start()​

start(): void

Defined in: src/ScenePlugin.ts:36

Returns​

void

stop()​

stop(): void

Defined in: src/ScenePlugin.ts:40

Returns​

void