Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BufferLayer

A BufferLayer is a UI overlay presented over a buffer.

This allows for all manners of custom rendering - whether it is simply overlaying tokens or showing adorners, or completely overriding the rendering layer of the buffer.

Hierarchy

  • BufferLayer

Index

Properties

Methods

Properties

Optional friendlyName

friendlyName: undefined | string

friendlyName is used when showing the layer int eh UI

id

id: string

Unique id for the buffer layer. This must be globally unique and is used to reference the layer.

Methods

render

  • render returns a custom UI element. Note that this may be called multiple times per buffer, if there are multiple windows with the same buffer.

    Parameters

    Returns Element

Generated using TypeDoc