modConfigReady

modconfigready

This event fires once MWSE's internal mod configuration menu code has been initialized.

This event is used to register the settings configuration menu. That can be achieved by using any of the following:

• template:register()
• mwse.mcm.register()
• mwse.registerModConfig()

--- @param e modConfigReadyEventData
local function modConfigReadyCallback(e)
end
event.register(tes3.event.modConfigReady, modConfigReadyCallback)

Tip

An event can be claimed by setting e.claim to true, or by returning false from the callback. Claiming the event prevents any lower priority callbacks from being called.

Examples

Example: Basic MCM.

local config = require("MyMod.config")

local function onModConfigReady()
    local template = mwse.mcm.createTemplate({ name = "My Mod" })
    template:saveOnClose("My Mod", config)
    template:register()

    local settings = template:createSideBarPage({ label = "Settings" })
    settings.sidebar:createInfo({
        -- This text will be on the right-hand side block
        text = "My Mod v. 1.0\n\nCreated by me.\n\nHover over a feature for more info."
    })

    settings:createOnOffButton({
        label = "Feature",
        -- The text in the description will replace the text
        -- in sidebar on the right-hand side, when this button
        -- is hovered over.
        description = "This feature does...",
        variable = mwse.mcm.createTableVariable({
            id = "feature",
            table = config,
        })
    })

end

event.register(tes3.event.modConfigReady, onModConfigReady)