Difference between revisions of "Scpui.tbl"

From FreeSpace Wiki
Jump to: navigation, search
(Created page with "Scpui.tbl is used by the SCPUI script system to define what engine game states are linked to librocket RML files. This effectively allows SCPUI...")
(No difference)

Revision as of 14:15, 22 April 2023

Scpui.tbl is used by the SCPUI script system to define what engine game states are linked to librocket RML files. This effectively allows SCPUI to override a built-in game UI with one of its own.

SCPUI.tbl can be extended with xxx-ui.tbm.

SCPUI.tbl

  • SCPUI defines what game states and substates exist for SCPUI through the use of this table file and modular -ui.tbms.
  • Begins with #State Replacement and ends with #End

$State:

+Substate:

  • The name of the substate
  • Required for GS_STATE_SCRIPTING
  • Syntax: string

+Markup:

  • The path to the RML file definition to use for the game state
  • Must include the file path
  • Syntax: string

Example

#State Replacement

$State: GS_STATE_INITIAL_PLAYER_SELECT
+Markup: data/interface/markup/pilot_select.rml

$State: GS_STATE_SCRIPTING
+Substate: Newsroom
+Markup: data/interface/markup/journal.rml

#End