Difference between revisions of "Item Placement"

From GTAMods Wiki
Jump to navigation Jump to search
(Sections: order based on first appearance)
Line 57: Line 57:
 
=== Sections ===
 
=== Sections ===
  
The following table contains all known sections in the item placement.
+
The following table contains all known sections in the item placement. The supported games column lists games that support the sections but it doesn't necessarily means they're functional in the games. Mouse over the game icons to see if the games are supported.
  
 
{|class="mw-collapsible wikitable center-col-1 center-col-2" style="width: 100%;"
 
{|class="mw-collapsible wikitable center-col-1 center-col-2" style="width: 100%;"
Line 70: Line 70:
 
|[[CULL]]||{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates zones with special behaviour and influences to e.g. [[wikipedia:Non-player_character|NPC's]] or [[timecyc.dat|weather]].
 
|[[CULL]]||{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates zones with special behaviour and influences to e.g. [[wikipedia:Non-player_character|NPC's]] or [[timecyc.dat|weather]].
 
|-
 
|-
|[[PICK]]||{{Icon|SA}} {{Icon|4}}||Creates [[WEAP|weapon]] pickups.
+
|[[PICK]]||<span title="GTA III (not functional)">[[File:Gta3.png|link=|16px|alt=GTA III]]</span> <span title="Vice City (not functional)">[[File:Vc.png|link=|16px|alt=Vice City]]</span> {{Icon|SA}} <span title="GTA IV (not functional)">[[File:GTAIV.png|link=|16px|alt=GTA IV]]</span>||Creates [[WEAP|weapon]] pickups.
 
|-
 
|-
 
|[[PATH]]||{{Icon|VC}}||Creates waypoints for random ''NPC'' spawns.<br>Note: this section is also present in ''San Andreas'' and ''GTA IV''. It is used as a base for ''Rockstar's'' paths compiler, but gets ignored by the games. For more information see: [[Paths]].
 
|[[PATH]]||{{Icon|VC}}||Creates waypoints for random ''NPC'' spawns.<br>Note: this section is also present in ''San Andreas'' and ''GTA IV''. It is used as a base for ''Rockstar's'' paths compiler, but gets ignored by the games. For more information see: [[Paths]].
Line 76: Line 76:
 
|[[OCCL]]||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates occlusion zones for separated rendering.
 
|[[OCCL]]||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates occlusion zones for separated rendering.
 
|-
 
|-
|[[MULT]]||{{Icon|SA}} {{Icon|4}}||&ndash;
+
|[[MULT]]||<span title="San Andreas (not functional)">[[File:Sa.png|link=|16px|alt=San Andreas]]</span> <span title="GTA IV (not functional)">[[File:GTAIV.png|link=|16px|alt=GTA IV]]</span>||&ndash;
 
|-
 
|-
 
|[[GRGE]]||{{Icon|SA}} {{Icon|4}}||Creates zones for in-game garages.
 
|[[GRGE]]||{{Icon|SA}} {{Icon|4}}||Creates zones for in-game garages.
Line 84: Line 84:
 
|[[CARS (IPL Section)|CARS]]||{{Icon|SA}} {{Icon|4}}||Creates [[CARS (IDE Section)|car]] generators.
 
|[[CARS (IPL Section)|CARS]]||{{Icon|SA}} {{Icon|4}}||Creates [[CARS (IDE Section)|car]] generators.
 
|-
 
|-
|[[JUMP]]||{{Icon|SA}} {{Icon|4}}||Creates unique stunt jumps.
+
|[[JUMP]]||{{Icon|SA}} <span title="GTA IV (not functional)">[[File:GTAIV.png|link=|16px|alt=GTA IV]]</span>||Creates unique stunt jumps.
 
|-
 
|-
 
|[[TCYC]]||{{Icon|SA}} {{Icon|4}}||Creates timecycle modifiers.
 
|[[TCYC]]||{{Icon|SA}} {{Icon|4}}||Creates timecycle modifiers.
 
|-
 
|-
|[[AUZO]]||{{Icon|SA}} {{Icon|4}}||Creates zones playing an [[Stream|audio stream]] if the user enters it.
+
|[[AUZO]]||{{Icon|SA}} <span title="GTA IV (not functional)">[[File:GTAIV.png|link=|16px|alt=GTA IV]]</span>||Creates zones playing an [[Stream|audio stream]] if the user enters it.
 
|-
 
|-
 
|[[MZON]]||{{Icon|4}}||&ndash;
 
|[[MZON]]||{{Icon|4}}||&ndash;
Line 96: Line 96:
 
|[[LINK]]||{{Icon|4}}||&ndash;
 
|[[LINK]]||{{Icon|4}}||&ndash;
 
|-
 
|-
|[[BLOK]]||{{Icon|4}}||Apparently ignored by the game &ndash; appears to be used to allocate responsibilities during the development stage of ''GTA IV'', but also could be used to place [[Ped_Event|decision makers]].
+
|[[BLOK]]||<span title="GTA IV (not functional)">[[File:GTAIV.png|link=|16px|alt=GTA IV]]</span>||Apparently ignored by the game &ndash; appears to be used to allocate responsibilities during the development stage of ''GTA IV'', but also could be used to place [[Ped_Event|decision makers]].
 
|-
 
|-
 
|[[MLO+]]||{{Icon|4}}||MLO placement &ndash; Used to place offsets for ''GTA IV's'' [[interior]]s. The ''interiors'' themselfes get placed inside the [[IDE]] file section [[MLO]].
 
|[[MLO+]]||{{Icon|4}}||MLO placement &ndash; Used to place offsets for ''GTA IV's'' [[interior]]s. The ''interiors'' themselfes get placed inside the [[IDE]] file section [[MLO]].

Revision as of 16:17, 12 August 2015

Item Placement
IPL Sections:
2DFX AUZO BLOK CARS CULL ENEX GRGE
INST JUMP LINK LODM MLO+ MULT OCCL
PATH PICK RTFX SLOW TCYC VNOD ZONE

Item placement files, usually identified by the file extension .ipl, are a part of the map system and used to create and place (for example) different objects, zones of special behaviour or paths in the world. All games support standard item placement files which are mostly stored in plain text format that can be opened and edited using any text-editing program (like Notepad), but there are tools to simplify editing. San Andreas is the first game to introduce a binary format for item placement files. Most of the placement information in GTA IV is stored inside of binary files (see WPL).

Overview

The structure and format of the item placement file is similar to the format of the item definition files.

Format and syntax description

Just like definitions, placement information files are split up into sections. Each section is indicated by a section identifier specifying the way the section gets parsed by the game. The sections themselves are filled with the entries containing the placement information. Each entry must be placed on a separate line. This is important for line-dependent entries, like the San Andreas LOD system. The end of every section is indicated by the terminating string "end". Both (identifying and terminating strings) are not case sensitive, but by default they are written in lower case.

Comments are usually indicated by the character # (number sign). It is possible to add comments to the end of a line, but breaking the line format for the current section using comments may cause the game to crash during loading. It is recommended that a comment should be placed on a separate line. Comments can also be placed outside of sections.

Lines itself are always formatted in the same way differing only in the number of their parameters describing the semantical content of the line. Parameters are usually separated by the character , (comma). Whitespace characters at the beginning or the end of an parameter get trimmed but they are usually used to give the content a more clear structure to make it more easier to read for human. Strings can be encased by the character " (quotation mark), but this is optional and rarely used by default. Also the games' parser uses an invariant culture to parse numerical values and strings. Which means strings are ASCII encrypted and the decimal separator is . (period).

Section example

inst
...
end

Binary format

San Andreas introduced an simple binary format of item placement files. They are stored as "streaming files" inside the archive files. Editing them requires an special editor (see below). The format is pretty simple and their possibilities are not completely used by Rockstar. By default they do only support INST and CARS sections. It is unconfirmed if other sections also can be used or if they are just stubs which are not implemented. Anyway their binary format is completely unknown.

This section is incomplete. You can help by fixing and expanding it.

Header

Each binary placement information file starts with an 4-Byte identifier followed by a header containing information about the files content.

4b  - CHAR[4]   - Always "bnry"
4b  - INT32     - Number of item instances
4b  - INT32     - Number of unknown 1 (CULL ?)
4b  - INT32     - Number of unknown 2 (GRGE ?)
4b  - INT32     - Number of unknown 3 (ENEX ?)
4b  - INT32     - Number of parked cars
4b  - INT32     - Number of unknown 4 (PICK ?)
4b  - INT32     - Offset of item instances (0x4C by default)
4b  - INT32     - Size of item instances (unused - always 0)
4b  - INT32     - Offset of unknown 1
4b  - INT32     - Size of unknown 1 (unused - always 0)
4b  - INT32     - Offset of unknown 2
4b  - INT32     - Size of unknown 2 (unused - always 0)
4b  - INT32     - Offset of unknown 3
4b  - INT32     - Size of unknown 3 (unused - always 0)
4b  - INT32     - Offset of parked cars
4b  - INT32     - Size of parked cars (unused - always 0)
4b  - INT32     - Offset of unknown 4
4b  - INT32     - Size of unknown 4 (unused - always 0)

The header is followed by the arrays of the entries. For more information about their format see the articles about the sections.

Sections

The following table contains all known sections in the item placement. The supported games column lists games that support the sections but it doesn't necessarily means they're functional in the games. Mouse over the game icons to see if the games are supported.

Identifier Supported games Description
INST GTA III Vice City San Andreas GTA IV Most important section: places objects defined in OBJS, TOBJ, ANIM or TANM in the world.
ZONE GTA III Vice City San Andreas GTA IV Creates ingame regions.
CULL GTA III Vice City San Andreas GTA IV Creates zones with special behaviour and influences to e.g. NPC's or weather.
PICK GTA III Vice City San Andreas GTA IV Creates weapon pickups.
PATH Vice City Creates waypoints for random NPC spawns.
Note: this section is also present in San Andreas and GTA IV. It is used as a base for Rockstar's paths compiler, but gets ignored by the games. For more information see: Paths.
OCCL Vice City San Andreas GTA IV Creates occlusion zones for separated rendering.
MULT San Andreas GTA IV
GRGE San Andreas GTA IV Creates zones for in-game garages.
ENEX San Andreas GTA IV Creates entrance and exit markers.
CARS San Andreas GTA IV Creates car generators.
JUMP San Andreas GTA IV Creates unique stunt jumps.
TCYC San Andreas GTA IV Creates timecycle modifiers.
AUZO San Andreas GTA IV Creates zones playing an audio stream if the user enters it.
MZON GTA IV
VNOD GTA IV Extended format of PATH – apparently only used for multiplayer mode.
LINK GTA IV
BLOK GTA IV Apparently ignored by the game – appears to be used to allocate responsibilities during the development stage of GTA IV, but also could be used to place decision makers.
MLO+ GTA IV MLO placement – Used to place offsets for GTA IV's interiors. The interiors themselfes get placed inside the IDE file section MLO.
2DFX GTA IV Used to make many game effects, for example - Particle.
LODM GTA IV
SLOW GTA IV Unknown for what it is responsible, used very rare and only in two extended .WPL. Section contains a box.

Tools

See also

External links