Skip to content

tes3uiMenuController⚓︎

The controller responsible for the menu system.

Properties⚓︎

aiDisabled⚓︎

A flag that controls if AI is active.

Returns:

  • result (boolean)

bordersEnabled⚓︎

A flag that controls if cell borders are rendered.

Returns:

  • result (boolean)

collisionBoxesEnabled⚓︎

A flag that controls if collision boxes are rendered.

Returns:

  • result (boolean)

collisionDisabled⚓︎

A flag that controls if collisions are disabled.

Returns:

  • result (boolean)

fogOfWarDisabled⚓︎

A flag that controls whether the local map menu renders fog of war.

Returns:

  • result (boolean)

fontColors⚓︎

Read-only. A 1-indexed table with 49 tes3uiFontColor objects for all different in-game uses for fonts.

Namely: normal, normal_over, normal_pressed, active, active_over, active_pressed, disabled, disabled_over, disabled_pressed, link, link_over, link_pressed, journal, journal_over, journal_pressed, journal_topic, journal_topic_over, journal_topic_pressed, journal_finished_quest_topic, journal_finished_quest_topic_over, journal_finished_quest_topic_pressed, answer, answer_over, answer_pressed, header, notify, big_normal, big_normal_over, big_normal_pressed, big_link, big_link_over, big_link_pressed, big_answer, big_answer_over, big_answer_pressed, big_header, big_notify, background, focus, npc_health, health, magic, fatigue, misc, weapon_fill, magic_fill, positive, negative, count.

Returns:


godModeEnabled⚓︎

A flag that controls if god mode is enabled.

Returns:

  • result (boolean)

helpDelay⚓︎

Read-only. Delay in seconds before help tooltip appears. Corresponds to the Menu Help Delay slider in Options menu.

Returns:

  • result (number)

helpRoot⚓︎

Read-only. The root element of the help UI layer. The help UI layer will always be drawn after the main UI layer and therefore all elements on it will be shown in front of elements of the main UI layer. This element contains top level menus like tooltips, message boxes and more as direct children. Prefer using the tes3ui.findHelpLayerMenu() function to find one of this element's direct children.

Returns:


inputController⚓︎

Read-only. Access to tes3uiMenuInputController.

Returns:


inventoryMenuEnabled⚓︎

A flag that controls whether the inventory menu is enabled or disabled.

Returns:

  • result (boolean)

magicMenuEnabled⚓︎

A flag that controls whether the magic menu is enabled or disabled. Magic menu is the menu used to select a spell for casting from available spells, scrolls and enchantments.

Returns:

  • result (boolean)

mainRoot⚓︎

Read-only. The root element of the main UI layer. This element contains top level menus like the inventory menu, magic menu, status menu, map menu, the HUD and more as direct children. Prefer using the tes3ui.findMenu() function to find one of this element's direct children.

Returns:


mapMenuEnabled⚓︎

A flag that controls whether the map menu is enabled or disabled.

Returns:

  • result (boolean)

A flag that controls if menus are disabled.

Returns:

  • result (boolean)

pathGridShown⚓︎

A flag that controls if path grid nodes are rendered.

Returns:

  • result (boolean)

scriptCompiler⚓︎

Read-only. Access to tes3scriptCompiler object.

Returns:

  • result (tes3scriptCompiler)

scriptsDisabled⚓︎

A flag that controls if mwscript is allowed to execute.

Returns:

  • result (boolean)

skyDisabled⚓︎

A flag that controls if the sky is rendered.

Returns:

  • result (boolean)

statsMenuEnabled⚓︎

A flag that controls whether the stats menu is enabled or disabled. Stats menu lists all of the player's current skill and attribute values, level, race, class, health, magicka and fatigue.

Returns:

  • result (boolean)

wireframeEnabled⚓︎

A flag that controls if a wireframe property is active on the worldspace.

Returns:

  • result (boolean)

worldDisabled⚓︎

A flag that controls if the world is rendered.

Returns:

  • result (boolean)