Editing Pikmin 2 waterboxes

Jump to navigation Jump to search

Warning: You are not logged in. Your IP address will be publicly visible if you make any edits. If you log in or create an account, your edits will be attributed to your username, along with other benefits.

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.

Latest revision Your text
Line 1: Line 1:
 
[[File:Pikmin_water_hack.png|300px|thumb|right|Water modified in the ''Awakening Wood'']]
 
[[File:Pikmin_water_hack.png|300px|thumb|right|Water modified in the ''Awakening Wood'']]
−
<code>waterbox.txt</code> hold x, y and z coordinates that tell the game where to draw a waterbox in 3D space. These files are typically located in <code>texts.szs</code> archives such as <code>user/kando/map/*/texts.szs/waterbox.txt</code>. Each body of water is defined to be in the shape of a [[wikipedia:Cuboid|cuboid]].
+
Waterboxes are text files that control where water is placed in an area. They are located in <code>user/kando/map/*/texts.szs/waterbox.txt</code>. Each body of water is defined by a [[wikipedia:Cuboid|cuboid]].
  
 
==Format==
 
==Format==
 
===Header===
 
===Header===
−
Each file start with a version number on line 1, commented with <code>#type</code>, {{unsure|it is unknown how this may affect the parsing of the file or effect on the waterboxes themselves.}}.
+
Waterbox files start with a number, commented with <code>type</code>, {{unsure|whose meaning is unknown}}.
  
−
On line 2, it has a comment of <code>#CNode</code> as a label of the array that starts on line 3.
+
Then, the list of boxes starts after the line commented with <code>CNode</code>, and is defined inside curly braces. Each body of water is defined in one line.
  
−
Line 3 starts the array with a single bracket, where the first piece of data (line 4) holds the total number of waterbox coordinates it contains.
+
The very first line of the list of boxes indicates how many there are in total.
  
−
===Waterbox===
+
===Box===
−
{{note|Be wary that the positional values used for waterboxes will be based around the centerpoint of the model it's found under. Waterboxes used in cave units should ideally be measured within the model particularly in cave units that can spawn plentifully (eg. hallways, corner turns, intersections) as large waterboxes can clip into cave units that don't have waterboxes defined. If you plan on using a waterbox that covers an entire generated cave, use a single room as a candidate to hold a single large waterbox that extends throughout the cave. As reference caves units shouldn't typically generate past 3,000 units in the x and y directions.}}
+
The boxes are defined by two 3D points. You can think of this like the first point being the "top-left-front" point, and the other to be the "bottom-right-back" point. In the list inside the file, each box is one line long, and consists of 6 space-separated numbers. The first number is the X coordinate of the first point, the second number is the Y coordinate of the first point, etc. So, the format is basically <code>X1 Y1 Z1 X2 Y2 Z2</code>.
−
The array defines the waterbox as two sets of coordinate points with x, y and z positional values stored as floats. The game will draw a waterbox that fills the area between the two points defined. The format of the data that stores these values is <code><X1> <Y1> <Z1> <X2> <Y2> <Z2></code>.
 
  
−
In the vanilla files each waterbox coordinates are commented with an identification number (starts at 0), and the total number of boxes (e.g. <code># 2/4</code>). Comments aren't necessary and are never parsed. They are simply just labels to help track and organize data.
+
Each line also has a comment at the end with the number of the box (starts at 0), and the total number of boxes (e.g. <code>2/4</code>). These comments are optional, though.
  
 
==Example==
 
==Example==
Line 20: Line 19:
  
 
{| class="wikitable"
 
{| class="wikitable"
−
! File line|| Data || Line explanation  
+
! File line || Line explanation
 
|-
 
|-
−
| 1 ||<pre>0 # type</pre> || Version type of waterbox file. {{unsure|Meaning is unknown.}}
+
| <pre>0 # type</pre> || Type of waterbox file. {{unsure|Meaning is unknown.}}
 
|-
 
|-
−
| 2 ||<pre># CNode</pre> || Comment, presumably the label of the array
+
| <pre># CNode</pre> ||
 
|-
 
|-
−
| 3 ||<pre>{</pre> || Start of array
+
| <pre>{</pre> || Start of the list of boxes.
 
|-
 
|-
−
| 4 ||<pre> 2 </pre> || First value of the array will always hold the total number of waterboxes.
+
| <pre> 2 </pre> || Total number of boxes.
 
|-
 
|-
−
| 5 ||<pre> -3700.000000 -110.000000 850.000000 -2500.000000 -10.000000 1650.000000 # 0/2</pre> || The set of x, y, and z positional values of the first waterbox. The first set is for the bottom left back of the cuboid, and the second is for the top right front.
+
| <pre> -3700.000000 -110.000000 850.000000 -2500.000000 -10.000000 1650.000000 # 0/2</pre> || <code>X1 Y1 Z1 X2 Y2 Z2</code> of the first box.
 
|-
 
|-
−
| 6 ||<pre> -2000.000000 -90.000000 50.000000 -1000.000000 10.000000 1450.000000 # 1/2</pre> || Ditto for second waterbox.
+
| <pre> -2000.000000 -90.000000 50.000000 -1000.000000 10.000000 1450.000000 # 1/2</pre> || <code>X1 Y1 Z1 X2 Y2 Z2</code> of the second box.
 
|-
 
|-
−
| 7 ||<pre>}</pre> || End of array.
+
| <pre>}</pre> || End of the list of boxes.
 
|}
 
|}
−
 
−
Notes: While the water will still appear and be animated, if the Y1-Y2 distance (or depth) isn't large enough then it will not behave like water. One would assume the depth must be 100 units, based on the two given examples.
 
  
 
[[Category:Pikmin 2]]
 
[[Category:Pikmin 2]]
 
[[Category:File formats]]
 
[[Category:File formats]]

Please note that all contributions to Pikmin Technical Knowledge Base are considered to be released under the Creative Commons Attribution-ShareAlike (see Pikmin Technical Knowledge Base:Copyrights for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource. Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel Editing help (opens in new window)

Templates used on this page:

Retrieved from "https://pikmintkb.com/wiki/Pikmin_2_waterboxes"