Difference between revisions of "Item Placement"
(syntax same as IDE) |
(lowercase section names) |
||
Line 14: | Line 14: | ||
=== Binary format === | === Binary format === | ||
− | ''San Andreas'' introduced an simple binary format of item placement files. They are stored as ''"streaming files"'' inside the [[IMG|archive files]]. Editing them requires an special editor (see [[IPL#Tools|below]]). The format is pretty simple and their possibilities are not completely used by ''Rockstar''. By default they do only support | + | ''San Andreas'' introduced an simple binary format of item placement files. They are stored as ''"streaming files"'' inside the [[IMG|archive files]]. Editing them requires an special editor (see [[IPL#Tools|below]]). The format is pretty simple and their possibilities are not completely used by ''Rockstar''. By default they do only support <code>inst</code> and <code>cars</code> 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. |
{{Incomplete}} | {{Incomplete}} | ||
Line 54: | Line 54: | ||
!Description | !Description | ||
|- | |- | ||
− | |[[INST]]||{{Icon| | + | |<code>[[INST|inst]]</code>||{{Icon|t}} {{Icon|4}}||Places objects defined in <code>[[OBJS|objs]]</code>, <code>[[TOBJ|tobj]]</code>, <code>[[ANIM|anim]]</code>, or <code>[[TANM|tanm]]</code> into the world. |
|- | |- | ||
− | |[[ZONE]]||{{Icon| | + | |<code>[[ZONE|zone]]</code>||{{Icon|t}} {{Icon|4}}||Creates map, navigation, and info zones. |
|- | |- | ||
− | |[[CULL]]||{{Icon| | + | |<code>[[CULL|cull]]</code>||{{Icon|t}} {{Icon|4}}||Creates zones with special attributes. |
|- | |- | ||
− | |[[PICK]]||{{Icon|3|16||GTA III (not functional)}} {{Icon|VC|16||Vice City (not functional)}} {{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates | + | |<code>[[PICK|pick]]</code>||{{Icon|3|16||GTA III (not functional)}} {{Icon|VC|16||Vice City (not functional)}} {{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates 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]]. | + | |<code>[[PATH|path]]</code>||{{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]]. |
|- | |- | ||
− | |[[OCCL]]||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates occlusion zones | + | |<code>[[OCCL|occl]]</code>||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates occlusion zones. |
|- | |- | ||
− | |[[MULT]]||{{Icon|SA|16||San Andreas (not functional)}} {{Icon|4|16||GTA IV (not functional)}}||– | + | |<code>[[MULT|mult]]</code>||{{Icon|SA|16||San Andreas (not functional)}} {{Icon|4|16||GTA IV (not functional)}}||– |
|- | |- | ||
− | |[[GRGE]]||{{Icon|SA}} {{Icon|4}}||Creates | + | |<code>[[GRGE|grge]]</code>||{{Icon|SA}} {{Icon|4}}||Creates garages. |
|- | |- | ||
− | |[[ENEX]]||{{Icon|SA}} {{Icon|4}}||Creates | + | |<code>[[ENEX|enex]]</code>||{{Icon|SA}} {{Icon|4}}||Creates entry-exit markers. |
|- | |- | ||
− | |[[CARS (IPL Section)| | + | |<code>[[CARS (IPL Section)|cars]]</code>||{{Icon|SA}} {{Icon|4}}||Creates car generators (parked cars). |
|- | |- | ||
− | |[[JUMP]]||{{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates | + | |<code>[[JUMP|jump]]</code>||{{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates stunt jumps. |
|- | |- | ||
− | |[[TCYC]]||{{Icon|SA}} {{Icon|4}}||Creates | + | |<code>[[TCYC|tcyc]]</code>||{{Icon|SA}} {{Icon|4}}||Creates time cycles modifiers. |
|- | |- | ||
− | |[[AUZO]]||{{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates | + | |<code>[[AUZO|auzo]]</code>||{{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates [[Stream|audio]] zones. |
|- | |- | ||
− | |[[MZON]]||{{Icon|4}}||– | + | |<code>[[MZON|mzon]]</code>||{{Icon|4}}||– |
|- | |- | ||
− | |[[VNOD]]||{{Icon|4}}||Extended format of | + | |<code>[[VNOD|vnod]]</code>||{{Icon|4}}||Extended format of <code>path</code> – apparently only used for [[Multiplayer#GTA_4|multiplayer]] mode. |
|- | |- | ||
− | |[[LINK]]||{{Icon|4}}||– | + | |<code>[[LINK|link]]</code>||{{Icon|4}}||– |
|- | |- | ||
− | |[[BLOK]]||{{Icon|4|16||GTA IV (not functional)}}||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 [[Ped_Event|decision makers]]. | + | |<code>[[BLOK|blok]]</code>||{{Icon|4|16||GTA IV (not functional)}}||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 [[Ped_Event|decision makers]]. |
|- | |- | ||
− | |[[MLO+]]||{{Icon|4}}|| | + | |<code>[[MLO+|mlo+]]</code>||{{Icon|4}}||<code>mlo</code> placement – Used to place offsets for ''GTA IV's'' [[interior]]s. The ''interiors'' themselves get placed inside the [[IDE]] file section <code>[[MLO|mlo]]</code>. |
|- | |- | ||
− | |[[2DFX (IPL Section)| | + | |<code>[[2DFX (IPL Section)|2dfx]]</code>||{{Icon|4}}||Used to make many game effects, for example - Particle. |
|- | |- | ||
− | |[[LODM]]||{{Icon|4}}||– | + | |<code>[[LODM|lodm]]</code>||{{Icon|4}}||– |
|- | |- | ||
− | |[[SLOW]]||{{Icon|4}}||Unknown for what it is responsible, used very rare and only in two extended .WPL. Section contains a box. | + | |<code>[[SLOW|slow]]</code>||{{Icon|4}}||Unknown for what it is responsible, used very rare and only in two extended .WPL. Section contains a box. |
− | <!--|[[RTFX]]||{{Icon|4}}||–--> | + | <!--|[[RTFX|rtfx]]||{{Icon|4}}||–--> |
|} | |} | ||
Revision as of 06:51, 1 September 2017
IPL Sections:
|
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).
Contents
Overview
The structure and format of the item placement file is similar to the format of the item definition files.
Format and syntax description
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 |
Places objects defined in objs , tobj , anim , or tanm into the world.
| |
zone |
Creates map, navigation, and info zones. | |
cull |
Creates zones with special attributes. | |
pick |
Creates pickups. | |
path |
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 |
Creates occlusion zones. | |
mult |
– | |
grge |
Creates garages. | |
enex |
Creates entry-exit markers. | |
cars |
Creates car generators (parked cars). | |
jump |
Creates stunt jumps. | |
tcyc |
Creates time cycles modifiers. | |
auzo |
Creates audio zones. | |
mzon |
– | |
vnod |
Extended format of path – apparently only used for multiplayer mode.
| |
link |
– | |
blok |
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+ |
mlo placement – Used to place offsets for GTA IV's interiors. The interiors themselves get placed inside the IDE file section mlo .
| |
2dfx |
Used to make many game effects, for example - Particle. | |
lodm |
– | |
slow |
Unknown for what it is responsible, used very rare and only in two extended .WPL. Section contains a box. |
Tools
- KEd – By JernejL
- MEd – By Tonywob
- GTAForums: IPL Helper – By Xmen
- Binary (De-)Compiler – By ocram88
- GTAForums: SA Binary IPL Exporter for 3DS Max – by Gforce
See also
- Item definition
- WPL – Major GTA IV item placement file.
External links
- GTAForums: GTA3/VC Map File Documentation and Troubleshooting - Topic by Opius covering general features of IPL files in GTA3 and GTA VC.
- GTAForums: GTA SA IPL Documentation - Topic by spaceeinstein covering details of the IPL format in GTA SA.
Grand Theft Auto IV | |
---|---|
File Formats | .dat • .gxt • .ide • .img • .ipl • .nod • .sco • .rpf • .rrr • .wad • .wbd/.wbn • .wdd • .wdr • .wft • .whm • .wpl • .wtd |
Documentation | Audio • Bink Video • Cryptography • Cutscenes • GXT Text • Image listing • Keycodes • Map Listing • Native functions • Paths • Radar Blips • Radio Stations • Saves • Scenarios • VTable • Weapons |
Tools | ASI Loader • ENBSeries • G-Texture • GIMS IV • Ingame WPL Editor • IV Needle • OpenIV • SparkIV • XLiveLess • WPL Manager • X Mod Installer Alice • C++ Script Hook • .NET Script Hook • Scocl |
Tutorials | Importing Textures with OpenIV • Importing Textures with SparkIV |
Modifications | GTA Connected • Gostown IV • Four Multiplayer • IV Multiplayer • CitizenMP:IV Reloaded |
Useful links | Community portal • Discussion forums • Modding forums • Mods on GTAGarage.com |