H3lp Yours3lfDocs
api

image

Place a caller-provided texture resource in a layout.

Builds a ui.TYPE.Image layout. Pass a texture resource or openmw.ui.TextureResourceOptions; H3 converts option tables with ui.texture.

Example

local ui = require 'openmw.ui'
local util = require 'openmw.util'
local image = require 'scripts.s3.components.image'

ui.create {
  type = ui.TYPE.Container,
  layer = 'Windows',
  content = ui.content {
    image {
      resource = {
        path = 'white',
      },
      props = {
        size = util.vector2(32, 32),
      },
    },
  },
}

Parameters

FieldTypeDescription
resourceopenmw.ui.TextureResource or openmw.ui.TextureResourceOptionsTexture resource or options for one; takes precedence over props.resource.
templateopenmw.ui.Template?Replaces the default image template.

Common layout fields are documented on the UI Components overview.

See also

iconButton · itemSlot · headBlock