Difference between revisions of "Item Definition"

From GTAMods Wiki
Jump to navigation Jump to search
m (2DFX: consistency)
Line 310: Line 310:
  
 
''Type 0: Lights''
 
''Type 0: Lights''
  ID, X, Y, Z, R, G, B, unknown (0 or 200), 1, Corona, Shadow, Distance, Outer range, Size, Inner range, IDE flag, Wet, Flare, Dust
+
  ID, X, Y, Z, R, G, B, unknown (0 or 200), 0, Corona, Shadow, Distance, Outer range, Size, Inner range, IDE flag, Flash, Wet, Flare, Dust
  
 
{|{{Prettytable}} width="100%" class="collapsible collapsed"
 
{|{{Prettytable}} width="100%" class="collapsible collapsed"
Line 316: Line 316:
 
!Description
 
!Description
 
|-
 
|-
|<center>ID</center>||associated to existing object ID defined in [[OBJS]] section
+
|<center>ID</center>||associated to existing object ID defined in [[OBJS]] or [[TOBJ]] section
 
|-
 
|-
 
|<center>X, Y, Z</center>||X, Y, and Z coordinates relative to the center of the object
 
|<center>X, Y, Z</center>||X, Y, and Z coordinates relative to the center of the object
 
|-
 
|-
|<center>R, G, B</center>||color of the light and everything associated it in RGB format
+
|<center>R, G, B</center>||color of the light and everything associated with it in RGB format, also affects the intensity of the light so that darker the color the dimmer the light (meaning black (0,0,0) will yield a light so dim that it's not visible)
 
|-
 
|-
|<center>Corona</center>||corona associated to the light defined in <code>particle.txd</code>, usually "coronastar" for lighta
+
|<center>Corona</center>||corona texture associated to the light, texture defined in <code>particle.txd</code>, usually "coronastar" for lights
 
|-
 
|-
|<center>Shadow</center>||shadow associated to the light?, usually "shad_exp"
+
|<center>Shadow</center>||light texture that is cast on the ground, texture defined in <code>particle.txd</code>, usually "shad_exp" for lights
 
|-
 
|-
 
|<center>Distance</center>||view distance of the light, is limited by the draw distance of the host object
 
|<center>Distance</center>||view distance of the light, is limited by the draw distance of the host object
Line 334: Line 334:
 
|<center>Inner range</center>||the range the light can cast on the ground
 
|<center>Inner range</center>||the range the light can cast on the ground
 
|-
 
|-
|<center>IDE flag</center>||IDE flag, only the time-dependent flags are useable
+
|<center>IDE flag</center>||[[OBJS#Object_Flags|IDE flag]], only the time-dependent flags are usable
 
|-
 
|-
 
|<center>Flash</center>||sets the [[2DFX#Types of Flashes|type of flashing]]
 
|<center>Flash</center>||sets the [[2DFX#Types of Flashes|type of flashing]]
 
|-
 
|-
|<center>Wet</center>||sets the particle to be "reflective" on wet grounds
+
|<center>Wet</center>||sets the particle to be "reflective" on wet grounds, will only work if the ground around the light is set to wet when raining<br>0 - not reflective when wet, 1 - reflective when wet
 
|-
 
|-
|<center>Flare</center>||sets the particle to create a lens flare on the screen, similar to what the sun does<br>0 - no lens flare, 1 - lens flare effect
+
|<center>Flare</center>||sets the particle to create a lens flare on the screen, similar to what the sun does<br>0 - no lens flare, 1 - yellow lens flare, 2 - white lens flare
 
|-
 
|-
 
|<center>Dust</center>||sets the intensity of light reflecting off dust, values 4 to 7 have visible effects
 
|<center>Dust</center>||sets the intensity of light reflecting off dust, values 4 to 7 have visible effects
Line 346: Line 346:
  
 
''Type 1: Particle''
 
''Type 1: Particle''
  ID, X, Y, Z, R, G, B, unknown (63 or 200), 2, Particle, unk1, unk2, unk3, Size
+
  ID, X, Y, Z, R, G, B, unknown (63 or 200), 1, Particle, unk1, unk2, unk3, Size
  
 
{|{{Prettytable}} width="100%" class="collapsible collapsed"
 
{|{{Prettytable}} width="100%" class="collapsible collapsed"
Line 352: Line 352:
 
!Description
 
!Description
 
|-
 
|-
|<center>ID</center>||associated to existing object ID defined in [[OBJS]] section
+
|<center>ID</center>||associated to existing object ID defined in [[OBJS]] or [[TOBJ]] section
 
|-
 
|-
 
|<center>X, Y, Z</center>||X, Y, and Z coordinates relative to the center of the object
 
|<center>X, Y, Z</center>||X, Y, and Z coordinates relative to the center of the object
Line 359: Line 359:
 
|-
 
|-
 
|<center>Particle</center>||[[2DFX#Types of Particles|particle type]]
 
|<center>Particle</center>||[[2DFX#Types of Particles|particle type]]
 +
|-
 +
|<center>unk1, unk2, unk3</center>||unknown, rotation of particle?
 
|-
 
|-
 
|<center>Size</center>||the size of the particle
 
|<center>Size</center>||the size of the particle
Line 370: Line 372:
 
!Description
 
!Description
 
|-
 
|-
|<center>ID</center>||associated to existing object ID defined in [[OBJS]] section
+
|<center>ID</center>||associated to existing object ID defined in [[OBJS]] or [[TOBJ]] section
 
|-
 
|-
 
|<center>X, Y, Z</center>||X, Y, and Z coordinates relative to the center of the object
 
|<center>X, Y, Z</center>||X, Y, and Z coordinates relative to the center of the object
Line 376: Line 378:
 
|<center>R, G, B</center>||useless values
 
|<center>R, G, B</center>||useless values
 
|-
 
|-
|<center>Animation</center>||[[2DFX#Types of Behaviors|behavior type]]
+
|<center>Behavior</center>||[[2DFX#Types of Behaviors|behavior type]]
 
|-
 
|-
 
|<center>unk1, unk2, unk3</center>||unknown, useless values?
 
|<center>unk1, unk2, unk3</center>||unknown, useless values?

Revision as of 05:08, 5 May 2010

40px-Ambox rewrite orange.svg.png This article may need to be rewritten.
Please help improve this article. The discussion page may contain suggestions.
Item Definition
IDE Sections:
2DFX AMAT ANIM CARS HIER HAND MLO OBJS
PATH PEDS TANM TOBJ TREE TXDP WEAP

Item definition files, known by the extension .ide, are usually used to assign a model and texture file to a unique object ID, along with many parameters depending on the section. These files are in human readable text format, and allow the # character to comment lines out. IDE files can easily be opened and edited using any text-editing program like Notepad.

Structure

The .ide 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:

objs
...
end

OBJS

Used to define standard static map objects.

GTA III, VC and SA format

ID, ModelName, TextureName, ObjectCount, DrawDist, [DrawDist2, ...], Flags

GTA IV format

ModelName, TextureName, DrawDistance, Flag1, Flag2, (Bounds min)X,Y,Z, (Bounds max)X,Y,Z, (Bounds Sphere)X, Y, Z, Radius, WDD

Note that GTA IV does not use any unique object ID numbers

TOBJ

Used to define timed map objects. All but the last two columns are the same as the OBJS section.

GTA III, VC and SA format:

ID, ModelName, TextureName, ObjectCount, DrawDist, [DrawDist2, ...], Flags, TimeOn, TimeOff

GTA IV format

ModelName, TextureName, DrawDist, Flag1, Flag2, (Bounds min)X,Y,Z, (Bounds max)X,Y,Z, (Bounds Sphere)X,Y,Z, Radius, WDD, NightFlag

Note that GTA IV does not use any unique object ID numbers.

ANIM

Animated Map Objects, used to define objects whose sub objects are animated. Note: There must be animation frames for each sub object, also the collision model remains static - no solid animations.

GTA SA only:

ID, ModelName, TextureName, AnimName, DrawDist, Flags
ID, ModelName, TextureName, DrawDist, Flags
same as for the OBJS section
AnimName
name of the animation archive, without extension (string)

GTA IV format

ModelName, TextureName, Wad, DrawDist, Flag1, Flag2, (Bounds min)X,Y,Z, (Bounds max)X,Y,Z, (Bounds Sphere)X,Y,Z, Radius, WDD
ModelName, TextureName, DrawDistance, Flags, Bounds min, Bounds max, Bounds Sphere X,Y,Z, Radius, WDD
same as for the OBJS section
Wad
name of the (.wad) animation archive, without extension (string)

PEDS

Used to define characters and pedestrians

GTA III format:

ID, ModelName, TxdName, Threat, Behavior, AnimationType, VehClass

Vice City format

ID, ModelName, TxdName, Threat, Behavior, AnimationType, VehClass, StartAnimation?, Radio1, Radio2

WEAP

GTA III and VC format:

ID, ModelName, TextureName, Animation, ?, DrawDistance, ?
Animation
From ped.ifp, animation used to wield and shoot the weapon

CARS

Used to define vehicles

GTA III formats

Car

ID, ModelName, TxdName, Type, HandlingID, GameName, Class, Frequency, Level, Comprules, WheelID, WheelScale

Boat and Train

ID, ModelName, TxdName, Type, HandlingID, GameName, Class, Frequency, Level, Comprules

Plane

ID, ModelName, TxdName, Type, HandlingID, GameName, Class, Frequency, Level, Comprules, LODModel

Vice City formats

Car

ID, ModelName, TxdName, Type, HandlingID, GameName, Anims, Class, Frequency, Level, Comprules, WheelID, WheelScale

Bike

ID, ModelName, TxdName, Type, HandlingID, GameName, Anims, Class, Frequency, Level, Comprules, Unknown, WheelScale

Boat and Heli

ID, ModelName, TxdName, Type, HandlingID, GameName, Anims, Class, Frequency, Level, Comprules

Plane

ID, ModelName, TxdName, Type, HandlingID, GameName, Anims, Class, Frequency, Level, Comprules, LODModel

SA Format comming soon

HIER

SA Format only

This is (e.g.) used in default.ide in the 'data\'-folder Normal structure is like this:

 ID, model, texture, null, float (normally 2000.00)

The meaning of these lines isn't known yet, but it seems to be a kind of bodyparts for the player.

TXDP

Texture Archive Parent

SA and GTA 4 format

TextureName, TextureParentName

Both parameters are names of texture archives (.txd). The second archive (the "parent") virtually extends the first one. Practically, the game looks up a texture in the primary archive, and if it's not there and a parent txd has been assigned, it checks for the texture in the parent archive. This way shared archives can be created, which contain often used textures, without the need to create duplicates or split up a model just for that purpose.

2DFX

Used to place lights, particles, and ped behaviors on objects

GTA III and VC format

Type 0: Lights

ID, X, Y, Z, R, G, B, unknown (0 or 200), 0, Corona, Shadow, Distance, Outer range, Size, Inner range, IDE flag, Flash, Wet, Flare, Dust

Type 1: Particle

ID, X, Y, Z, R, G, B, unknown (63 or 200), 1, Particle, unk1, unk2, unk3, Size

Type 3: Peds (Vice City only)

ID, X, Y, Z, R, G, B, unknown (200), 3, Behavior, unk1, unk2, unk3, RotX, RotY, RotZ

Type 4: Sun Reflections (Vice City only)

ID, X, Y, Z, R, G, B, unknown (120), 4

Please note that the 2dfx Section is moved to the DFF Files by using R*'s custom section IDs in SA!

Please also note that the 2dfx Lights Section is present within GTA-IV WDR map models

PATH

Ped and Car Paths, defines paths relative to the objects. Only used in GTA III, quite complicated format and hardly usable without a editing program (such as Ked).

TREE

GTA4 only

TANM

GTA4 only

MLO

GTA4 only

AMAT

GTA4 only

Modelname, Flag1, Flag2

Procobj.ide

OBJS

GTA IV format

ModelName, TextureName, DrawDistance, Flag1, Flag2, (Bounds min)X, Y, Z, (Bounds max)X, Y, Z, (Bounds Sphere)X,Y,Z, Radius, WDD
ModelName
name of the .wdr model file, without extension (string)
TextureName
set to 'null' by default in procobj.ide
DrawDistance
draw distance in units, one for each sub object (float)
Flag1
object flag, defining special behavior
Flag2
object flag, defining special behavior, default 0 (integer)
Bounds Min
Lower Left vertex of a model bounding box
Bounds Max
Upper Right vertex of a model bounding box
Bounds Sphere
X,Y,Z Coords
Radius
Of Bounds Sphere
WDD
set to 'null' by default in procobj.ide

Tools

External Links