Skip to main content

DialogImagesDisplay

The DialogImagesDisplay is the class responsible for displaying images when necessary.

Methods API

MethodParametersReturnsDescription
DisplayImagestring: image idDisplays an image by its id.
ClearStops displaying the image that it is currently displaying.

Static methods API

MethodParametersReturnsDescription
GetImagesDisplaystring: displayer idDialogImagesDisplayGets a dialog image displayer by its id.
DisplayImage
  • string: image id
  • string: target (displayer id)
Displays an image by image id on a displayer by its id.
DisplayImages
  • ARegisterDialogEntry.Image[]: images
  • bool: cleanup (default = true)
Displays a set of images. If cleanup is enabled, unused displayers will reset its display image (this is the default behaviour).
GetAllDisplayersDialogImagesDisplay[]Gets all image displayers.