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

Hierarchy

  • any
    • InterfaceCanvasGroup

Properties

groupName: string = "interface"

Methods

  • Parameters

    • options: any

    Returns 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.