Difference between revisions of "Item Definition"

From GTAMods Wiki
Jump to navigation Jump to search
(more descriptions, link to screenshots)
(→‎Sections: order based on first appearance + all of IV)
Line 23: Line 23:
 
=== Sections ===
 
=== Sections ===
  
−
The following table contains basic information about all known sections. For additional information read the articles itself.
+
The following table contains all known sections in the item definition.
  
−
{|class="mw-collapsible wikitable center-col-1 center-col-2"
+
{|class="mw-collapsible wikitable center-col-1 center-col-2" style="width: 100%;"
−
!width="120px"|Identifier
+
!style="width: 7em;"|Identifier
−
!width="100px"|Supported games
+
!style="width: 8em;"|Supported games
 
!Description
 
!Description
 
|-
 
|-
−
|[[OBJS]]||{{Icon|trilogy}} {{Icon|4}}||Most important section: defines objects for the map.<br>These objects are placed through the ''[[INST]]'' section of the [[IPL|item placement files]].
+
|[[OBJS]]||{{Icon|trilogy}} {{Icon|4}}||Most important section: defines objects for the map. These objects can be placed into the world through the ''[[INST]]'' section of the [[IPL|item placement files]].
 
|-
 
|-
−
|[[TOBJ]]||{{Icon|trilogy}} {{Icon|4}}||Functions similarly to ''OBJS'', but it has two additional parameters defining the ingame time range the object can get rendered.<br>These objects are placed through the ''INST'' section of the item placement files.
+
|[[TOBJ]]||{{Icon|trilogy}} {{Icon|4}}||Functions similarly to ''OBJS'' but has two additional parameters defining the ingame time range the object can get rendered. These objects can be placed into the world through the ''INST'' section of the item placement files.
 
|-
 
|-
−
|[[ANIM]]||{{Icon|SA}} {{Icon|4}}||Functions similarly to ''OBJS'', but it has one additional parameter indicating an [[IFP]] or [[WAD]] animation file to assign an animation to the object.<br>These objects are placed through the ''INST'' section of the item placement files.
+
|[[HIER]]||{{Icon|trilogy}} {{Icon|4}}||Used to define objects for use in cutscenes.
 +
|-
 +
|[[CARS (IDE Section)|CARS]]||{{Icon|trilogy}} {{Icon|4}}||Used to define vehicles.
 +
|-
 +
|[[PEDS]]||{{Icon|trilogy}} {{Icon|4}}||Used to define pedestrians (random [[wikipedia:Non-player character|NPC's]]).
 +
|-
 +
|[[PATH (IDE Section)|PATH]]||{{Icon|3}}||Used to create waypoints for random NPC spawns ([[Paths]]).
 
|-
 
|-
−
|[[PEDS]]||{{Icon|trilogy}} {{Icon|4}}||Used to define ''"pedestrians"'' (Random [[wikipedia:Non-player_character|NPC's]]).
+
|[[2DFX]]||{{Icon|3}} {{Icon|VC}} {{Icon|4}}||Used to add particle effects and simple ped behaviors to defined objects.
 
|-
 
|-
 
|[[WEAP]]||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Used to define weapons.
 
|[[WEAP]]||{{Icon|VC}} {{Icon|SA}} {{Icon|4}}||Used to define weapons.
 
|-
 
|-
−
|[[CARS_(IDE_Section)|CARS]]||{{Icon|trilogy}} {{Icon|4}}||Used to define vehicles.
+
|[[ANIM]]||{{Icon|SA}} {{Icon|4}}||Functions similarly to ''OBJS'', but it has one additional parameter indicating an [[IFP]] or [[WAD]] animation file to assign an animation to the object.<br>These objects are placed through the ''INST'' section of the item placement files.
−
|-
 
−
|[[HIER]]||{{Icon|trilogy}} {{Icon|4}}||Used to define objects for use in cutscenes.
 
 
|-
 
|-
 
|[[TXDP]]||{{Icon|SA}} {{Icon|4}}||Used to virtually extend [[TXD|texture dictionaries]].
 
|[[TXDP]]||{{Icon|SA}} {{Icon|4}}||Used to virtually extend [[TXD|texture dictionaries]].
 
|-
 
|-
−
|[[2DFX]]||{{Icon|3}} {{Icon|VC}} {{Icon|4}}||Used to add particle effects and simple ped behaviors to defined objects.
+
|[[TANM]]||{{Icon|4}}||Used to combine ''TOBJ'' and ''ANIM'' sections.<br>Those objects get placed inside the ''INST'' section of the ''WPL''.
 
|-
 
|-
−
|[[PATH_(IDE_Section)|PATH]]||{{Icon|3}}||Used to create waypoints for random NPC spawns ([[Paths]]).
+
|[[TREE]]||{{Icon|4}}||&ndash;
 
|-
 
|-
−
|[[TREE]]||{{Icon|4}}||&ndash;
+
|[[VNOD]]||{{Icon|4}}||&ndash;
 
|-
 
|-
−
|[[TANM]]||{{Icon|4}}||Used to combine ''TOBJ'' and ''ANIM'' sections.<br>Those objects get placed inside the ''INST'' section of the ''WPL''.
+
|[[LINK]]||{{Icon|4}}||&ndash;
 
|-
 
|-
 
|[[MLO]]||{{Icon|4}}||Used to create [[interior]]s. This section does also contain information about portals (previous [[ENEX]] connections) and dimensions of the interior which influences certain aspects, like the weather, for example. All objects are placed relative to an offset placed using [[MLO+]] inside the [[IPL]] or [[WPL]] file.
 
|[[MLO]]||{{Icon|4}}||Used to create [[interior]]s. This section does also contain information about portals (previous [[ENEX]] connections) and dimensions of the interior which influences certain aspects, like the weather, for example. All objects are placed relative to an offset placed using [[MLO+]] inside the [[IPL]] or [[WPL]] file.
 
|-
 
|-
 
|[[AMAT]]||{{Icon|4}}||This is Audio Materials. Possible Used to make a sound effect at the model. Usually used for dynamic objects.
 
|[[AMAT]]||{{Icon|4}}||This is Audio Materials. Possible Used to make a sound effect at the model. Usually used for dynamic objects.
 +
|-
 +
|[[LODM]]||{{Icon|4}}||&ndash;
 +
|-
 +
|[[AGRPS]]||{{Icon|4}}||&ndash;
 
|-
 
|-
 
|[[HAND]]||VC XBOX||&ndash;
 
|[[HAND]]||VC XBOX||&ndash;

Revision as of 17:49, 11 August 2015

Item Definition
IDE Sections:
2DFX • AMAT • ANIM • CARS • HIER • HAND • MLO • OBJS
PATH • PEDS • TANM • TOBJ • TREE • TXDP • WEAP

Item definition files, usually identified by the file extension .ide, are used to declare many different aspects for the map system or to specify special behaviour rules for one of the aspects. They are stored in plain text format, so that they can be opened by any text editing program (like Notepad), but there are also some tools to simplify editing.

Overview

The item definition files are split up into several sections. There is no order on how you arrange the sections. Also you do not need to use all the sections in a file.

Format and syntax description

The basic structure of the different sections is pretty simple. Each section starts with a four-character section identifier indicating how the content of the section gets interpreted by the game. The identifier is followed by the definition entries. Each entry takes one line and every line follows certain rules which are described in the articles handling the sections in detail (see below). However lines can also be empty or commented. If so they get ignored by the games' parser. The end of every section are indicated by the terminating string "end". Both (section identifier and terminating string) 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

objs
...
end

Sections

The following table contains all known sections in the item definition.

Identifier Supported games Description
OBJS GTA III Vice City San Andreas GTA IV Most important section: defines objects for the map. These objects can be placed into the world through the INST section of the item placement files.
TOBJ GTA III Vice City San Andreas GTA IV Functions similarly to OBJS but has two additional parameters defining the ingame time range the object can get rendered. These objects can be placed into the world through the INST section of the item placement files.
HIER GTA III Vice City San Andreas GTA IV Used to define objects for use in cutscenes.
CARS GTA III Vice City San Andreas GTA IV Used to define vehicles.
PEDS GTA III Vice City San Andreas GTA IV Used to define pedestrians (random NPC's).
PATH GTA III Used to create waypoints for random NPC spawns (Paths).
2DFX GTA III Vice City GTA IV Used to add particle effects and simple ped behaviors to defined objects.
WEAP Vice City San Andreas GTA IV Used to define weapons.
ANIM San Andreas GTA IV Functions similarly to OBJS, but it has one additional parameter indicating an IFP or WAD animation file to assign an animation to the object.
These objects are placed through the INST section of the item placement files.
TXDP San Andreas GTA IV Used to virtually extend texture dictionaries.
TANM GTA IV Used to combine TOBJ and ANIM sections.
Those objects get placed inside the INST section of the WPL.
TREE GTA IV –
VNOD GTA IV –
LINK GTA IV –
MLO GTA IV Used to create interiors. This section does also contain information about portals (previous ENEX connections) and dimensions of the interior which influences certain aspects, like the weather, for example. All objects are placed relative to an offset placed using MLO+ inside the IPL or WPL file.
AMAT GTA IV This is Audio Materials. Possible Used to make a sound effect at the model. Usually used for dynamic objects.
LODM GTA IV –
AGRPS GTA IV –
HAND VC XBOX –

IDE Flags

Flags are used in order to specify the behaviour of objects. They are interpreted as signed 32-bit integer values where each bit describes a boolean value of a different aspect. The following table shows the standard flags used for objects defined in OBJS, TOBJ and ANIM section.

Flags are used to specify the behaviour of objects. They are signed 32-bit integer values where each bit describes a boolean value of an special aspect.

Flag Supported games Binary Description
-1 – 1111 1111 1111 1111 1111 1111 Enables all flags.[a] Never used by default.
1 GTA III Vice City San Andreas GTA IV 0000 0000 0000 0000 0000 0001 Wet effect (objects appear darker).
2 GTA III Vice City San Andreas GTA IV 0000 0000 0000 0000 0000 0010 Do not fade the object when it is being loaded into or out of view.
4 GTA III Vice City San Andreas GTA IV 0000 0000 0000 0000 0000 0100 Allow transparencies of other objects to be visible through this object.
8 GTA III Vice City San Andreas GTA IV 0000 0000 0000 0000 0000 1000 Alpha transparency 2
16 GTA III Vice City San Andreas GTA IV 0000 0000 0000 0000 0001 0000 Opposite to flag 2
32 GTA III Vice City San Andreas GTA IV 0000 0000 0000 0000 0010 0000 Indicates an object to be used inside an interior.
64 GTA III Vice City San Andreas GTA IV 0000 0000 0000 0000 0100 0000 Disables the shadow mesh to project a shadow; allow transparencies of other objects, shadows, and lights to be visible through this object.
128 Vice City San Andreas GTA IV 0000 0000 0000 0000 1000 0000 Object surface will not be culled.
256 Vice City San Andreas GTA IV 0000 0000 0000 0001 0000 0000 Disables draw distance (Only used for LOD objects with an LOD value greater than 299).
512 Vice City San Andreas GTA IV 0000 0000 0000 0010 0000 0000 Object is breakable (like glass – additional parameters defined inside the object.dat file, otherwise there is no effect).
1024 Vice City San Andreas GTA IV 0000 0000 0000 0100 0000 0000 Similar to flag 512: object first cracks on a strong collision, then it breaks (does also require object.dat registration).
2048 San Andreas GTA IV 0000 0000 0000 1000 0000 0000 Indicates an object as an garage door (for more information see GRGE – requires object.dat registration).
4096 San Andreas GTA IV 0000 0000 0001 0000 0000 0000 Indicates a multi mesh object (Object switches from mesh 2 to mesh 1 after collision – requires object.dat registration).
16384 San Andreas 0000 0000 0100 0000 0000 0000 Indicates a vegetation object (Object moves in wind).
32768 San Andreas GTA IV 0000 0000 1000 0000 0000 0000 Uses object brightness from the current weather definition (See timecyc.dat – PoleShd).
65536 San Andreas GTA IV 0000 0001 0000 0000 0000 0000 Object explodes after getting hit (requires object.dat registration).
131072 San Andreas 0000 0010 0000 0000 0000 0000 Unknown – apparently some flag for the Script.
262144 San Andreas 0000 0100 0000 0000 0000 0000 Unknown – only used 1 time in San Andreas.
1048576 San Andreas 0000 1000 0000 0000 0000 0000 Object will switch from mesh 2 to mesh 1 after getting sprayed by the player (graffity flag).
2097152 San Andreas 0001 0000 0000 0000 0000 0000 Disables backface culling – as an result the texture will be drawed on both sides of the model (Always enabled for GTA III and Vice City)
4194304 San Andreas 0010 0000 0000 0000 0000 0000 Unknown – apparently related into physics.
edit

GTA III

Bit Value Name Description Examples
0 1 NORMAL_CULL Cull model if player doesn't look at it. Ignored in GTA 3. Fences
1 2[1] DO_NOT_FADE Do not fade the object when it is being loaded into or out of view. Some lampposts
2 4[1] DRAW_LAST Model is transparent. Render this object after all opaque objects, allowing transparencies of other objects to be visible through this object. Trees
3 8 ADDITIVE Render with additive blending. Previous flag must be enabled too.
4 16[1] IS_SUBWAY Model is a tunnel, i.e. set the object as invisible unless the player enters cull zone flag 128. This flag works only with static models. Tunnels, some dynamic objects
5 32 IGNORE_LIGHTING Don't use static lighting, we want dynamic if it's possible. Some lampposts and trafficlights
6 64[1] NO_ZBUFFER_WRITE Model is a shadow. Disable writing to z-buffer when rendering it, allowing transparencies of other objects, shadows, and lights to be visible through this object. Shadow

For flags defining different aspects of different definitions read the articles about their sections.

Difference between GTA III and GTA IV engines

GTA IV not only uses different formats to the previous games, it also does not use IDs to identify objects anymore. While GTA III era games use an ID as an index inside an array of definitions, GTA IV uses the hashes of the model name as a key inside a hash table. For more information about this see Map System.

Tools

See also

References

External links

v · d · e
GTA IV Grand Theft Auto IV
File Formats.dat • .gxt • .ide • .img • .ipl • .nod • .sco • .rpf • .rrr • .wad • .wbd/.wbn • .wdd • .wdr • .wft • .whm • .wpl • .wtd
DocumentationAudio • Bink Video • Cryptography • Cutscenes • GXT Text • Image listing • Keycodes • Map Listing • Native functions • Paths • Radar Blips • Radio Stations • Saves • Scenarios • VTable • Weapons
ToolsASI 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
TutorialsImporting Textures with OpenIV • Importing Textures with SparkIV
ModificationsGTA Connected • Gostown IV • Four Multiplayer • IV Multiplayer • CitizenMP:IV Reloaded
Useful linksCommunity portal • Discussion forums • Modding forums • Mods on GTAGarage.com
v · d · e
San Andreas Grand Theft Auto: San Andreas
File Formats.b • .col • .cfg • .cut • .dff • .dat • .fxp • .gxt • .ide • .ifp • .img • .ipl • nodes*.dat • .ped • .rep • .rrr • .scm • .set • .txd
DocumentationAudio • Cryptography • Cutscenes • Game memory • Handling.cfg • Map Listing • Mission Packs • Instructions • Paths • Replays • Saves • Scripts • Sound Effects • Statistics • Vehicles • Wanted levels
ToolsCLEO • Collision File Editor II • ENBSeries • G-Tools • IMG Tool • Limit Adjuster • Map Editor • Mod Loader • San Andreas Audio Toolkit • Sanny Builder • TXD Workshop • Magic.TXD
TutorialsSan Andreas v2.0 Modding • How to create a mission • How to create a script • How to use Map Editor • Vehicle Mod Installation
ModificationsDesign Your Own Mission • Gostown Paradise • GTA: United • Myriad Islands
MultiplayergtaTournament • Multi Theft Auto • San Andreas Multiplayer • (more...)
Useful linksCommunity Portal • Discussion Forums • Modding Forums • Mods on GTAGarage.com • Mobile Modding • Opcodes Database
v · d · e
Vice City Grand Theft Auto: Vice City
File Formats.adf • .b • .col • .cfg • .dff • .dat • .gxt • .ide • .ifp • .img/.dir • .ipl • .raw/.sdt • .rep • .set • .scm • .txd
DocumentationAudio • Handling • Map Listing • Memory Addresses • Skin List • Opcodes • RenderWare • Script Paths • Saves • Sound Effects • Statistics • Vehicles • Text • Wanted levels • Weapons
ToolsCLEO • Collision File Editor II • G-Tools • GXT Editor • IMG Tool • Limit Adjuster • KEd (map editor) • Sanny Builder • TXD Workshop • Magic.TXD
TutorialsHow to create a mission • How to create a script • Vehicle Mod Installation
MultiplayerGTA:LC Multiplayer • gtaTournament • Multi Theft Auto • State Of Liberty Online • Vice City Multiplayer • Vice City Online
Useful linksCommunity Portal • Discussion Forums • Modding Forums • Mods on GTAGarage.com • Mobile Modding • Opcodes Database
v · d · e
GTA III Grand Theft Auto III
File Formats.b • .col • .cfg • .dff • .dat • .gxt • .ide • .ifp • .img • .ipl • .raw/.sdt • .set • .scm • .txd
DocumentationAudio • Handling.cfg • Map Listing • Opcodes • Paths • RenderWare • Saves • Sound Effects • Statistics • Vehicles • Wanted levels • Weapons
ToolsCLEO • Collision File Editor II • G-Tools • IMG Tool • Map Editor • Sanny Builder • TXD Workshop • Magic.TXD • Water Editor
TutorialsHow to create a mission • How to create a script • How to use Map Editor • Vehicle Mod Installation
MultiplayerLiberty Unleashed • Multi Theft Auto • More...
Useful linksCommunity Portal • Discussion Forums • Modding Forums • Mods on GTAGarage.com • Mobile Modding • Opcodes Database
Retrieved from "https://gtamods.com/mediawiki/index.php?title=Item_Definition&oldid=14731"