Nodemap.tbl: Difference between revisions

MjnMixael (talk | contribs)
Created page with "{{SCPUI_table}} {{Tables}} Nodemap.tbl is used by the SCPUI script system to define the node map and its progression within a mod's Node Map UI screen. Nodemap.tbl can be..."
 
MjnMixael (talk | contribs)
Replaced content with "{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/nodemap.tbl}} Category:SCPUI Category:Tables"
Tag: Replaced
 
(One intermediate revision by the same user not shown)
Line 1: Line 1:
{{SCPUI_table}}
{{SCPUI moved|https://github.com/MjnMixael/SCPUI/wiki/nodemap.tbl}} [[Category:SCPUI]] [[Category:Tables]]
{{Tables}}
Nodemap.tbl is used by the [[SCPUI]] script system to define the node map and its progression within a mod's Node Map UI screen.
 
Nodemap.tbl can be extended with xxx-nmap.tbm.
 
==Nodemap.tbl==
*Defines the map options, configuration, and layout.
*Begins with one of the configuration sections and ends with #End
 
==#Node Map Icons==
*Defines the available icons, assigned as Colors for each map system.
 
===$Name:===
*The name of the icon. Usually a color.
*Syntax: '''''string'''''
 
====+File Base:====
*The image file to use for the icon.
*Syntax: '''''string'''''
 
==#Node Map Colors==
*This section is shorthand to define colors used for the nodes attached to each system.
 
===$Name:===
*The name of the color.
*Syntax: '''''string'''''
 
====+Red:====
*The red value for the color
*Syntax: '''''integer'''''
 
====+Green:====
*The green value for the color
*Syntax: '''''integer'''''
 
====+Blue:====
*The blue value for the color
*Syntax: '''''integer'''''
 
==#Node Map Systems==
*Defines all the systems on the map and their location
 
===$Name:===
*The name of the system.
*Must be unique
*Syntax: '''''string'''''
 
===$Display Name:===
*The name as displayed to the player.
*Syntax: '''''string'''''
 
===$Hide Label:===
*Hides the system name if true.
*Optional, defaults to false
*Syntax: '''''boolean'''''
 
===$Description:===
*The description of the system.
*Optional, defaults to an empty string
*Syntax: '''''string'''''
 
===$Controlling Faction:===
*The name of the controlling faction of the of the system.
*Optional, defaults to an empty string
*Syntax: '''''string'''''
 
===$Type Of System:===
*The type of the system (binary, trinary, etc).
*Optional, defaults to an empty string
*Syntax: '''''string'''''
 
===$X Coordinate:===
*The X coordinate of the system on the map
*Syntax: '''''float'''''
 
===$Y Coordinate:===
*The Y coordinate of the system on the map
*Syntax: '''''float'''''
 
===$Color:===
*The Color of the system. Should be one of the Node Map Icons listed in the #Node Map Icons section
*Syntax: '''''float'''''
 
===$Visible:===
*Whether or not the system is visible on the map
*Optional, defaults to true
*Syntax: '''''boolean'''''
 
===$Selectable:===
*Whether or not the system is selectable on the map
*Optional, defaults to true
*Syntax: '''''boolean'''''
 
===$Node:===
*Defines a node for the system. Each system can have unlimited nodes. Nodes are automatically connected to each other based on these configuration settings.
*The value should be the node name and must be unique in the entire map. IE: You can have AntaresNode1 and AntaresNode2, etc.
*Syntax: '''''string'''''
 
====+Angle:====
*The degree where the node should be placed around the system it is attached to
*Syntax: '''''integer'''''
 
====+Color:====
*The color the node should be drawn with. Should match one of the #Node Map Colors defined above.
*Syntax: '''''string'''''
 
====+Enforce Line Color:====
*If true, the line color from this node will always attempt to match the color of the node. Hierarchy of the table may change expected behavior.
*Optional, defaults to false
*Syntax: '''''boolean'''''
 
====+Do Not Connect:====
*If true, there will be no line connecting this node to another node ever.
*Optional, defaults to false
*Syntax: '''''boolean'''''
 
===$Progression:===
*Begins a progression definition that overrides all previous values based on the mod's custom progression system.
*Progression is defined through a UI Topic
*Progression should return a numeric value. Highest value wins.
 
====+Description:====
*The new description to use for this progression.
*Optional
*'''''string'''''
 
====+Append Description:====
*The string to append to the most recent full description.
*Optional
*'''''string'''''
 
====+Controlling Faction:====
*The new controlling faction to use for this progression
*Optional
*'''''string'''''
 
====+Color:====
*The new color to use. Should be one of the previously defined icons.
*Optional
*'''''string'''''
 
====+Node:====
*Defines a progression for a specific node. The value should be the name of the node to progress.
*Optional
*'''''string'''''
 
=====+Color:=====
*The new color to use. Should be one of the previously defined colors.
*Optional
*'''''string'''''
 
=====+Enforce Line Color:=====
*The new enforcement value to use.
*Optional
*'''''boolean'''''
 
=====+Do Not Connect:=====
*The new connection value to use.
*Optional
*'''''boolean'''''
 
 
===Example===
<pre>
#Journal Options
$Title: XSTR("Newsroom", 9284)
#End
 
#Journal Sections
 
$Name: Headlines
$XSTR: 193
 
$Name: Editorials
$XSTR: 194
 
#End
 
#Journal Entries ;;Languages can be done by creating files with the language shorthand appended. bta1_h01-gr.txt
 
$Name: Living In Antares
$XSTR: 195
$Group: Headlines
$Visible by Default: true
$Short Title: bta1_head01
$File: bta1_h01.txt
 
$Name: The Stinging of a Wasp
$XSTR: 196
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head02
$File: bta1_h02.txt
 
$Name: The Stinging of a Wasp Pt.2
$XSTR: 197
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head03
$File: bta1_h03.txt
 
$Name: Hammer of Light Activity Increases
$XSTR: 198
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head04
$File: bta1_h04.txt
 
$Name: Piracy and Smuggling on the Increase
$XSTR: 199
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head05
$File: bta1_h05.txt
 
$Name: Living in a Box
$XSTR: 200
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head06
$File: bta1_h06.txt
 
$Name: Criminal Activity Continues
$XSTR: 201
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head07
$File: bta1_h07.txt
 
$Name: Carnage at Detiula Station
$XSTR: 202
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head08
$File: bta1_h08.txt
 
$Name: Messenger of Death
$XSTR: 203
$Group: Headlines
$Visible by Default: false
$Short Title: bta1_head09
$File: bta1_h09.txt
 
$Name: War-Torn and Without Choice
$XSTR: 204
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit01
$File: bta1_e01.txt
$Image: deadcity
$Caption: Volsinii city after PVN bombardment - year 2330
$Caption XSTR: 218
 
$Name: More Casualties, More Tragedies
$XSTR: 205
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit02
$File: bta1_e02.txt
$Image: deathinspace
$Caption: Debris after GTA attack on civilian transport Retin - 2335/04/25
$Caption XSTR: 219
 
$Name: Antares, Or What's Left Of It
$XSTR: 206
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit03
$File: bta1_e03.txt
$Image: gulnarasun
$Caption: Gulnara Research Station is often a target of local raiding parties.
$Caption XSTR: 220
 
$Name: The Hand Grasping The Suns
$XSTR: 207
$Group: Editorials
$Visible by Default: true
$Short Title: bta1_edit04
$File: bta1_e04.txt
$Image: militarysun
$Caption: Some GTA warships are already in Antares preceding the Intrepid's arrival.
$Caption XSTR: 221
 
$Name: Antares' Judgment Begins
$XSTR: 208
$Group: Editorials
$Visible by Default: false
$Short Title:bta1_edit05
$File: bta1_e05.txt
$Image: cargoplatform
$Caption: One of many cargo depots littered around Antares.
$Caption XSTR: 227
 
$Name: Blind Spot
$XSTR: 209
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit06
$File: bta1_e06.txt
$Image: krakenstation
$Caption: Kraken Station, the site of the attack on the Regulus Senators.
$Caption XSTR: 228
 
$Name: Facade of the Starscape
$XSTR: 210
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit07
$File: bta1_e07.txt
$Image: hillross
$Caption: Hillross Station is owned by Exxon-Beckham.
$Caption XSTR: 232
 
$Name: Abeyance
$XSTR: 211
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit08
$File: bta1_e08.txt
$Image: afvalk
$Caption: Antarian security forces have begun painting the emblem of the Antares Federation political party on their hulls.
$Caption XSTR: 233
 
$Name: Breadcrumbs and Superposition
$XSTR: 212
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit09
$File: bta1_e09.txt
$Image: afemblem
$Caption: The official emblem of the Antares Federation political party.
$Caption XSTR: 234
 
$Name: The Sleeping Dragon
$XSTR: 213
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit10
$File: bta1_e10.txt
$Image: cardinalpropo
$Caption: The HLD Cardinal as shown in an HoL propaganda release.
$Caption XSTR: 235
 
$Name: The Dragon Awakens
$XSTR: 214
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit11
$File: bta1_e11.txt
$Image: megalith
$Caption: Security firm Megalith is now operating directly out of Antares Station.
$Caption XSTR: 236
 
$Name: Phagocytosis
$XSTR: 215
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit12
$File: bta1_e12.txt
$Image: apoapsis
$Caption: The AFC Apoapsis is now standing by near Antares Station.
$Caption XSTR: 237
 
$Name: The Suns Are Released
$XSTR: 216
$Group: Editorials
$Visible by Default: false
$Short Title: bta1_edit13
$File: bta1_e13.txt
$Image: antsuns
$Caption: Antares Major and Minor are our symbols for hope and unity in the future.
$Caption XSTR: 238
 
 
#End
</pre>
[[Category:Tables]]
[[Category:SCPUI]]

Latest revision as of 18:29, 28 October 2026

This page has moved. SCPUI documentation now lives on the SCPUI GitHub wiki.
See the new version of this page. The old content is still available in this page's history.