Class InterfaceCanvasGroup

A container group which displays interface elements rendered above other canvas groups.

Hierarchy

any
- InterfaceCanvasGroup

Index

Constructors

constructor

Methods

Properties

Constructors

constructor

new InterfaceCanvasGroup(): InterfaceCanvasGroup

Inherited from BaseCanvasMixin(PIXI.Container).constructor
Returns InterfaceCanvasGroup

Methods

draw

draw(): Promise<void>

Draw the canvas group and all its component layers.

Returns Promise<void>

createScrollingText

createScrollingText(origin: Point, content: string, [options]?: { duration: number; distance: number; anchor: TEXT_ANCHOR_POINTS; direction: TEXT_ANCHOR_POINTS; jitter: number; textStyle: any }): Promise<PreciseText>

Display scrolling status text originating from this ObjectHUD container.

Parameters
- origin: Point
  
  An origin point where the text should first emerge
- content: string
  
  The text content to display
- [options]: { duration: number; distance: number; anchor: TEXT_ANCHOR_POINTS; direction: TEXT_ANCHOR_POINTS; jitter: number; textStyle: any } = {}
  
  Options which customize the text animation
  - duration: number
  - distance: number
  - anchor: TEXT_ANCHOR_POINTS
  - direction: TEXT_ANCHOR_POINTS
  - jitter: number
  - textStyle: any
Returns Promise<PreciseText>
The created PreciseText object which is scrolling

Private #createReverseMaskFilter

#createReverseMaskFilter(): ReverseMaskFilter

Create the reverse mask filter.

Returns ReverseMaskFilter
The reference to the reverse mask.

Private #drawOutline

#drawOutline(): void

Draw a background outline which emphasizes what portion of the canvas is playable space and what is buffer.

Returns void

Private #drawScrollingText

#drawScrollingText(): void

Draw the scrolling text.

Returns void

Properties

reverseMaskfilter

reverseMaskfilter: any

Private #scrollingText

#scrollingText: Container

A container dedicated to the display of scrolling text.

Private #outline

#outline: any

A graphics which represent the scene outline.

Static groupName

groupName: string = "interface"

override