Item Placement

From GTAModding
Jump to: navigation, search
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).

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

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 basic information about all known sections. For additional information read the articles itself.

Identifier Supported games Description
INST
GTA III Vice City San Andreas GTA 4
Most important section: places objects defined in OBJS, TOBJ, ANIM or TANM in the world.
CULL
GTA III Vice City San Andreas GTA 4
Creates zones with special behaviour and influences to e.g. NPC's or weather.
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.
GRGE
San Andreas
Creates zones for ingame garages.
ENEX
San Andreas
Creates entrace and exit markers.
PICK
San Andreas
Creates weapon pickups.
JUMP
San Andreas
Creates unique stunt jumps.
TCYC
San Andreas
Apparently custom weather.
AUZO
San Andreas
Creates zones playing an audio stream if the user enters it.
MULT
San Andreas GTA 4
CARS
San Andreas
Creates parked car spawns
OCCL
Vice City San Andreas GTA 4
Creates occlusion zones for seperated rendering.
ZONE, MZON
GTA III Vice City San Andreas GTA 4
Creates ingame regions. MZON is only used for GTA IV and contains one type of zones.
BLOK
GTA 4
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.
VNOD
GTA 4
Extented format of PATH – apparently only used for multiplayer mode.
LINK
GTA 4
MLO+
GTA 4
MLO placement – Used to place offsets for GTA IV's interiors. The interiors themselfes get placed inside the IDE file section MLO.
RTFX
GTA 4
LODM
GTA 4
SLOW
GTA 4
Unknown for what it is responsible, used very rare and only in two extended .WPL. Section contains a box.
2DFX
GTA 4
Used to make many game effects, for example - Particle.

Tools

See also

External links

v · d · e
GTA 4 Grand Theft Auto IV
File Formats.dat.gxt.ide.img.ipl.nod.sco.rpf.rrr.wad.wbd/.wbn.wdd.wdr.wft.whm.wpl.wtd
DocumentationAudioBink VideoCryptographyCutscenesImage listingMap ListingNative functionsPathsScenariosSavesVTableWeapons
ToolsASI LoaderENBSeriesG-TextureGIMSIV NeedleOpenIVScoclSparkIVXLiveLessWPL ManagerX Mod Installer
AliceC++ Script Hook.NET Script Hook
TutorialsImporting Textures with OpenIVImporting Textures with SparkIV
MultiplayerFour MultiplayerIV MultiplayerIV:Online
ModificationsGTA 3 HD RageGTA Vice City RageIV:SAGostown IV
Useful linksCommunity portalDiscussion forumsGTA IV Modding ForumMods on GTAGarage.com
v · d · e
San Andreas Grand Theft Auto: San Andreas
File Formats.col.cfg.cut.dff.dat.fxp.gxt.ide.ifp.img.iplnodes*.dat.rep.rrr.scm.set.txd
DocumentationAudioCryptographyCutscenesGame memoryHandling.cfgMap ListingMission PacksOpcodesPathsReplaysSavesScripts
ToolsCLEOCollision File Editor IIENBSeriesG-ToolsIMG ToolLimit AdjusterMap EditorSan Andreas Audio ToolkitSanny BuilderTXD Workshop
TutorialsSan Andreas v2.0 ModdingHow to create a missionHow to create a threadHow to use Map Editor
ModificationsDesign Your Own MissionGostown ParadiseGTA: UnitedMyriad Islands
MultiplayergtaTournamentMulti Theft AutoSan Andreas Multiplayer(more...)
Useful linksCommunity portalDiscussion forumsMods on GTAGarage.comOpcodes database
v · d · e
Vice City Grand Theft Auto: Vice City
File Formats.adf.col.cfg.dff.dat.gxt.ide.ifp.img/.dir.ipl.raw/.sdt.rep.scm.txd
DocumentationHandlingMap ListingOpcodesScript PathsSavesSound Effects
ToolsCLEOCollision File Editor IIG-ToolsGXT EditorIMG ToolLimit AdjusterKEd (map editor)Sanny Builder (script editor)TXD Workshop
TutorialsHow to create a missionHow to create a thread
ModificationsGTA: Liberty CityState of Liberty
MultiplayerGTA:LC MultiplayergtaTournamentMulti Theft AutoState Of Liberty OnlineVice City MultiplayerVice City OnlineMulti-Vice
Useful linksCommunity portalDiscussion forumsMods on GTAGarage.comModding VC Mobile versionOpcodes database
v · d · e
GTA III Grand Theft Auto III
File Formats.col.cfg.dff.dat.gxt.ide.ifp.img.ipl.scm.txd
DocumentationAudioHandling.cfgMap ListingOpcodesPaths
ToolsCLEOCollision File Editor IIG-ToolsIMG ToolMap EditorSanny BuilderTXD WorkshopWater Editor
TutorialsHow to create a missionHow to create a threadHow to use Map Editor
ModificationsCurbshireReal GTAUltimate Stunt ParkIntercity Highway
MultiplayerLiberty UnleashedMulti Theft AutoMore...
Useful linksCommunity portalDiscussion forumsMods on GTAGarage.comModding GTA 3 Mobile versionOpcodes database
Personal tools