Options Helper

Options Helper

A library mod for X4: Foundations that provides reusable MD (Mission Director) script libraries for building SirNukes Mod Support APIs options menus.

Instead of repeating the widget-construction boilerplate in every mod, declare your menu sections using the Options_Helper libraries and wire up a single handler cue per widget type.

Requirements

• [] X4: Foundations version 8. 00 or newer

  [] SirNukes Mod Support APIs version 1. 95 or higher

Place the options_helper/ folder in your X4 extensions directory alongside your other mods.

API Reference

All libraries live in the md. Options_Helper namespace. Widget-building libraries use purpose="run_actions" (called with <run_actions ref="...">) while layout and event-processing libraries use purpose="include_actions" (called with <include_actions ref="...">).

Layout libraries

Add_Empty_Row — include_actions

Adds a thin visual separator row (border height) to the current options menu.

<include_actions ref="md. Options_Helper. Add_Empty_Row" />

Add_Title_Row — run_actions

Adds a centred section title row followed by an empty separator row.

• [] title (required) - Text string or text DB reference {page, id}

  [] columns (default: 12) - Number of columns in the menu

  <run_actions ref="md. Options_Helper. Add_Title_Row">

  <param name="title" value="{1972092401, 100}" />

  <param name="columns" value="12" />

  </run_actions>

  Widget libraries

  Add_Checkbox — run_actions

  Adds a checkbox widget with a text label to its right. Automatically starts a new row when col == 1.

  • [] id (required) - String identifier - used to build the widget id and the echo key $<id>

    [] col (default: 1) - Column for the checkbox widget

    [] textColSpan (default: 1) - Column span for the label text cell

    [] text (default: '') - Label text or text DB reference

    [] data (required) - Table holding the current value at key $<id>

    [] active (default: true) - Whether the widget is interactive

  • handle (default: null) - Cue to signal on click

  Ha