H3lp Yours3lfDocs
api

bookFrame

Frame content with the solid Morrowind book treatment.

Builds a solid H3UI framed body, optionally preceded by a header title. It is a layout, not a window.

Example

local ui = require 'openmw.ui'
local bookFrame = require 'scripts.s3.components.bookFrame'
local text = require 'scripts.s3.components.text'

ui.create {
  type = ui.TYPE.Container,
  layer = 'Windows',
  content = ui.content {
    bookFrame {
      title = 'Notes',
      children = {
        text {
          text = 'A solid framed page.',
        },
      },
    },
  },
}

Parameters

FieldTypeDescription
titlestring?Optional heading text.
titlePropstable?Properties for the generated heading.
backgroundPropstable?Properties for the generated background; H3UI themes use this slot for the configured background color and transparency.
templateopenmw.ui.Template?Replaces the default solid frame template.
contenttable?Child content; takes precedence over children.
childrentable?Child layouts used when content is absent.

Common layout fields are documented on the UI Components overview.

See also

dialog · box · window