Class InterfaceCanvasGroup

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

Hierarchy

any
- InterfaceCanvasGroup

Index

Properties

Methods

_draw addDrawing createScrollingText removeDrawing

Properties

`Static`groupName

groupName: string = "interface"

Methods

_draw

_draw(options: any): Promise<void>
Parameters
- options: any
Returns Promise<void>
Inherit Doc

addDrawing

addDrawing(drawing: canvas.placeables.Drawing): Graphics
Add a PrimaryGraphics to the group.
Parameters
- drawing: canvas.placeables.Drawing
  The Drawing being added
Returns Graphics
The created Graphics instance

createScrollingText

createScrollingText(
    origin: Point,
    content: string,
    options?: {
        anchor?: TextAnchorPoint;
        direction?: TextAnchorPoint;
        distance?: number;
        duration?: number;
        jitter?: number;
        textStyle?: object;
    },
): Promise<void>
Display scrolling status text originating from an origin point on the Canvas.
Parameters
- origin: Point
  An origin point where the text should first emerge
- content: string
  The text content to display
- Optionaloptions: {
      anchor?: TextAnchorPoint;
      direction?: TextAnchorPoint;
      distance?: number;
      duration?: number;
      jitter?: number;
      textStyle?: object;
  } = {}
  Options which customize the text animation
  - Optionalanchor?: TextAnchorPoint
    The original anchor point where the text appears
  - Optionaldirection?: TextAnchorPoint
    The direction in which the text scrolls
  - Optionaldistance?: number
    The distance in pixels that the scrolling text should travel
  - Optionalduration?: number
    The duration of the scrolling effect in milliseconds
  - Optionaljitter?: number
    An amount of randomization between [0, 1] applied to the initial position
  - OptionaltextStyle?: object
    Additional parameters of PIXI.TextStyle which are applied to the text
Returns Promise<void>
A promise that resolves after the scrolling text animation ended.

removeDrawing

removeDrawing(drawing: canvas.placeables.Drawing): void
Remove a PrimaryGraphics from the group.
Parameters
- drawing: canvas.placeables.Drawing
  The Drawing being removed
Returns void