mwseMCMComponent

mwsemcmcomponent

The base class for all MCM components, such as categories and settings. The basic component has a block UI element that holds a label. This is used to implement the following components:

• Templates
  • Template
• Pages
  • Exclusions Page
  • Filter Page
  • Mouse over Page
  • Page
  • Sidebar Page
• Categories
  • Category
  • Side by side block
• Infos
  • Active info
  • Hyperlink
  • Info
  • Mouse over info
• Settings
  • Button
  • On off button
  • Yes no button
  • Cycle button
  • Key binder
  • Dropdown
  • Text field
  • Paragraph field
  • Slider
  • Percentage slider

Properties

childIndent

childindent

The left padding size in pixels. Used on all the child components.

Returns:

• result (integer, nil)

---

childSpacing

childspacing

The bottom border size in pixels. Used on all the child components.

Returns:

• result (integer, nil)

---

class

class

Every MCM component has a unique string indentifier specific to that component. These strings are the filename of the file implementing a component. These are found in core\\mcm\\components.

Returns:

• result (string)

---

componentType

componenttype

For mwseMCMComponent this is set to "Component".

Returns:

• result (string)

---

createContentsContainer

createcontentscontainer, contentscontainer

This method creates the contents of a component. Not every component implements this method.

Returns:

• result (nil, fun(self: mwseMCMComponent, outerContainer: tes3uiElement))

---

description

description

If in a Sidebar Page, the description will be shown on mouseover.

Returns:

• result (string, nil)

---

elements

elements

This dictionary holds all the UI elements of the Component, for easy access.

Returns:

• result (mwseMCMComponentElements)

---

indent

indent

The left padding size in pixels. Only used if the childIndent isn't set on the parent component.

Returns:

• result (integer)

---

inGameOnly

ingameonly

If true, then this component will be disabled when on the main menu.

Returns:

• result (boolean)

---

label

label

The text of the component. Not all component types have a label.

Returns:

• result (string)

---

mouseOvers

mouseovers

This array of UI elements will have an event handler registered to trigger "MCM:MouseOver" event. For more info, see registerMouseOverElements method.

Returns:

• result (tes3uiElement[], nil)

---

paddingBottom

paddingbottom

The bottom border size in pixels. Only used if the childSpacing is unset on the parent component.

Returns:

• result (integer)

---

parentComponent

parentcomponent

Returns:

• result (mwseMCMComponent, nil)

---

postCreate

postcreate

Custom formatting function to make adjustments to any element saved in self.elements.

Returns:

• result (nil, fun(self: mwseMCMComponent))

---

sCancel

scancel

Set to the value of sCancel GMST.

Returns:

• result (string)

---

sNo

sno

Set to the value of sNo GMST.

Returns:

• result (string)

---

sOff

soff

Set to the value of sOff GMST.

Returns:

• result (string)

---

sOK

sok

Set to the value of sOK GMST.

Returns:

• result (string)

---

sOn

son

Set to the value of sOn GMST.

Returns:

• result (string)

---

sYes

syes

Set to the value of sYes GMST.

Returns:

• result (string)

---

Methods

checkDisabled

checkdisabled

Returns true if the component should be disabled.

Componets with a variable:

• True if the Component's variable has inGameOnly field set to true, and the game is on the main menu. For components with multiple subcomponent (Category), the check is done for each subcomponent.

Components without a variable:

• True if the Component's inGameOnly field is set to true, and the game is on the main menu.

local result = myObject:checkDisabled()

Returns:

• result (boolean)

---

create

create

This method creates the UI elements that comprise a component. To call this method, the mwseMCMComponent-derived type needs to have createContentsContainer method implemented.

myObject:create(parentBlock)

Parameters:

• parentBlock (tes3uiElement)

---

createInnerContainer

createinnercontainer, innercontainer

Creates component's innerContainer UI element inside given parentBlock, and stores it in the self.elements.innerContainer. The innerContainer will add self.indent additional padding on the left if the component has a label.

myObject:createInnerContainer(parentBlock)

Parameters:

• parentBlock (tes3uiElement)

---

createLabel

createlabel, label

Creates component's label UI element.

First, it calls self:createLabelBlock and creates the label element inside new labelBlock. Stores both new UI elements in the self.elements and self.mouseOvers.

myObject:createLabel(parentBlock)

Parameters:

• parentBlock (tes3uiElement)

---

createLabelBlock

createlabelblock, labelblock

Creates component's labelBlock UI element inside given parentBlock, and stores it in the self.elements.labelBlock and self.mouseOvers.

myObject:createLabelBlock(parentBlock)

Parameters:

• parentBlock (tes3uiElement)

---

createOuterContainer

createoutercontainer, outercontainer

Creates component's outerContainer UI element inside given parentBlock, and stores it in the self.elements.outerContainer and self.mouseOvers. The outerContainer holds all the other UI elements that comprise a component.

myObject:createOuterContainer(parentBlock)

Parameters:

• parentBlock (tes3uiElement)

---

disable

disable

This method disables the component's UI elements. That includes: changing the color of the UI elements to the tes3.palette.disabledColor and setting button widget state to tes3.uiState.disabled.

myObject:disable()

---

enable

enable

Enables the component's UI elements. That includes: changing the color of the UI elements to the tes3.palette.normalColor and registering handlers for tes3.uiEvent.mouseClick for buttons.

myObject:enable()

---

getComponent

getcomponent, component

Creates a new Component of given class or returns the given Component.

local component = myObject:getComponent({ class = ..., label = ..., indent = ..., childIndent = ..., paddingBottom = ..., childSpacing = ..., inGameOnly = ..., postCreate = ..., parentComponent = ... })

Parameters:

• componentData (mwseMCMComponent, table)
  • class (string): The component type to get. On of the following:
    • "Template"
    • "ExclusionsPage"
    • "FilterPage"
    • "MouseOverPage"
    • "Page"
    • "SideBarPage"
    • "Category"
    • "SideBySideBlock"
    • "ActiveInfo"
    • "Hyperlink"
    • "Info"
    • "MouseOverInfo"
    • "Setting"
    • "Button"
    • "OnOffButton"
    • "YesNoButton"
    • "CycleButton"
    • "KeyBinder"
    • "Dropdown"
    • "TextField"
    • "ParagraphField"
    • "Slider"
    • "DecimalSlider"
    • "PercentageSlider"
  • label (string): Optional. The label text to set for the new component. Not all component types have a label.
  • indent (integer): Default: 12. The left padding size in pixels. Only used if the childIndent isn't set on the parent component.
  • childIndent (integer): Optional. The left padding size in pixels. Used on all the child components.
  • paddingBottom (integer): Default: 4. The bottom border size in pixels. Only used if the childSpacing is unset on the parent component.
  • childSpacing (integer): Optional. The bottom border size in pixels. Used on all the child components.
  • inGameOnly (boolean): Default: false.
  • postCreate (fun(self: mwseMCMComponent)): Optional. Can define a custom formatting function to make adjustments to any element saved in self.elements.
  • parentComponent (mwseMCMComponent): Optional.

Returns:

• component (mwseMCMComponent)

---

new

new

Creates a new Component.

local component = myObject:new({ label = ..., description = ..., indent = ..., childIndent = ..., paddingBottom = ..., childSpacing = ..., inGameOnly = ..., postCreate = ..., class = ..., componentType = ..., parentComponent = ... })

Parameters:

• data (table): Optional.
  • label (string): Optional. The text of the component. Not all component types have a label.
  • description (string): Optional. If in a Sidebar Page, the description will be shown on mouseover.
  • indent (integer): Default: 12. The left padding size in pixels. Only used if the childIndent isn't set on the parent component.
  • childIndent (integer): Optional. The left padding size in pixels. Used on all the child components.
  • paddingBottom (integer): Default: 4. The bottom border size in pixels. Only used if the childSpacing is unset on the parent component.
  • childSpacing (integer): Optional. The bottom border size in pixels. Used on all the child components.
  • inGameOnly (boolean): Default: false.
  • postCreate (fun(self: mwseMCMComponent)): Optional. Can define a custom formatting function to make adjustments to any element saved in self.elements.
  • class (string): Optional.
  • componentType (string): Optional.
  • parentComponent (mwseMCMComponent): Optional.

Returns:

• component (mwseMCMComponent)

---

prepareData

preparedata

Prepares the provided parameters table and sets the parentComponent field to mwseMCMComponent.

local data = myObject:prepareData(data)

Parameters:

• data (string, mwseMCMComponent.new.data): Optional.

Returns:

• data (mwseMCMComponent.new.data)

---

printComponent

printcomponent

Prints the component table to the mwse.log. If a component is passed, it will be printed. If called without arguments, the component it was called on will be printed.

myObject:printComponent(component)

Parameters:

• component (table): Default: self.

---

registerMouseOverElements

registermouseoverelements

Registers an event handler on each given UI element for the tes3.uiEvent.mouseOver and tes3.uiEvent.mouseLeave that will trigger "MCM:MouseOver" event. That event is used by the MCM to update the sidebar on the mwseMCMSideBarPage.

myObject:registerMouseOverElements(mouseOverList)

Parameters:

• mouseOverList (tes3uiElement[]): Optional. If this argument isn't passed, does nothing.