Difference between revisions of "Cave unit definition file"

From Pikmin Technical Knowledge Base
Jump to navigation Jump to search
(Undo: That makes no sense.)
Line 6: Line 6:
 
==Unit==
 
==Unit==
  
−
'''Line 1:''' The version of the block's data format, this is always 1. For example, <code>1 # version</code>
+
{| class="wikitable sortable"
 +
|-
 +
! Line || Example || Description || Comment
 +
|-
 +
| 1 || <code>{</code> || Open unit entry || No comment
 +
|-
 +
| 2 || <code>1</code> || Version || <code>version</code>
 +
|-
 +
| 3 || <code>room_ike1_2_tsuchi</code> || Folder name of the unit to spawn || <code>foldername</code>
 +
|-
 +
| 4 || <code>7 6</code> || Width (7) and height (6) of the unit that's spawning (line 3); defines how many cave grid cells this unit || <code>dX/dZ ; cell size</code>
 +
|-
 +
| 5 || <code>1</code> || Room type: 0=dead end, 1=room, 2=hallway || <code>room type</code>
 +
|-
 +
| 6 || <code>0 1</code> || The unit's flags; {{unknown}} || <code>room Flags</code>
 +
|-
 +
| 7 || <code>2</code> || The number of doors (exits) the unit has || <code>num doors</code>
 +
|}
  
−
'''Line 2:''' The internal name of the unit. For example, <code>room_block1_3_tsuchi # foldername</code>.
+
From this point onwards, before ending the unit entry, there are four lines for each door sub-entry.
 +
{| class="wikitable sortable"
 +
|-
 +
! Line || Example || Description || Comment
 +
|-
 +
| 1 || <code>0</code> || Door index || <code>index</code>
 +
|-
 +
| 2 || <code>0 0 0</code> || Direction, offset, and wpindex {{unsure}} || <code>dir/offs/wpindex</code>
 +
|-
 +
| 3 || <code>1</code> || The number of doors this can link to || <code>door links</code>
 +
|}
  
−
'''Line 3:''' Consisting of two numbers, this defines how many cave grid cells this unit takes up. The first number is for the length in X, the second for the length in Z (y-up). Basically, this means "this unit is X by Z units big". For example, <code>4 4 # dX/dZ ; cell size</code>.
+
From this point onwards, before ending the door sub-entry, there is one line for each door link.
−
 
+
{| class="wikitable sortable"
−
'''Line 4:''' The type of unit this is. <code>0</code> is a dead end, <code>1</code> is a room, and <code>2</code> is a corridor.
+
|-
−
 
+
! Line || Example || Description || Comment
−
'''Line 5:''' The unit's flags. For example, <code>0 1 # room Flags</code>.
+
|-
−
{{todo|Document the unit's flags.}}
+
| 1 || <code>1258.716064 0 1</code> || Distance, door ID, and tekiflag || <code>dist/door-id/tekiflag</code>
−
 
+
|}
−
'''Line 6:''' This indicates how many exits this unit has. For example, <code>4 # num doors</code>.
 
−
 
 
−
===Exits===
 
−
 
 
−
'''Line 1:''' The exit's index, starting from 0. For example, <code>0 # index</code>
 
−
 
 
−
'''Line 2:''' The first of three numbers - <code>dirs</code> - is the direction of the room and player. For example, in the Emergence Cave the direction is <code>2</code>, for all other rooms to connect they must also be <code>2</code>. This value is ''currently'' useless because all rooms must be the same value for them to connect to each other. The player will always face this direction (the camera will oppose), which in a single-door room (any room name with "_1" before the room type) is always towards the next room.
 
  
 
{{todo|Offs and wp index need to be documented}}
 
{{todo|Offs and wp index need to be documented}}

Revision as of 12:06, 15 April 2019

In Pikmin 2, each sublevel points to a cave unit definition file. These files can be found in /user/Mukki/mapunits/units, and contain a list of units that the game is allowed to use to create the cave with. This file just tells the generator how each cave unit attaches with one another. In other words, this file specifies all the rooms to spawn in a sublevel, depending on that sublevel's room count ({f005}).

Header

After a decorated set of comments that say units definition file comes a line containing the number of units defined in this file. This line is commented with number of units. Each unit's data is defined inside its own block, and conveniently has a comment before it that mentions its name.

Unit

Line Example Description Comment
1 { Open unit entry No comment
2 1 Version version
3 room_ike1_2_tsuchi Folder name of the unit to spawn foldername
4 7 6 Width (7) and height (6) of the unit that's spawning (line 3); defines how many cave grid cells this unit dX/dZ ; cell size
5 1 Room type: 0=dead end, 1=room, 2=hallway room type
6 0 1 The unit's flags; Unknown[unsure] room Flags
7 2 The number of doors (exits) the unit has num doors

From this point onwards, before ending the unit entry, there are four lines for each door sub-entry.

Line Example Description Comment
1 0 Door index index
2 0 0 0 Direction, offset, and wpindex Unknown[unsure] dir/offs/wpindex
3 1 The number of doors this can link to door links

From this point onwards, before ending the door sub-entry, there is one line for each door link.

Line Example Description Comment
1 1258.716064 0 1 Distance, door ID, and tekiflag dist/door-id/tekiflag


To do: Offs and wp index need to be documented

An example of dirs set on 3 while all other room dirs are set on 2.

Line 3: The number of door links. For example, 2 # door links.

Line 4(+): Ddst/door-id/tekiflag; there are as many lines for these three numbers as there are door links (specified in line 3). For example, 849.951904 1 1 # dist/door-id/tekiflag.

Credits: Jimble, Kai-Kai
Retrieved from "https://pikmintkb.com/w/index.php?title=Cave_unit_definition_file&oldid=2477"