Difference between revisions of "RUL File"

From SC4D Encyclopaedia
Jump to navigation Jump to search
sc4e>Warrior
m (fixed link)
 
(54 intermediate revisions by 6 users not shown)
Line 1: Line 1:
'''RUL Files''' are internal game files which control the placement of [[Transit Network]] items in-game.  There are numerous RUL Files used by the game, each of which has its own particular function.  There are three different types of RUL Files: [[Network-Specific|Network-Specific RUL Files]], Multi-Network, and [[Bridge RULs]].  In addition, the [[Network INI]] file effectively functions like a RUL File.
+
'''RUL Files''' are internal game files which control the placement of [[Transit Network]] items in-game.  There are numerous RUL Files used by the game, each of which has its own particular function.  There are three different types of RUL Files: [[Individual Network RULs|Network-Specific RUL Files]], Multi-Network RUL Files, and [[Bridge RUL]]s.  In addition, the [[Network INI]] file effectively functions like a RUL File. Because the format varies for each type of RUL File, the formats are covered on the individual pages for each RUL File type.
  
The [[Network Specs|Network Specs Folder]] written by many of the people who discovered the file formats is helpful for learning Transit [[Modding]] even if it is a few years old and a few things need to be updated
+
The function of the RUL File is defined by its [[Instance ID]]. It is not possible to add new RUL Files, though it is possible to define new Bridge RULs for networks that do not already have them.
  
The function of the RUL File is defined by its [[IID]].  It is not possible to add new RUL Files, though it is possible to define new Bridge RULs for networks that do not already have them.
+
==Network-Specific RUL Files==
 +
{{main|Individual Network RULs}}
  
== Network-Specific RUL Files ==
+
Each in-game network has two Network-Specific RUL Files, one Main RUL which defines the basic placement of the network, and one Supplemental RUL, which defines same-network overrides.  There are 24 total Network Specific RULs.
''Main article'': [[Network Specific RUL]]
 
  
Each in-game network has two Network-Specific RUL Files, one Main RUL which defines the basic placement of the network, and one Supplemental RUL, which defines same-network overrides. There are 18 total Network Specific RULs.
+
==Multi-Network RUL Files==
 +
There are three Multi-Network RUL Files, known by their IIDs: [[RUL0|RUL 0x10000000]] (RUL0), [[RUL1|RUL 0x10000001]] (RUL1) and [[RUL2|RUL 0x10000002]] (RUL2).  These all handle situations that can involve multiple networks.  RUL 0x10000000 is a particularly special case, since it deals exclusively with [[Puzzle Piece|ploppable network pieces]], as opposed to draggable network items. It is the only RUL file to do so. These three RUL files are often grouped in with [[INI]] files, for the similarity of their general format, in addition to the [[Network INI]] serving a similar purpose to these three RULs.
  
== Multi-Network RUL Files ==
+
{|width="80%" border="1" cellpadding="1" cellspacing="1"
There are three Multi-Network RUL Files, known by their IIDs: [[RUL 0x10000000]], [[RUL 0x10000001]] and [[RUL 0x10000002]].  These all handle situations that can handle multiple networks.  RUL 0x10000000 is a particularly special case, since it deals exclusively with [[Puzzle Pieces]], ploppable network pieces, as opposed to Draggable Network items, the only such RUL to do so.
+
|-
 +
!Type ID
 +
!Group ID
 +
!Instance ID
 +
!Name
 +
!Description
 +
|-
 +
|0x0a5bcf4b
 +
|0xaa5bcf57
 +
|0x10000000
 +
|[[RUL0|Intersection Ordering]]
 +
|RUL 0x10000000
 +
|-
 +
|0x0a5bcf4b
 +
|0xaa5bcf57
 +
|0x10000001
 +
|[[RUL1|Intersection Solutions]]
 +
|RUL 0x10000001
 +
|-
 +
|0x0a5bcf4b
 +
|0xaa5bcf57
 +
|0x10000002
 +
|[[RUL2|Network Overrides]]
 +
|RUL 0x10000002
 +
|}
  
== Bridge RULs ==
+
==Bridge RULs==
''Main article'': [[Bridge RUL]]
+
{{main|Bridge RUL}}
  
Bridge RULs allow for more control over custom bridges.
+
Bridge RULs contain layout information for complex bridges, and allow for more control over custom bridges. Note that they are not required for all bridges, and not all network types have a corresponding Bridge RUL file.
  
== Network INI ==
+
==Network INI==
''Main article'': [[Network INI]]
+
{{main|Network INI}}
  
The Network INI file, while technically not a RUL file, combines many functions of the various RUL files. It also controls bridge shadows, Left-Hand Drive path substitution, Powerlines, and various Bugfixes.
+
The Network INI file, while technically not a RUL file, combines many functions of the various RUL files. Prior to the release of [[Rush Hour]], this file contained all of the information that would eventually be split into the various RUL files. The extensive expansion of the transit networks with Rush Hour made containing all the network-related data in a single file impractical, and so the data was modularized into separate RUL Files. However, some network related information was left in the Network INI, such as: bridge shadows, Left-Hand Drive path substitution, power lines, and various bug fixes.
  
{{expand}}
+
==References==
[[category:File_Formats]]
+
#[[Network Specs]]
 +
 
 +
 
 +
{{navbox/FORMAT}}
 +
 
 +
[[Category:File Formats/SC4|RUL]]
 +
[[Category:Transit Modding]]

Latest revision as of 02:56, 19 February 2021

RUL Files are internal game files which control the placement of Transit Network items in-game. There are numerous RUL Files used by the game, each of which has its own particular function. There are three different types of RUL Files: Network-Specific RUL Files, Multi-Network RUL Files, and Bridge RULs. In addition, the Network INI file effectively functions like a RUL File. Because the format varies for each type of RUL File, the formats are covered on the individual pages for each RUL File type.

The function of the RUL File is defined by its Instance ID. It is not possible to add new RUL Files, though it is possible to define new Bridge RULs for networks that do not already have them.

Network-Specific RUL Files

Main article: Individual Network RULs

Each in-game network has two Network-Specific RUL Files, one Main RUL which defines the basic placement of the network, and one Supplemental RUL, which defines same-network overrides. There are 24 total Network Specific RULs.

Multi-Network RUL Files

There are three Multi-Network RUL Files, known by their IIDs: RUL 0x10000000 (RUL0), RUL 0x10000001 (RUL1) and RUL 0x10000002 (RUL2). These all handle situations that can involve multiple networks. RUL 0x10000000 is a particularly special case, since it deals exclusively with ploppable network pieces, as opposed to draggable network items. It is the only RUL file to do so. These three RUL files are often grouped in with INI files, for the similarity of their general format, in addition to the Network INI serving a similar purpose to these three RULs.

Type ID Group ID Instance ID Name Description
0x0a5bcf4b 0xaa5bcf57 0x10000000 Intersection Ordering RUL 0x10000000
0x0a5bcf4b 0xaa5bcf57 0x10000001 Intersection Solutions RUL 0x10000001
0x0a5bcf4b 0xaa5bcf57 0x10000002 Network Overrides RUL 0x10000002

Bridge RULs

Main article: Bridge RUL

Bridge RULs contain layout information for complex bridges, and allow for more control over custom bridges. Note that they are not required for all bridges, and not all network types have a corresponding Bridge RUL file.

Network INI

Main article: Network INI

The Network INI file, while technically not a RUL file, combines many functions of the various RUL files. Prior to the release of Rush Hour, this file contained all of the information that would eventually be split into the various RUL files. The extensive expansion of the transit networks with Rush Hour made containing all the network-related data in a single file impractical, and so the data was modularized into separate RUL Files. However, some network related information was left in the Network INI, such as: bridge shadows, Left-Hand Drive path substitution, power lines, and various bug fixes.

References

  1. Network Specs