dcsext.ui.Picture

Picture - draw a picture on screen to all players.

Contents

  1. Methods
    1. picture:isDrawn()
    2. picture:draw()
    3. picture:remove()
  2. Metamethods
    1. picture:__init()
  3. Tables
    1. picture.hAlign
    2. picture.vAlign
    3. picture.scaleType

Methods

picture:isDrawn()

Has the picture been drawn?

Returns

  • true if the picture has been drawn, false otherwise.

picture:draw()

Draw the picture. Sends the picture command to the mission environment using the current property values.

picture:remove()

Remove the picture. Resets the drawn state; the picture itself stays visible until its duration expires.

Metamethods

picture:__init()

Constructor. Initializes the picture with the properties listed below, which can be reassigned at any time before drawing:

  • file - resource key of the image to display
  • duration - seconds the picture stays visible (default 30)
  • clearview - clear the view behind the picture (default false)
  • delay - seconds to wait before showing (default 0)
  • halign - a Picture.hAlign value (default CENTER)
  • valign - a Picture.vAlign value (default CENTER)
  • scale - scaling factor (default 100)
  • scaletype - a Picture.scaleType value (default PIXEL)

Tables

picture.hAlign

Horizontal alignment options for the picture.

Parameters

[LEFT]
[CENTER]
[RIGHT]

picture.vAlign

Vertical alignment options for the picture.

Parameters

[TOP]
[CENTER]
[BOTTOM]

picture.scaleType

Scale unit options for the picture.

Parameters

[PIXEL]
[PERCENT]