Cave unit definition file

From Pikmin Technical Knowledge Base
Revision as of 16:00, 14 August 2024 by Vic (talk | contribs) (Added table of contents.)
Jump to navigation Jump to search

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 1 Version version
2 room_ike1_2_tsuchi Folder name of the unit to spawn foldername
3 7 6 Width (7) and length (6) of the unit that's spawning (line 3); defines how many cave grid cells this unit dX/dZ ; cell size
4 1 Room type: 0=dead end, 1=room, 2=hallway room type
5 0 1 The unit's "room" flags. Judging by the name, and how most of the "room" type units have it set to 1, it's presumed to help count the room units as... well, rooms and not hallways or dead ends. Changing it to anything other than 1, or 0 for the non-room units, doesn't seem to do anything though. room Flags
6 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 (starting from the left, determines how many cells to the right the door is), and wpindex (The index of the route waypoint for that door) 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 (used within score calculation), Door-id (Maps to another door index), and tekiflag Unknown[unsure] dist/door-id/tekiflag

File list

This is a list of unit definition files, their theme and what units they contain.

File Theme Units (text) Units (images)
1_ABE_ari_metal.txt
Metal
cap_metal, item_cap_metal,
way3_metal, way4_metal,
wayl_metal, way2_metal,
way2x2_metal, room_ari1_3_metal
P2CU cap metal.jpg P2CU item cap metal.jpg P2CU way3 metal.jpg P2CU way4 metal.jpg P2CU wayl metal.jpg P2CU way2 metal.jpg P2CU way2x2 metal.jpg P2CU room ari1 3 metal.jpg
TBA
TBA
TBA TBA
Credits: Jimble, Kai