Pikmin labeled parameter file

From Pikmin Technical Knowledge Base
Jump to: navigation, search
Parameters and labels inside a file.
Labels for parsing Pom's local parameters inside of the DOL header.
Parameters and labels inside memory during gameplay.

Labeled parameter files are the most common form of parameter storage in Pikmin by application (though not necessarily by quantity).

Rules[edit]

Values in labeled parameter files are preceeded by a Label (e.g. s00, p14, b03, x99, i40, etc.).

Distinct Parameters Groups within labeled parameter files (i.e. global, shared, and local) are terminated by a Null Byte Partition.

Parsing information for labeled parameter files can be found embedded in the DOL header. Changing the labels here changes what is sought after by the parser.

The order of parameters in labeled parameter files does not matter. When an instance of a label is encountered by the parser, it fills the memory address sharing the label with the value.

  • It is perfectly valid for a label to be absent from a labeled parameter file. In this case, the value will instead be set to a default decided on by the developers.
    • These default values technically can be found embedded in the DOL header, but they are stored in a sort of primordial soup from compiling. Which values belong to which parameters is currently a mystery.

It is also perfectly acceptable for a labeled parameter file to be completely absent from the filesystem. In this case, every parameter will be left at its default.

  • This suggests that the purpose of labeled parameter file is to overwrite values set during initialization of memory.
    • This, in turn, suggests that the default values are the earliest revision of all parameter values.

As a rule of thumb, the first character of a label can often indicate what type of value a parameter is.

  • i-- and x-- labels often denote an integer parameter or, less often, a boolean parameter.
  • s-- labels are typically reserved for Global Parms groups, and often denote an IEEE-754 floating point decimal parameter.
  • p-- labels often denote an IEEE-754 floating point decimal parameter.
  • Other letters of the alphabet (when used) often denote an IEEE-754 floating point decimal parameter.

Rarely, a parameter label does not follow the numbered character system and instead resorts to labels such as "spd" or "new".

Vocabulary[edit]

Label: A string word preceeding a parameter value word.

Null Byte Partition: A word of nothing but Null Bytes (0xFF). Communicates the termination of a Distinct Parameters Group to the parser.

Distinct Parameters Group: A collection of labeled parameters terminated by a Null Byte Partition.

Global Parms: A Distinct Parameters Group that is used by many similar and different types of objects across the game engine. They are:

  • s00: friction
  • s01: wallReflection
  • s02: faceDirAdjust
  • s03: accel
  • s04: bounceFactor

Shared Parms: A Distinct Parameters Group that is used by many similar types of objects in the game engine. Bosses have these. Tekis imitate this, though they use unlabeled parameter files.

Local Parms: A Distinct Parameters Group that is only used by one object in the game engine. Most parameter files use this Distinct Parameters Group alone.

Credits: Minty_Meeo