Difference between revisions of "Item Placement"

From GTAMods Wiki
Jump to navigation Jump to search
m
 
(90 intermediate revisions by 13 users not shown)
Line 1: Line 1:
==Introduction==
+
{{IplSection
'''I'''tem '''PL'''acement ('''.ipl''') files are used to place objects into gta world, this includes objects, zones and paths.
+
| noheader=1
 +
}}
 +
'''Item placement''' files, usually identified by the file extension <code>.ipl</code>, are a part of the [[map system]] and used to create and place (for example) different objects, zones of special behavior 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 [[Wikipedia:Notepad|Notepad]]), but there are tools to simplify editing of the newly introduced Binary Ipl in [[GTA SA|San Andreas]]. Most of the placement information in [[GTA IV]] is stored inside of binary files (see [[WPL]]).
  
==Structure==
+
== Text Format ==
The .ipl files are split up into many sections. How many of them you use in your file is optional, they can even be empty. Each section starts with a section identifier and ends with the keyword "end", both in a single line.
 
  
Example:
+
The structure and format of the plain text item placement files are similar to that of the [[item definition]] files. The game searches for these files in [[Gta.dat|gta.dat]].They allow comments by the character <code>#</code>.Lines starting with this character simply get ignored by the game & empty lines are also allowed. Since these files contain different types of data a keyword is required for the game to recognize each set of data.
  inst
+
  <keyword>
  ...
+
  *lines*
  end
+
  end
 +
More information about these keywords can be found below in the <code>Fomats</code> section.
 +
 
 +
:''See also: [[Item Definition#Overview|Item Definition &sect; Overview]]''
 +
 
 +
 
 +
== Binary Format ==
 +
 
 +
''San Andreas'' introduced a 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}}
 +
<!--- How do binary IPLs get recognized by the game? --->
 +
 
 +
==== Header ====
 +
 
 +
Each binary placement information file starts with a 4-Byte identifier followed by a header containing information about the content of the files.
 +
 
 +
4b  - CHAR[4]  - Always "bnry"
 +
4b  - INT32    - Number of [[INST|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 [[CARS|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.INST arrays have a size of 40 bytes per structure, and cars have 48 bytes.
 +
 
 +
=== INST ===
 +
 
 +
4b  - FLOAT    - Position X
 +
4b  - FLOAT    - Position Y
 +
4b  - FLOAT    - Position Z
 +
4b  - FLOAT    - Rotation X
 +
4b  - FLOAT    - Rotation Y
 +
4b  - FLOAT    - Rotation Z
 +
4b  - FLOAT    - Rotation W
 +
4b  - INT32    - Object ID (as an index to the ''IDE'')
 +
4b  - INT32    - Interior
 +
4b  - INT32    - ''LOD'' index
 +
 
 +
=== CARS ===
 +
''CARS'' is one of the known sections which can be used in binary format inside streaming files. It's format is similar to the plain text format:
 +
 
 +
4b  - FLOAT    - Position X
 +
4b  - FLOAT    - Position Y
 +
4b  - FLOAT    - Position Z
 +
4b  - FLOAT    - Angle (Around Z-Axis)
 +
4b  - INT32    - Object ID (an index to an [[CARS_(IDE_Section)|vehicle definition]])
 +
4b  - INT32    - Primary color
 +
4b  - INT32    - Secondary color
 +
4b  - INT32    - Force spawn (Windows BOOL - see ''<code>WinDef.h</code>'')
 +
  4b  - INT32    - Alarm probability
 +
4b  - INT32    - Locked probability
 +
4b  - INT32    - Unknown1 (Could be tertiary color)
 +
4b  - INT32    - Unknown2 (Could be quarterdeck color)
 +
 
 +
'''Load a custom file'''
  
===INST===
+
A basic comparison between a normal <code>.ipl</code> and a binary <code>.ipl</code>.
Positions of static and dynamic ([[object.dat]]) map objects.
 
  
'''GTA3 format:'''
+
'''Normal:'''
  id, name, x, y, z, sx, sy, sz, rx, ry, rz, rw
+
  15072, PLS_carpark, 0, 2579.8796445, 645.50208432, 9.93, 0, 0, 0, 1, -1
  
'''GTAVC format:'''
+
'''Binary:'''
  id, name, int, x, y, z, sx, sy, sz, rx, ry, rz, rw
+
  15072, dummy, 0, 2579.8796445, 645.50208432, 9.93, 0, 0, 0, 1, -1
  
'''GTASA format:'''
+
The object name is basically ignored in <code>.ipl</code>
id, name, int, x, y, z, rx, ry, rz, rw lod
 
  
;ID: Unique object identifier. Must match in IDE file identifier.  (integer)
+
Now for converting a text <code>.ipl</code> to binary <code>.ipl</code> and vice-versa,we can use [https://gtaforums.com/topic/857375-fastman92-processor/ fastman92-processor].Its a pretty simple program we can get most of the work done by editing the <code>fastman92_processor.bat</code>(Or can use Binary (De-)Compiler).
;Name: Usually same as the .dff model file, without extension (string)
 
;int: Interior number.  Zero for outside. (integer)
 
;x, y, z: Item placement coordinates. (floating point numbers)
 
;sx, sy, sz: Item scale, scales visible model only, doesn't scale the collision model. (floating point numbers)
 
;rx, ry, rz, rw: Item rotations.  Defined as [[Wikipedia:quaternion|quaternion]], quite sophisticated math is needed to translate it to [[Wikipedia:Euler angles|Euler angles]]. A map editing program should be used to edit these.
 
;lod: San Andreas only.  This the line number in the current IPL file for the LOD which belongs to this object. The first item in IPL file is line number 0, second is number 1 and so on.  A value of -1 means no LOD is used. (integer)
 
  
===CULL===
+
After converting to binary form we have to create a normal <code>.ipl</code> file and index it in [[Gta.dat]].Lets suppose the name of our <code>.ipl</code> is
Creates rainfree zones, wastefree zones, map reflections, TV screens, and temporary fixed camera positions.<br>
 
''GTA3 and VC format:''
 
x1, y1, z1, x2, y2, z2, x3, y3, z3, flag, 0
 
;x2, y2, z2: lower-left corner of the areabox
 
;x3, y3, z3: upper-right corner of the areabox
 
''SA format:''
 
centerX, centerY, centerZ, 0, Ywidth, bottomZ, Xwidth, 0, topZ, Flag, Vx, Vy, Vz, Cm
 
Cull zone boundaries in San Andreas are aligned to the nearest world unit.
 
  
===PATH===
+
  test.ipl
'''Ped, Car and Boat Paths''', defines paths relative to the world centre. Only used in GTA VC, this format is much easier than in GTA3 where the paths were stored in IDE files, and GTA-SA paths which are stored in **nodes.dat inside gta3.img. This is a quite complicated format and hardly usable without an editing program (such as [[Ked]]).
 
  
GTA SA uses [[GTA SA Paths|compiled binary files]] for its paths.
+
So the name of our binary <code>.ipl</code> would be as below,
  
===GRGE===
+
test_stream0.ipl
This reates garages for the main.scm to use. Only used in San Andreas.<br>
+
test_stream1.ipl
''SA only:''
+
test_stream2.ipl
  X1, Y1, Z1, frontX, frontY, X2, Y2, Z2, Door, Type, Name
+
...
;FrontX, Y: lower right front
+
  etc
;Door: Type of door
 
;Type: type of garage
 
;Name: used to edit garage through the SCM
 
  
===ENEX===
+
Then we'll need to import them in any of the [[IMG_archive|IMG Archives]].
This creates interior connection to real world by placing yellow markers on the map for CJ to walk through.<br>
 
''SA only:''
 
X1, Y1, Z1, ROT, R1, R2, C8, X2, Y2, Z2, Rot2, Int, Mark, Name, Sky, I2, Time On, Time Off
 
;X1, Y1, Z1: entrance location
 
;ROT: ???
 
;R1: X radius of entry
 
;R2: Y radius of entry
 
;C8: constant 8
 
;X2, Y2, Z2: exit location
 
;Rot2: exit rotation in degrees
 
;Int: The target interior number
 
;Mark: The type of marker
 
;Name: interior name, used to find the counterpart and to identify via mission script
 
;Sky: Sky color changer
 
;I2: unknown integer flags, could be weather related
 
;Time On: enables the marker at this time
 
;Time Off: disables the marker at this time
 
  
====Enex Sky Colors====
+
For a detailed tutorial see [https://gtaforums.com/topic/911878-sacreating-custom-binary-ipl/ here].
{|
+
 
! Sky Color
+
== Format ==
! Descriptions
 
|-
 
| 0
 
| blue sky
 
|-
 
| 1
 
| white fading to black
 
|-
 
| 2
 
| Black with yellow lights.
 
|-
 
| 3
 
| same as 1
 
|-
 
| 4
 
| same as 2
 
|-
 
| 5
 
| white fading to purple fading to black with yellow lights
 
|-
 
| 6
 
| white fading to black with yellow lights.
 
|-
 
| 7
 
| white fading to green fading to black with yellow light (probably clouds)
 
|-
 
| 8
 
| same as 6
 
|-
 
| 9
 
| same as 6
 
|-
 
| 10
 
| same as 2
 
|-
 
| 11
 
| Purple (gay) retarded shadows not much sight.
 
|-
 
| 12
 
| same as 6
 
|-
 
| 13
 
| same as 6
 
|-
 
| 14
 
| same as 7 only green is ocean blue
 
|-
 
| 15
 
| same as 6
 
|-
 
| 16
 
| same as 2.....
 
|-
 
| 17
 
| Nightly Mist
 
|-
 
| 18
 
| Blue fading yellow (sunrise i think)
 
|-
 
| 19
 
| Blue air with white clouds
 
|-
 
| 20
 
| darker blue air with lightblue clouds
 
|-
 
| 21
 
| Darker Blue air with white clouds
 
|-
 
| 22
 
| Orange with white clouds
 
|-
 
| 23
 
| Orange fading gray with orange clouds (weird)
 
|-
 
| 24
 
| this is red fading PURPLE with no seeing rang that you can't even see yourself
 
|-
 
| 25
 
| Dark Purple to grey with nice sun reflection
 
|-
 
| 27
 
| same as 19
 
|-
 
| 28
 
| the best one: big sun white clouds and blue air
 
|-
 
| 29
 
| Blue air white clouds HUGE SUN
 
|-
 
| 30
 
| Orange with dark orange clouds
 
|}
 
  
===PICK===
+
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 mean they're functional in the games.
This creates permanent weapon pickups. This was only used to create fire extinguisher pickups at fast food restaurants.<br>
 
''SA only:''
 
Weapon ID, X, Y, Z
 
  
====Pick Weapon IDs====
+
{|class="wikitable center-col-1 center-col-2" style="width: 100%;"
{|
+
!style="width: 7em;"|Section
! ID
+
!style="width: 8em;"|Supported games
! Weapon Name
+
!Description
! Ammo
 
|-
 
| 4
 
| Brass Knuckles
 
| -
 
|-
 
| 5
 
| Nightstick
 
| -
 
|-
 
| 6
 
| Knife
 
| -
 
|-
 
| 7
 
| *Nothing*
 
| -
 
|-
 
| 8
 
| *Nothing*
 
| -
 
 
|-
 
|-
| 9
+
|<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.
| Golf Club
 
| -
 
 
|-
 
|-
| 10
+
|<code>[[ZONE|zone]]</code>||{{Icon|t}} {{Icon|4}}||Creates map, navigation, and info zones.
| Bat
 
| -
 
 
|-
 
|-
| 11
+
|<code>[[CULL|cull]]</code>||{{Icon|t}} {{Icon|4}}||Creates zones with special attributes.
| Shovel
 
| -
 
 
|-
 
|-
| 12
+
|<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. This section is only functional in San Andreas.
| Pool Cue
 
| -
 
 
|-
 
|-
| 13
+
|<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]].
| Katana
 
| -
 
 
|-
 
|-
| 14
+
|<code>[[OCCL|occl]]</code>||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Creates occlusion zones.
| Chainsaw
 
| -
 
 
|-
 
|-
| 15
+
|<code>[[MULT|mult]]</code>||{{Icon|SA|16||San Andreas (not functional)}} {{Icon|4|16||GTA IV (not functional)}}||This section is not functional.
| Molotov
 
| 8
 
 
|-
 
|-
| 16
+
|<code>[[GRGE|grge]]</code>||{{Icon|SA}} {{Icon|4}}||Creates garages.
| Grenades
 
| 8
 
 
|-
 
|-
| 17
+
|<code>[[ENEX|enex]]</code>||{{Icon|SA}} {{Icon|4}}||Creates entry-exit markers.
| Satchels
 
| 5
 
 
|-
 
|-
| 18
+
|<code>[[CARS (IPL Section)|cars]]</code>||{{Icon|SA}} {{Icon|4}}||Creates car generators (parked cars).
| 9mm Pistol
 
| 30
 
 
|-
 
|-
| 19
+
|<code>[[JUMP|jump]]</code>||{{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates stunt jumps. This section is not functional in GTA IV.
| Silenced 9mm
 
| 10
 
 
|-
 
|-
| 20
+
|<code>[[TCYC|tcyc]]</code>||{{Icon|SA}} {{Icon|4}}||Creates time cycles modifiers.
| Desert Eagle
 
| 10
 
 
|-
 
|-
| 21
+
|<code>[[AUZO|auzo]]</code>||{{Icon|SA}} {{Icon|4|16||GTA IV (not functional)}}||Creates [[Stream|audio]] zones. This section is not functional in GTA IV.
| Shotgun
 
| 15
 
 
|-
 
|-
| 22
+
|<code>[[MZON|mzon]]</code>||{{Icon|4}}||&ndash;
| SPAS Shotgun
 
| 10
 
 
|-
 
|-
| 23
+
|<code>[[VNOD|vnod]]</code>||{{Icon|4}}||Extended format of <code>path</code> &ndash; apparently only used for [[Multiplayer#GTA_4|multiplayer]] mode.
| Tec 9
 
| 60
 
 
|-
 
|-
| 24
+
|<code>[[LINK|link]]</code>||{{Icon|4}}||&ndash;
| Micro SMG
 
| 60
 
 
|-
 
|-
| 25
+
|<code>[[BLOK|blok]]</code>||{{Icon|4|16||GTA IV (not functional)}}||This section is not functional. 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]].
| MP5
 
| 60
 
 
|-
 
|-
| 26
+
|<code>[[MLO+|mlo+]]</code>||{{Icon|4}}||<code>mlo</code> placement &ndash; Used to place offsets for ''GTA IV's'' [[interior]]s. The ''interiors'' themselves get placed inside the [[IDE]] file section <code>[[MLO|mlo]]</code>.
| AK47
 
| 80
 
 
|-
 
|-
| 27
+
|<code>[[2DFX (IPL Section)|2dfx]]</code>||{{Icon|4}}||Used to make many game effects, for example - Particle.
| M4
 
| 80
 
 
|-
 
|-
| 28
+
|<code>[[LODM|lodm]]</code>||{{Icon|4}}||&ndash;
| Country Rifle
 
| 20
 
 
|-
 
|-
| 29
+
|<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.
| Sniper Rifle
+
<!--|[[RTFX|rtfx]]||{{Icon|4}}||&ndash;-->
| 10
 
|-
 
| 30
 
| *Nothing*
 
| -
 
|-
 
| 31
 
| Flamethrower
 
| 100
 
|-
 
| 32
 
| Minigun
 
| 500
 
|-
 
| 33
 
| Large Purple Dildo
 
| -
 
|-
 
| 34
 
| Small White Dildo
 
| -
 
|-
 
| 35
 
| Large White Vibrator
 
| -
 
|-
 
| 36
 
| Small Black Vibrator
 
| -
 
|-
 
| 37
 
| Flowers
 
| -
 
|-
 
| 38
 
| Cane
 
| -
 
|-
 
| 39
 
| Ringbox
 
| -
 
|-
 
| 40
 
| Necklace Box
 
| -
 
|-
 
| 41
 
| Cellphone
 
| -
 
|-
 
| 42
 
| *Nothing*
 
| -
 
|-
 
| 43
 
| Teargas
 
| 8
 
|-
 
| 44
 
| Minigun (Duplicate)
 
| 500
 
|-
 
| 45
 
| SPAS Shotgun (Duplicate)
 
| 10
 
|-
 
| 46
 
| Rocket Launcher
 
| 4
 
|-
 
| 47
 
| Heat Seeking Rocket Launcher
 
| 3
 
|-
 
| 48
 
| Detonator
 
| -
 
|-
 
| 49
 
| Spray can
 
| 500
 
|-
 
| 50
 
| Fire Extinguisher
 
| 500
 
|-
 
| 51
 
| Camera
 
| 36
 
|-
 
| 52
 
| Nightvision Goggles
 
| -
 
|-
 
| 53
 
| Infrared Goggles
 
| -
 
|-
 
| 54
 
| Jetpack
 
| -
 
|-
 
| 55
 
| Parachute
 
| -
 
 
|}
 
|}
  
===JUMP===
 
''SA only:''
 
start_x, start_y, start_z, radius_x, radius_y, radius_z, land_x, land_y, land_z, radius_x, radius_y,
 
radius_z, camera_x, camera_y, camera_z, reward
 
  
===TCYC===
+
== Tools ==
Creates black sky if you enter the zone. Also exists for all towns in countryside. Probably custom weather?<br>
 
''SA only:''
 
X1, Y1, Z1, X2, Y2, Z2, ?, ?, ?, ?, ?
 
  
===AUZO===
+
* [[KEd]] &ndash; By {{U|JernejL}}
Creates an audio if you enter the zone.<br>
+
* [[MEd]] &ndash; By {{U|Tonywob}}
''SA Type 1:''
+
* {{GTAF|315944|IPL Helper}} &ndash; By {{U|Xmen}}
Name, ID, Switch, X1, Y1, Z1, X2, Y2, Z2
+
* [https://www.gtainside.com/en/sanandreas/tools/120305-binary-de-compiler/ Binary (De-)Compiler] &ndash; By {{U|ocram88}}
;Name: Name of the zone
+
* {{GTAF|429526|SA Binary IPL Exporter for 3DS Max}} &ndash; by {{U|Gforce}}
;ID: Sound played in this zone
+
* [https://gtaforums.com/topic/857375-fastman92-processor/ fastman92processor] &ndash; By {{U|fastman92}}
;Switch: Makes it always on or always off. Can be forced using the main.scm<br>
 
''SA Type 2:''
 
Name, ID, Switch, X, Y, Z, Volume
 
;Name: Name of the zone
 
;ID: Sound played in this zone
 
;Switch: Makes it always on or always off. Can be forced using the main.scm
 
;Volume: The distance the sound will be heard
 
  
====Auzo Audio IDs====
+
== See also ==
{|
 
! ID
 
! What sound it plays
 
! Description of sound in the unmodified audio streams
 
|-
 
| 4
 
| Ambience track 9
 
| St Mark's violin music
 
|-
 
| 5
 
| Ambience track 6
 
| Beach party bkgd song
 
|-
 
| 8
 
| Ambience track 31
 
| Unused loud hum
 
|-
 
| 10
 
| Ambience track 5
 
| Awards ceremony music
 
|-
 
| 12
 
| Ambience track 34
 
| Loud hum heard on ships
 
|-
 
| 13
 
| Ambience track 23
 
| Low Rider Challenge bkgd song
 
|-
 
| 15
 
| Ambience track 30
 
| Static sound heard on military bases
 
|-
 
| 17
 
| Ambience track 12
 
| Casino bkgd medley
 
|-
 
| 19
 
| Ambience track 4
 
| Quiet hum heard in Area 69
 
|-
 
| 20
 
| Ambience track 2
 
| Fan-like clicking heard in Abattoir
 
|-
 
| 21
 
| Ambience track 1
 
| Quiet hum heard in 24-7s
 
|-
 
| 23
 
| Ambience track 14
 
| Loud hum heard in Dam interior
 
|-
 
| 24
 
| Ambience track 25
 
| Racing sounds heard in ITB lobby
 
|-
 
| 25
 
| Ambience track 24
 
| Quiet hum heard in Planning Dept
 
|-
 
| 26
 
| Ambience track 20
 
| Quiet hum heard in safe houses
 
|-
 
| 28
 
| Ambience track 13
 
| Dance Club bkgd medley
 
|-
 
| 29
 
| Ambience track 13
 
| Dance Club bkgd medley
 
|-
 
| 30
 
| Favorite Radio Station
 
| Stream or User Tracks Player
 
|-
 
| 34
 
| Ambience track 28
 
| Pleasure Domes bkgd medley
 
|-
 
| 36
 
| Ambience track 21
 
| Loud hum heard in Jet interior
 
|-
 
| 37
 
| Ambience track 10
 
| Muzak-type bkgd heard in unused diner interiors
 
|-
 
| 39
 
| Ambience track 29
 
| Quiet hum heard in police stations
 
|-
 
| 41
 
| Ambience track 35
 
| Stadium event bkgd medley
 
|-
 
| 44
 
| Ambience track 18
 
| Fast Food Joint bkgd sounds
 
|-
 
| 48
 
| Ambience track 3
 
| Ammunation PA loop
 
|-
 
| 50
 
| Ambience track 39
 
| Quiet hum heard in warehouses
 
|-
 
| 51
 
| Ambience track 22
 
| Very loud hum heard in cargo plane?
 
|-
 
| 52
 
| Radio stream CH
 
| Playback FM
 
|-
 
| 53
 
| Radio stream CO
 
| K-ROSE
 
|-
 
| 54
 
| Radio stream CR
 
| KDST
 
|-
 
| 55
 
| Radio stream DS
 
| Bounce FM
 
|-
 
| 56
 
| Radio stream HC
 
| SFUR
 
|-
 
| 57
 
| Radio stream MH
 
| Radio Los Santos
 
|-
 
| 58
 
| Radio stream MR
 
| Radio X
 
|-
 
| 59
 
| Radio stream NJ
 
| CSR
 
|-
 
| 60
 
| Radio stream RE
 
| K-JAH West
 
|-
 
| 61
 
| Radio stream RG
 
| MasterSounds
 
|-
 
| 62
 
| Radio stream TK
 
| WCTR
 
|-
 
| 64
 
| Ambience track 17
 
| Unused quiet hum
 
|-
 
| 66
 
| Ambience track 36
 
| Strip Club bkgd medley
 
|-
 
| 67
 
| Ambience track 37
 
| Unused bkgd medley
 
|}
 
Notes: Any ID value from 0-70 inclusive not listed above generated no background sound.<br>
 
Audio 4 type two only<br>
 
Audios 5, 10, 12, and 13 disabled by default, can be reenabled
 
  
===MULT===
+
* [[Item definition]]
San Andreas only, this was never used in the game. This section is currently unknown and may never be known.
+
* [[WPL]] &ndash; Major ''GTA IV'' item placement file.
  
===CARS===
+
== External links ==
Parked vehicles, only used in binary IPLs by default, can be used in regular IPLs.<br>
 
''SA only:''
 
X, Y, Z, angle, car id, primary color, secondary color, bool?, alarm_probability,
 
door_lock_probability, dword (radio?), dword (appearance delay?)
 
  
===OCCL===
+
* {{GTAF|118193|GTA3/VC Map File Documentation and Troubleshooting}} - Topic by {{U|Opius}} covering general features of IPL files in GTA3 and GTA VC.
This creates [[occlusion]] boxes around Vice City and San Andreas.<br>
+
* {{GTAF|202532|GTA SA IPL Documentation}} - Topic by {{U|spaceeinstein}} covering details of the IPL format in GTA SA.
''VC and SA only:''
 
direct mid x, direct mid y, bottom height z, width x, width y, height from bottom height to top,
 
rotation
 
  
==External Links==
+
{{N|IV|VCS|LCS|SA|VC|III}}
* [http://www.gtaforums.com/index.php?showtopic=202532 GTASA IPL Documentation] - GTA Forums topic covering details of the IPL format in GTASA.
 
* [http://www.gtaforums.com/index.php?showtopic=188549&view=findpost&p=3177288 Explanation of GTASA LOD System] - GTA Forums message by Steve-M, explaining the LOD system for IPL files in GTASA.
 
  
[[Category:Map Formats]][[Category:GTA 3]][[Category:GTA VC]][[Category:GTA SA]]
+
[[Category:Map Formats]]

Latest revision as of 23:12, 12 January 2021

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 behavior 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 of the newly introduced Binary Ipl in San Andreas. Most of the placement information in GTA IV is stored inside of binary files (see WPL).

Text Format

The structure and format of the plain text item placement files are similar to that of the item definition files. The game searches for these files in gta.dat.They allow comments by the character #.Lines starting with this character simply get ignored by the game & empty lines are also allowed. Since these files contain different types of data a keyword is required for the game to recognize each set of data.

 <keyword>
 *lines*
 end

More information about these keywords can be found below in the Fomats section.

See also: Item Definition § Overview


Binary Format

San Andreas introduced a 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 a 4-Byte identifier followed by a header containing information about the content of the files.

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.INST arrays have a size of 40 bytes per structure, and cars have 48 bytes.

INST

4b  - FLOAT    - Position X
4b  - FLOAT    - Position Y
4b  - FLOAT    - Position Z
4b  - FLOAT    - Rotation X
4b  - FLOAT    - Rotation Y
4b  - FLOAT    - Rotation Z
4b  - FLOAT    - Rotation W
4b  - INT32    - Object ID (as an index to the IDE)
4b  - INT32    - Interior
4b  - INT32    - LOD index

CARS

CARS is one of the known sections which can be used in binary format inside streaming files. It's format is similar to the plain text format:

4b  - FLOAT    - Position X
4b  - FLOAT    - Position Y
4b  - FLOAT    - Position Z
4b  - FLOAT    - Angle (Around Z-Axis)
4b  - INT32    - Object ID (an index to an vehicle definition)
4b  - INT32    - Primary color
4b  - INT32    - Secondary color
4b  - INT32    - Force spawn (Windows BOOL - see WinDef.h)
4b  - INT32    - Alarm probability
4b  - INT32    - Locked probability
4b  - INT32    - Unknown1 (Could be tertiary color)
4b  - INT32    - Unknown2 (Could be quarterdeck color)

Load a custom file

A basic comparison between a normal .ipl and a binary .ipl.

Normal:

15072, PLS_carpark, 0, 2579.8796445, 645.50208432, 9.93, 0, 0, 0, 1, -1

Binary:

15072, dummy, 0, 2579.8796445, 645.50208432, 9.93, 0, 0, 0, 1, -1

The object name is basically ignored in .ipl

Now for converting a text .ipl to binary .ipl and vice-versa,we can use fastman92-processor.Its a pretty simple program we can get most of the work done by editing the fastman92_processor.bat(Or can use Binary (De-)Compiler).

After converting to binary form we have to create a normal .ipl file and index it in Gta.dat.Lets suppose the name of our .ipl is

test.ipl

So the name of our binary .ipl would be as below,

test_stream0.ipl 
test_stream1.ipl 
test_stream2.ipl 
...
etc

Then we'll need to import them in any of the IMG Archives.

For a detailed tutorial see here.

Format

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 mean they're functional in the games.

Section Supported games Description
inst GTA III Vice City San Andreas GTA IV Places objects defined in objs, tobj, anim, or tanm into the world.
zone GTA III Vice City San Andreas GTA IV Creates map, navigation, and info zones.
cull GTA III Vice City San Andreas GTA IV Creates zones with special attributes.
pick GTA III (not functional) Vice City (not functional) San Andreas GTA IV (not functional) Creates pickups. This section is only functional in San Andreas.
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.
mult San Andreas (not functional) GTA IV (not functional) This section is not functional.
grge San Andreas GTA IV Creates garages.
enex San Andreas GTA IV Creates entry-exit markers.
cars San Andreas GTA IV Creates car generators (parked cars).
jump San Andreas GTA IV (not functional) Creates stunt jumps. This section is not functional in GTA IV.
tcyc San Andreas GTA IV Creates time cycles modifiers.
auzo San Andreas GTA IV (not functional) Creates audio zones. This section is not functional in GTA IV.
mzon GTA IV
vnod GTA IV Extended format of path – apparently only used for multiplayer mode.
link GTA IV
blok GTA IV (not functional) This section is not functional. 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 themselves 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