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...")
 
Line 5: Line 5:
 
==SCPUI.tbl==
 
==SCPUI.tbl==
 
*SCPUI defines what game states and substates exist for SCPUI through the use of this table file and modular -ui.tbms.
 
*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
+
*Begins with one of the section names and ends with #End
 +
 
 +
==#State Replacement==
 +
*This section defines what RML files are used to replace specific game states.
  
 
===$State:===
 
===$State:===
Line 19: Line 22:
 
*The path to the RML file definition to use for the game state
 
*The path to the RML file definition to use for the game state
 
*Must include the file path
 
*Must include the file path
 +
*Syntax: '''''string'''''
 +
 +
==#Background Replacement==
 +
*Defines what css class to use to set the background for UIs on a per-campaign basis.
 +
*By default all UIs use the css class<code>general_bg</code>.
 +
 +
===$Campaign Background:===
 +
*Designates that a new define will follow
 +
*Has no arguments
 +
 +
====+Campaign Filename:====
 +
*The campaign filename without extension
 +
*Syntax: '''''string'''''
 +
 +
====+RCSS Class Name:====
 +
*The css class name to use as a replacement. Make sure this class exists in a loaded rcss file!
 +
*Syntax: '''''string'''''
 +
 +
==#Briefing Stage Background Replacement==
 +
*Defines customized briefing grid backgrounds on a per-mission or per-briefing-stage level.
 +
*The background is <code>br-black.png</code> by default.
 +
 +
===$Briefing Grid Background:===
 +
*Designates that a new define will follow
 +
*Has no arguments
 +
 +
====+Mission Filename:====
 +
*The mission filename where the briefing background will be replaced
 +
*Without extension
 +
*Syntax: '''''string'''''
 +
 +
====+Default Background Filename:====
 +
*The new default background file to use for the mission
 +
*WITH extension
 +
*Syntax: '''''string'''''
 +
 +
====+Stage Override:====
 +
*The briefing stage of the mission to define an override for
 +
*Not required for every stage. Any stage without an override will use the mission default
 +
*Syntax: '''''integer'''''
 +
 +
=====+Background Filename:=====
 +
*The new default background file to use for the stage
 +
*WITH extension
 
*Syntax: '''''string'''''
 
*Syntax: '''''string'''''
  
Line 31: Line 78:
 
+Substate: Newsroom
 
+Substate: Newsroom
 
+Markup: data/interface/markup/journal.rml
 
+Markup: data/interface/markup/journal.rml
 +
 +
#Background Replacement
 +
 +
$Campaign Background:
 +
+Campaign Filename: bta1_m
 +
+RCSS Class Name: bta1_bg
 +
 +
#Briefing Stage Background Replacement
 +
 +
$Briefing Grid Background:
 +
+Mission Filename: bta2_m1_01
 +
+Default Background Filename: br-black.png
 +
+Stage Override: 1
 +
+Background Filename: br-deltaserpentis.png
 +
+Stage Override: 2
 +
+Background Filename: br-stars.png
 +
+Stage Override: 5
 +
+Background Filename: br-luyten.png
  
 
#End
 
#End
 
</pre>
 
</pre>

Revision as of 16:33, 5 October 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 one of the section names and ends with #End

#State Replacement

  • This section defines what RML files are used to replace specific game states.

$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

#Background Replacement

  • Defines what css class to use to set the background for UIs on a per-campaign basis.
  • By default all UIs use the css classgeneral_bg.

$Campaign Background:

  • Designates that a new define will follow
  • Has no arguments

+Campaign Filename:

  • The campaign filename without extension
  • Syntax: string

+RCSS Class Name:

  • The css class name to use as a replacement. Make sure this class exists in a loaded rcss file!
  • Syntax: string

#Briefing Stage Background Replacement

  • Defines customized briefing grid backgrounds on a per-mission or per-briefing-stage level.
  • The background is br-black.png by default.

$Briefing Grid Background:

  • Designates that a new define will follow
  • Has no arguments

+Mission Filename:

  • The mission filename where the briefing background will be replaced
  • Without extension
  • Syntax: string

+Default Background Filename:

  • The new default background file to use for the mission
  • WITH extension
  • Syntax: string

+Stage Override:

  • The briefing stage of the mission to define an override for
  • Not required for every stage. Any stage without an override will use the mission default
  • Syntax: integer
+Background Filename:
  • The new default background file to use for the stage
  • WITH extension
  • 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

#Background Replacement

$Campaign Background:
	+Campaign Filename: bta1_m
	+RCSS Class Name: bta1_bg

#Briefing Stage Background Replacement

$Briefing Grid Background:
	+Mission Filename: bta2_m1_01
	+Default Background Filename: br-black.png
	+Stage Override: 1
		+Background Filename: br-deltaserpentis.png
	+Stage Override: 2
		+Background Filename: br-stars.png
	+Stage Override: 5
		+Background Filename: br-luyten.png

#End
Retrieved from "https://wiki.hard-light.net/index.php?title=Scpui.tbl&oldid=65208"