Pixi’VNClass: CanvasManagerStatic
Defined in: src/canvas/CanvasManagerStatic.ts:19
This class is responsible for managing the canvas, the tickers, the events, and the window size and the children of the window.
Properties
_currentTickers
> readonly static _currentTickers: Map<string, TickerInfo<any>>
Defined in: src/canvas/CanvasManagerStatic.ts:252
_currentTickersSequence
> readonly static _currentTickersSequence: Map<string, Map<string, TickersSequence>>
Defined in: src/canvas/CanvasManagerStatic.ts:253
_currentTickersTimeouts
> readonly static _currentTickersTimeouts: Map<string, TickerTimeoutHistory>
Defined in: src/canvas/CanvasManagerStatic.ts:263
_isInitialized
> static _isInitialized: boolean = false
Defined in: src/canvas/CanvasManagerStatic.ts:51
_tickersToCompleteOnStepEnd
> readonly static _tickersToCompleteOnStepEnd: object
Defined in: src/canvas/CanvasManagerStatic.ts:264
stepAlias
> stepAlias: object[]
tikersIds
> tikersIds: object[]
canvasHeight
> static canvasHeight: number = 300
Defined in: src/canvas/CanvasManagerStatic.ts:50
canvasWidth
> static canvasWidth: number = 300
Defined in: src/canvas/CanvasManagerStatic.ts:49
htmlLayers
> static htmlLayers: HTMLElement[] = []
Defined in: src/canvas/CanvasManagerStatic.ts:48
This is the div that have same size of the canvas. This is useful to put interface elements. You can use React or other framework to put elements in this div.
Accessors
app
Get Signature
> get static app(): Application<Renderer>
Defined in: src/canvas/CanvasManagerStatic.ts:27
The Pixi.js application instance.
Throws
when the canvas has not been initialized yet (i.e. before calling Game.init()).
Returns
Application<Renderer>
childrenAliasesOrder
Get Signature
> get static childrenAliasesOrder(): string[]
Defined in: src/canvas/CanvasManagerStatic.ts:220
The order of the elements in the canvas, is determined by the zIndex.
Returns
string[]
currentTickersSequence
Get Signature
> get static currentTickersSequence(): object
Defined in: src/canvas/CanvasManagerStatic.ts:254
Returns
object
currentTickersWithoutCreatedBySteps
Get Signature
> get static currentTickersWithoutCreatedBySteps(): object
Defined in: src/canvas/CanvasManagerStatic.ts:233
Edit Tickers Methods
Returns
object
gameLayer
Get Signature
> get static gameLayer(): Container<ContainerChild>
Defined in: src/canvas/CanvasManagerStatic.ts:34
Returns
Container<ContainerChild>
Methods
addHtmlLayer()
> static addHtmlLayer(id, element, style?): HTMLDivElement
Defined in: src/canvas/CanvasManagerStatic.ts:137
Parameters
id
string
element
HTMLElement
style?
Partial<Pick<CSSStyleDeclaration, "position" | "pointerEvents" | "userSelect">> = {}
Returns
HTMLDivElement
addTickerTimeoutInfo()
> static addTickerTimeoutInfo(aliases, ticker, timeout, canBeDeletedBeforeEnd): void
Defined in: src/canvas/CanvasManagerStatic.ts:275
Parameters
aliases
string | string[]
ticker
string
timeout
string
canBeDeletedBeforeEnd
boolean
Returns
void
generateTickerId()
> static generateTickerId(...args): string
Defined in: src/canvas/CanvasManagerStatic.ts:268
Parameters
args
...any[]
Returns
string
getHtmlLayer()
> static getHtmlLayer(id): HTMLElement | undefined
Defined in: src/canvas/CanvasManagerStatic.ts:162
Parameters
id
string
Returns
HTMLElement | undefined
init()
> static init(element, options?, devtoolsOptions?): Promise<void>
Defined in: src/canvas/CanvasManagerStatic.ts:53
Parameters
element
HTMLElement
options?
Partial<ApplicationOptions> & object
devtoolsOptions?
Devtools
Returns
Promise<void>
removeHtmlLayer()
> static removeHtmlLayer(id): void
Defined in: src/canvas/CanvasManagerStatic.ts:153
Parameters
id
string
Returns
void
removeTickerTimeout()
> static removeTickerTimeout(timeout): void
Defined in: src/canvas/CanvasManagerStatic.ts:296
Parameters
timeout
string | Timeout
Returns
void
removeTickerTimeoutInfo()
> static removeTickerTimeoutInfo(timeout): void
Defined in: src/canvas/CanvasManagerStatic.ts:290
Parameters
timeout
string | Timeout
Returns
void
removeTickerTimeoutsByAlias()
> static removeTickerTimeoutsByAlias(alias, checkCanBeDeletedBeforeEnd): void
Defined in: src/canvas/CanvasManagerStatic.ts:303
Parameters
alias
string
checkCanBeDeletedBeforeEnd
boolean
Returns
void