View source for CARS (IDE Section)

{{Research}}
{{This|CARS redirects here. For the IPL section see [[CARS (IPL Section)]]}}
{{IdeSection
| name        = CARS
| game        = [[GTA III]], [[GTA VC]], [[GTA SA]], [[GTA IV]]
| description = Used to define vehicles
}}
'''CARS''' is a section in the [[item definition]] file. It is used to define vehicles and some their properties.

== Format ==

=== GTA III ===

This section is mainly used in the <code>{{Dir|3}}\data\default.ide</code> file. Each type of vehicle has its own format.

{|{{Prettytable}} width="100%"
! width="36px"| {{Icon|3}}
! width="150px"| Identifier
! width="100px"| Type
! Description
|-
| <center>A</center> || <center>Id</center> || integer || Unique object ID.
|-
| <center>B</center> || <center>ModelName</center> || string || Name of the <code>.dff</code> [[model file]] without extension.
|-
| <center>C</center> || <center>TxdName</center> || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
|-
| <center>D</center> || <center>Type</center> || string || Type of vehicle, which includes ''car'', ''boat'', ''train'', and ''plane''.<br>This data is related to hardcoded functions and must not be changed or else it might crash the game.
|-
| <center>E</center> || <center>HandlingId</center> || string || Name corresponding to its handling data in the <code>[[handling.cfg]]</code> file.
|-
| <center>F</center> || <center>GameName</center> || string || Name corresponding to its [[GXT]] entry, case sensitive and must be seven characters or less!<br>Invalid name will show up as ''MODEL missing''
|-
| <center>G</center> || <center>Class</center> || string || Class of the vehicle (see [[#Vehicle Classes|below]]).
|-
| <center>H</center> || <center>Frq</center> || integer || Frequency of the vehicle spawning randomly on the streets.
|-
| <center>I</center> || <center>Lvl</center> || integer || unknown <!--Island appearance-->
|-
| <center>J</center> || <center>Comprules</center> || hex || unknown, [[#Comprules|see below]] for list
|-
| <center>K</center> || Type<br>''car'': WheelModelId<br>''boat'': unused<br>''train'': unused<br>''plane'': LODModel || integer || <br>ID number of wheel model.<br>-<br>-<br>ID number of [[LOD]] model &ndash; can be any valid [[OBJS|object]].
|-
| <center>L</center> || Type<br>''car'': WheelScale<br>''boat'': unused<br>''train'': unused<br>''plane'': unused || float || <br>Scale of wheel and [[Collision File|collision]] models, 1.0 for original size of wheel and collision models<br>-<br>-<br>-
|}

==== Comprules ====
It is unknown what this column does. This is a list of all non-zero values used in the column.
{|{{Prettytable}} width="100%"
! width="250px" | Non-Zero Value
! Vehicle(s)
|-
| 0x1f10 || Taxi, Hoods Rumpo XL
|-
| 0x2ff0 || Stinger, Stallion
|}

==== Wheels ====

Wheel models are located in the <code>..\models\generic\wheels.DFF</code> file. Their textures are located in the <code>..\models\misc.txd</code> file. Just like the cars themselves they are defined inside the <code>..\data\default.ide</code> file by default. The following table shows the different wheels and their ID's.

{| {{prettytable}}
!ID
|align="center"|160
|align="center"|161
|align="center"|162
|align="center"|163
|align="center"|164
|align="center"|165
|align="center"|166
|-
!Image
|[[File:wheel_sport64.png|50px|wheel_sport64]]
|[[File:wheel_saloon64.png|50px|wheel_saloon64]]
|[[File:wheel_lightvan64.png|50px|wheel_lightvan64]]
|[[File:wheel_classic64.png|50px|wheel_classic64]]
|[[File:wheel_alloy64.png|50px|wheel_alloy64]]
|[[File:wheel_lighttruck64.png|50px|wheel_lighttruck64]]
|[[File:wheel_smallcar64.png|50px|wheel_smallcar64]]
|}

=== Vice City ===

By default all cars are defined inside the <code>{{Dir|vc}}\data\default.ide</code> file. Unlike ''GTA III'' there are the types ''bike'' and ''heli'' but ''train'' is missing or unused.

{|{{Prettytable}} width="100%"
! width="36px"| {{Icon|VC}}
! width="150px"| Identifier
! width="100px"| Type
! Description
|-
| <center>A</center> || <center>Id</center> || integer || Unique object ID.
|-
| <center>B</center> || <center>ModelName</center> || string || Name of the <code>.dff</code> [[model file]] without extension.
|-
| <center>C</center> || <center>TxdName</center> || string || Name of the <code>.txd</code> [[texture dictionary]] without extension.
|-
| <center>D</center> || <center>Type</center> || string || Type of vehicle, which includes ''car'', ''boat'', ''train'', ''heli'', ''plane'', and ''bike''. Flyable helicopters are of type ''car''.
|-
| <center>E</center> || <center>HandlingId</center> || string || Name corresponding to its handling data in the <code>handling.cfg</code> file.
|-
| <center>F</center> || <center>GameName</center> || string || Name corresponding to its ''GXT'' entry, case sensitive and must be seven characters or less.<br>Invalid name will not show up in the game.
|-
| <center>G</center> || <center>Anims</center> || string || Appropriate animation file mainly used on bikes.
|-
| <center>H</center> || <center>Class</center> || string || Class of the vehicle (see [[#Vehicle_Classes|below]]).
|-
| <center>I</center> || <center>Frq</center> || integer || Frequency of the vehicle spawning randomly on the streets.
|-
| <center>J</center> || <center>Lvl</center> || integer || unknown <!--Island appearance-->
|-
| <center>K</center> || <center>Comprules</center> || hex || unknown, [[#Comprules_2|see below]] for list
|-
| <center>L</center> || Type<br>''car'': WheelID<br>''boat'': unused<br>''train'': unused<br>''heli'': unused<br>''plane'': LODModel<br>''bike'': unknown || integer || <br>ID number of wheel model.<br>-<br>-<br>-<br>ID number of ''LOD'' model &ndash; can be any valid [[OBJS|object]].<br>unknown
|-
| <center>M</center> || Type<br>''car'': WheelScale<br>''boat'': unused<br>''train'': unused<br>''heli'': unused<br>''plane'': unused<br>''bike'': WheelScale || float || <br>Scale of wheel and collision models, 1.0 for original size of wheel and collision models<br>-<br>-<br>-<br>-<br>Scale of wheel collision model, 1.0 for original size of wheel collision models; wheel visually not affected
|}
<!--
==== Level ====
This column can be more easily read in binary (see [[Binary to decimal conversion#Decimal to binary|decimal to binary conversion]]). It is made of flags 1, 2, and 4 for levels 1, 2, and 3. The island levels are defined in the [[ZONE]] files.
* {{GTAF|post|477801|1060533536|Explanation of levels cloumn}}
-->
==== Comprules ====
It is unknown what this column does. This is a list of all non-zero values used in the column.
{|{{Prettytable}} width="100%"
! width="250px" | Non-Zero Value
! Vehicle(s)
|-
| 0x1f10 || Taxi, Cabbie, Zebra Cab, Kaufman Cab
|-
| 0x2ff0 || Stinger, Stallion, Sabre, Sabre Turbo, Comet, Deluxo
|-
| 0x4fff || Flatbed, Hotring A, Hotring B, Bloodring Banger A, Bloodring Banger B
|-
| 0x30123345 || Caddy
|}

==== Wheels ====

The location of the definition files, models and textures are just the same as for ''GTA III''. However there are some different textures and models. The following table shows all ''Vice City'' wheels and their ID's.

{| {{prettytable}}
! colspan="2" | ID
|align="center"|237
|align="center"|238
|align="center"|239
|align="center"|250
|align="center"|251
|align="center"|252
|align="center"|253
|align="center"|254
|align="center"|255
|align="center"|256
|-
! rowspan="2" | Image
! PC/PS2
|[[File:Wheel_rim.png|50px|wheel_rim]]
|[[File:Wheel_offroad.png|50px|wheel_offroad]]
|[[File:Wheel_truck.png|50px|wheel_truck]]
|[[File:Wheel_sport.png|50px|wheel_sport]]
|[[File:Wheel_saloon.png|50px|wheel_saloon]]
|[[File:Wheel_lightvan.png|50px|wheel_lightvan]]
|[[File:Wheel_classic.png|50px|wheel_classic]]
|[[File:Wheel_alloy.png|50px|wheel_alloy]]
|[[File:Wheel_lighttruck.png|50px|wheel_lighttruck]]
|[[File:Wheel_smallcar.png|50px|wheel_smallcar]]
|-
! Xbox
|[[File:Wheel_rimx.png|50px|wheel_rim]]
|[[File:Wheel_offroadx.png|50px|wheel_offroad]]
|[[File:Wheel_truckx.png|50px|wheel_truck]]
|[[File:Wheel_sportx.png|50px|wheel_sport]]
|[[File:Wheel_saloonx.png|50px|wheel_saloon]]
|[[File:Wheel_lightvanx.png|50px|wheel_lightvan]]
|[[File:Wheel_classicx.png|50px|wheel_classic]]
|[[File:Wheel_alloyx.png|50px|wheel_alloy]]
|[[File:Wheel_lighttruckx.png|50px|wheel_lighttruck]]
|[[File:Wheel_smallcarx.png|50px|wheel_smallcar]]
|}

=== San Andreas ===

By default all cars are defined inside the <code>{{Dir|sa}}\data\vehicles.ide</code> file.

''Car''
 ID, ModelName, TxdName, Type, HandlingID, GameName, Anims, Class, Frequency, Flags, Comprules, WheelID, WheelScale_Front, WheelScale_Rear, Unknown_value

{|{{Prettytable}} width="100%"
!width="250px"|Identifier
!Description
|-
|<center>ID</center>||Unique model ID
|-
|<center>ModelName</center>||Name of the <code>.dff</code> ''model file'' without extension.
|-
|<center>TxdName</center>||Name of the <code>.txd</code> ''texture dictionary'' without extension.
|-
|<center>Type</center>||Type of vehicle, which includes ''trailer'', ''bmx'', ''bike'', ''train'', ''boat'', ''plane'', ''heli'', ''quad'', ''mtruck'' and ''car''
|-
|<center>HandlingID</center>||Name corresponding to its handling data in the ''handling.cfg'' file.
|-
|<center>GameName</center>||Name corresponding to its ''GXT'' entry, case sensitive and must be seven characters or less.<br>Invalid name will not show up in the game.
|-
|<center>Anims</center>||Appropriate character animation
|-
|<center>Class</center>||Class of the vehicle
|-
|<center>Frequency</center>||Frequency of the vehicle spawning randomly on the streets.
|-
|<center>Flags</center>||Unknown integer.
|-
|<center>Comprules</center>||Unknown hexadecimal value.
|-
|<center>WheelID</center>||Wheel index, needs to be -1 for vehicles to use wheel model defined in the vehicle's model (wheels.dff is no longer used)
|-
|<center>WheelScale_Front</center>||Scale of front wheels and collision models for types ''car'', ''trailer'', ''quad'', ''mtruck'', ''bmx'' and ''bike''
|-
|<center>WheelScale_Rear</center>||Scale of rear wheels and collision models for types ''car'', ''trailer'', ''quad'', ''mtruck'', ''bmx'' and ''bike''
|-
|<center>Unknown value</center>||Untested value. For most vehicles it is 0, or -1 regardless of ''Type''.
For the Flash, Elegy, Stratum, Jester and Uranus this value is 1.
For the Remington, Blade, Slamvan, Savanna, Broadway and Tornado this value is 2.
|}

====Flags====
According to the vehicles.ide file, flag 0x01 streams a vehicle out after it has been spawned once, and flag 0x02 whis is "used internally". There are 3 vehicles that use flag 0x01, none that use flag 0x02, and one that uses 0x07, which is not mentioned at all.
{|{{Prettytable}} width="100%"
!width="250px"|Non-Zero Value
!Vehicle(s)
|-
|0x01||Dumper, Mr. Whoopee, Pizzaboy
|-
|0x07||Huntley
|}

====Comprules====
There is no documentation about the Comprules, however there are multiple vehicles, some specific to San Andreas, that have them set to non-zero values indicating use at least during one point in the games development.
{|{{Prettytable}} width="100%"
!width="250px"|Non-Zero Value
!Vehicle(s)
|-
|0x1012||Tram
|-
|0x1f10||Taxi, Barracks Ol, Coach, Cabbie, Slamvan
|-
|0x2ff0||Sabre, Comet, Savanna, Broadway, Tornado (related to convertibles?)
|-
|0x3012||Coast Guard
|-
|0x3210||Stallion
|-
|0x3f01||Reefer
|-
|0x3f10||Securicar
|-
|0x4fff||Speeder, Tropic, Flatbed, Hotring Racer A, Hotring Racer B, Bloodring Banger, DFT30 (related to racing vehicles?)
|-
|0x1f341210||NRG500
|-
|0x30123345||Caddy
|-
|0x3f341210||FCR900, BF400
|}

==== Wheels ====
Wheel models are now in the same model as the vehicle itself. The <code>wheels.dff</code> and <code>wheels.txd</code> are present but not used. If the "WheelID" is -1, the game will scale the wheel collision, but NOT the wheel model. If "WheelID" is 0, the game will scale the collision AND the wheel model, however this only works properly if the wheel model is set up properly before exporting.

=== GTA IV ===

By default all cars are defined inside the <code>..\common\data\vehicles.ide</code> file.

{|{{Prettytable}} width="100%"
! width="36px"| {{Icon|4}}
! width="150px"| Identifier
! width="100px"| Type
! Description
|-
| <center>A</center> || <center>ModelName</center> || string || Name of the <code>[[WDR|.wdr]]</code> model file without extension.
|-
| <center>B</center> || <center>TxdName</center> || string || Name of the <code>[[WTD|.wtd]]</code> texture dictionary without extension.
|-
| <center>C</center> || <center>Type</center> || string || Type of vehicle, which includes ''car'', ''bike'', ''boat'', ''train'', ''heli'', and ''plane''.
|-
| <center>D</center> || <center>HandlingId</center> || string || Name corresponding to its handling data in the <code>handling.dat</code> file.
|-
| <center>E</center> || <center>GameName</center> || string || Name corresponding to its ''GXT'' entry
|-
| <center>F</center> || <center>Anims</center> || string || 
|-
| <center>G</center> || <center>Anims2</center> || string || 
|-
| <center>H</center> || <center>Frq</center> || integer || Frequency of the vehicle spawning randomly on the streets.
|-
| <center>I</center> || <center>MaxNum</center> || integer || Maximum number of vehicles to exist at a time.
|-
| <center>J,K</center> || <center>WheelRadius</center> || float[2] || 
|-
| <center>L</center> || <center>DefDirtLevel</center> || float || Dirt level of traffic vehicles that includes a range from set value to 1.0.<br>Supported values range from 0.0 (clean) to 1.0 (dirty).
|-
| <center>M</center> || <center>LodMult</center> || integer || 
|-
| <center>N</center> || <center>Swankness</center> || float || 
|-
| <center>O</center> || <center>Flags</center> || string || 
* noboot
* smallworker
* big
* onlyduringofficehours
* bootinfront
* isvan
* avoidturns
* livery
* liveryextra
* sports
* delivery
* noambocc
* onlyonhighways
* ext_gang
* ext_conv
* ext_taxi
* ext_rare
* ext_requi
* ext_strong
* ext_script
* ext_all
* ext_sunroof
* tallship
* truckfx
* truckenginefx
* truckexhaustfx
* truckfirefx
* bangerexhaustfx
|}

== Vehicle Classes ==

The class of a vehicle helps determines where a vehicle should spawn, with the help of [[hardcoded]] features and the [[script]]. The ''ignore'' class is special for its ability to prevent vehicles assigned to that class from spawning as a regular NPC vehicle in traffic. Peds can be assigned to drive a class of vehicle in the [[PEDS#Vehicle_Class_2|PEDS]] section of the IDE file. The Mr Whoopee in ''GTA III'' uses the unique class ''special'' that no other vehicles have used. The following table shows the classes that are available and used in the game.

{|{{Prettytable}} width="100%" class="collapsible"
!width="120px"|Flag
!width="100px"|Supported games
!width="25%"|Binary
!Description
|-
|<center>0</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0000 0000</code></center>||ignore
|-
|<center>1</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0000 0001</code></center>||normal
|-
|<center>2</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0000 0010</code></center>||poorfamily
|-
|<center>4</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0000 0100</code></center>||richfamily
|-
|<center>8</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0000 1000</code></center>||executive
|-
|<center>16</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0001 0000</code></center>||worker
|-
|<center>32</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0010 0000</code></center>||big
|-
|<center>64</center>||<center>{{Icon|3}} {{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 0100 0000</code></center>||taxi
|-
|<center>128</center>||<center>{{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0000 1000 0000</code></center>||moped
|-
|<center>256</center>||<center>{{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0001 0000 0000</code></center>||motorbike
|-
|<center>512</center>||<center>{{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0010 0000 0000</code></center>||leisureboat
|-
|<center>1024</center>||<center>{{Icon|VC}} {{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 0100 0000 0000</code></center>||workerboat
|-
|<center>2048</center>||<center>{{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0000 1000 0000 0000</code></center>||bicycle
|-
|<center>4096</center>||<center>{{Icon|SA}} {{Icon|4}}</center>||<center><code>0000 0000 0001 0000 0000 0000</code></center>||on foot 
|} 

== See also ==

* [[Item definition]]
* [[PEDS]]
* [[CARS (IPL Section)]]
* [[Vehicle ID List]]

{{N|4|SA}}

[[Category:Map Formats]][[Category:GTA 3]][[Category:GTA VC]]