Difference between revisions of "Handling.cfg"

From GTAMods Wiki
Jump to navigation Jump to search
m (Created placeholder for documentation based on my "GTAVC Handling Definition".)
 
m (Added first version of content.)
Line 1: Line 1:
The "handling.cfg" file is a text data [[File Formats|file format]] which sets many performance and behaviour values for each vehicle in GTAVC.
+
The "handling.cfg" file is a text data [[:Category:File Formats|file format]] which sets many performance and behaviour values for each vehicle in GTAVC.
 +
 
 +
==Standard Data==
 +
The below table provides the column letter, column name and a brief description for each setting available in GTAVC's "handling.cfg" file format.
 +
 
 +
<table cellspacing="0" border="1" summary="One setting is explained per row.">
 +
<tr>
 +
  <th scope="col" abbr="Letter">Column Letter</th>
 +
  <th scope="col" abbr="Name">Column Name</th>
 +
  <th scope="col">Description</th>
 +
</tr>
 +
<tr>
 +
  <td>a</td>
 +
  <td>vehicle identifier</td>
 +
  <td>Relates this data with default.ide and other files.</td>
 +
</tr>
 +
<tr>
 +
  <td>b</td>
 +
  <td>fMass</td>
 +
  <td>Mass of the vehicle in kilograms.</td>
 +
</tr>
 +
<tr>
 +
  <td>c</td>
 +
  <td>Dimensions.x</td>
 +
  <td>Width of the vehicle in metres, used for aerodynamic and motion effects.</td>
 +
</tr>
 +
<tr>
 +
  <td>d</td>
 +
  <td>Dimensions.y</td>
 +
  <td>Length of the vehicle in metres, used for aerodynamic and motion effects.</td>
 +
</tr>
 +
<tr>
 +
  <td>e</td>
 +
  <td>Dimensions.z</td>
 +
  <td>Height of the vehicle in metres, used for aerodynamic and motion effects.</td>
 +
</tr>
 +
<tr>
 +
  <td>f</td>
 +
  <td>CentreOfMass.x</td>
 +
  <td>Distance from the centre of the car in metres to the right for the centre of mass.</td>
 +
</tr>
 +
<tr>
 +
  <td>g</td>
 +
  <td>CentreOfMass.y</td>
 +
  <td>Distance from the centre of the car in metres forward for the centre of mass.</td>
 +
</tr>
 +
<tr>
 +
  <td>h</td>
 +
  <td>CentreOfMass.z</td>
 +
  <td>Distance from the centre of the car in metres upward for the centre of mass.</td>
 +
</tr>
 +
<tr>
 +
  <td>i</td>
 +
  <td>nPercentSubmerged</td>
 +
  <td>Percentage of the vehicle height required to be submerged for the car to float.</td>
 +
</tr>
 +
<tr>
 +
  <td>j</td>
 +
  <td>fTractionMultiplier</td>
 +
  <td>Cornering grip of the vehicle as a multiplier of the tyre surface friction.</td>
 +
</tr>
 +
<tr>
 +
  <td>k</td>
 +
  <td>fTractionLoss</td>
 +
  <td>Accelerating/braking grip of the vehicle as a multiplier of the tyre surface friction.</td>
 +
</tr>
 +
<tr>
 +
  <td>l</td>
 +
  <td>fTractionBias</td>
 +
  <td>Ratio of front axle grip to rear axle grip; higher value shifts grip forwards.</td>
 +
</tr>
 +
<tr>
 +
  <td>m</td>
 +
  <td>TransmissionData.nNumberOfGears</td>
 +
  <td>Number of gearchange animations and sound effects to use.</td>
 +
</tr>
 +
<tr>
 +
  <td>n</td>
 +
  <td>TransmissionData.fMaxVelocity</td>
 +
  <td>Explained in other tutorials.</td>
 +
</tr>
 +
<tr>
 +
  <td>o</td>
 +
  <td>TransmissionData.fEngineAcceleration</td>
 +
  <td>Explained in other tutorials.</td>
 +
</tr>
 +
<tr>
 +
  <td>p</td>
 +
  <td>TransmissionData.nDriveType</td>
 +
  <td>Assigns Front, Rear or 4 wheel drive.</td>
 +
</tr>
 +
<tr>
 +
  <td>q</td>
 +
  <td>TransmissionData.nEngineType</td>
 +
  <td>Assigns Petrol, Diesel or Electric engine characteristics.</td>
 +
</tr>
 +
<tr>
 +
  <td>r</td>
 +
  <td>fBrakeDeceleration</td>
 +
  <td>Overall decelerative force, set so keyboard controls do not quite lock up the wheels.</td>
 +
</tr>
 +
<tr>
 +
  <td>s</td>
 +
  <td>fBrakeBias</td>
 +
  <td>Ratio of braking force of front compared to rear; higher values move bias forward.</td>
 +
</tr>
 +
<tr>
 +
  <td>t</td>
 +
  <td>bABS</td>
 +
  <td>Seems to have no effect.</td>
 +
</tr>
 +
<tr>
 +
  <td>u</td>
 +
  <td>fSteeringLock</td>
 +
  <td>Maximum rotation of steering arc in degrees; use negatives for rear wheel steered vehicles.</td>
 +
</tr>
 +
<tr>
 +
  <td>v</td>
 +
  <td>fSuspensionForceLevel</td>
 +
  <td>Explained in my suspension tutorial.</td>
 +
</tr>
 +
<tr>
 +
  <td>w</td>
 +
  <td>fSuspensionDampingLevel</td>
 +
  <td>Explained in my suspension tutorial.</td>
 +
</tr>
 +
<tr>
 +
  <td>x</td>
 +
  <td>fSeatOffsetDistance</td>
 +
  <td>Distance from door position to seat postion.</td>
 +
</tr>
 +
<tr>
 +
  <td>y</td>
 +
  <td>fCollisionDamageMultiplier</td>
 +
  <td>How much damage vehicle engine gets from collisions. Higher value means more damage.</td>
 +
</tr>
 +
<tr>
 +
  <td>z</td>
 +
  <td>nMonetaryValue</td>
 +
  <td>Seems to have no effect.</td>
 +
</tr>
 +
<tr>
 +
  <td>aa</td>
 +
  <td>suspension upper limit</td>
 +
  <td>Explained in my suspension tutorial.</td>
 +
</tr>
 +
<tr>
 +
  <td>ab</td>
 +
  <td>suspension lower limit</td>
 +
  <td>Explained in my suspension tutorial.</td>
 +
</tr>
 +
<tr>
 +
  <td>ac</td>
 +
  <td>suspension bias</td>
 +
  <td>Ratio of suspension force to apply at the rear compared to the front.</td>
 +
</tr>
 +
<tr>
 +
  <td>ad</td>
 +
  <td>suspension anti-dive multiplier</td>
 +
  <td>Changes the amount of body pitching under braking and acceleration.</td>
 +
</tr>
 +
<tr>
 +
  <td>ad</td>
 +
  <td>Flags</td>
 +
  <td>Special features which can be enabled or disabled.</td>
 +
</tr>
 +
<tr>
 +
  <td>ae</td>
 +
  <td>front lights</td>
 +
  <td>Defines the size of the head lights of the vehicle. Using numbers out of range has unusual effects.</td>
 +
</tr>
 +
<tr>
 +
  <td>af</td>
 +
  <td>rear lights</td>
 +
  <td>Same as above but for the tail lights.</td>
 +
</tr>
 +
</table>
 +
 
 +
===Flag Data===
 +
Column "ae", called "Flags", is a sixteen-bit integer value stored as a hexadecimal value in four bytes (characters).  The number is written with the smallest value on the right, which is bit number one, with the higher value bits to the left.  The below table describes what each of the sixteen bits in this setting do:
 +
 
 +
<table cellspacing="0" border="1" summary="One bit is explained per row.">
 +
<tr>
 +
  <th scope="col" abbr="Position">Bit Position</th>
 +
  <th scope="col" abbr="Name">Column Name</th>
 +
  <th scope="col">Description</th>
 +
</tr>
 +
<tr>
 +
  <td>1</td>
 +
  <td>1G_BOOST</td>
 +
  <td>Makes tyres spin more readily from standing starts.</td>
 +
</tr>
 +
<tr>
 +
  <td>2</td>
 +
  <td>2G_BOOST</td>
 +
  <td>Makes tyres spin more readily at low speeds.</td>
 +
</tr>
 +
<tr>
 +
  <td>3</td>
 +
  <td>REV_BONNET</td>
 +
  <td>Reverses the direction boot and bonnet axis operate.</td>
 +
</tr>
 +
<tr>
 +
  <td>4</td>
 +
  <td>HANGING_BOOT</td>
 +
  <td>Manipulates operation of boot object.</td>
 +
</tr>
 +
<tr>
 +
  <td>5</td>
 +
  <td>NO_DOORS</td>
 +
  <td>Eemoves all testing for doors; used with BF Injection.</td>
 +
</tr>
 +
<tr>
 +
  <td>6</td>
 +
  <td>IS_VAN</td>
 +
  <td>Allows double boot object.</td>
 +
</tr>
 +
<tr>
 +
  <td>7</td>
 +
  <td>IS_BUS</td>
 +
  <td>Unsure of precise application.</td>
 +
</tr>
 +
<tr>
 +
  <td>8</td>
 +
  <td>IS_LOW</td>
 +
  <td>Makes driver recline into seat.</td>
 +
</tr>
 +
<tr>
 +
  <td>9</td>
 +
  <td>DBL_EXHAUST</td>
 +
  <td>Allows second exhaust particle animation.</td>
 +
</tr>
 +
<tr>
 +
  <td>10</td>
 +
  <td>TAILGATE_BOOT</td>
 +
  <td>Manipulates operation of boot object.</td>
 +
</tr>
 +
<tr>
 +
  <td>11</td>
 +
  <td>NOSWING_BOOT</td>
 +
  <td>Manipulates operation of boot object.</td>
 +
</tr>
 +
<tr>
 +
  <td>12</td>
 +
  <td>NONPLAYER_STABILISER</td>
 +
  <td>Seems to have no effect.</td>
 +
</tr>
 +
<tr>
 +
  <td>13</td>
 +
  <td>NEUTRALHANDLING</td>
 +
  <td>Seems to have no effect.</td>
 +
</tr>
 +
<tr>
 +
  <td>14</td>
 +
  <td>HAS_NO_ROOF</td>
 +
  <td>Various slight effects.</td>
 +
</tr>
 +
<tr>
 +
  <td>15</td>
 +
  <td>IS_BIG</td>
 +
  <td>Changes the way that the AI drives around corners.</td>
 +
</tr>
 +
<tr>
 +
  <td>16</td>
 +
  <td>HALOGEN_LIGHTS</td>
 +
  <td>Slightly manipulates appearence of vehicle lights.</td>
 +
</tr>
 +
<tr>
 +
  <td>17</td>
 +
  <td>IS_BIKE</td>
 +
  <td>Makes the game engine treat this vehicle as a motorbike when used with "default.ide" attributes.</li>
 +
</tr>
 +
<tr>
 +
  <td>18</td>
 +
  <td>IS_HELI</td>
 +
  <td>Makes the game engine treat this vehicle as a helicopter when used with "default.ide" attributes.</li>
 +
</tr>
 +
<tr>
 +
  <td>19</td>
 +
  <td>IS_PLANE</td>
 +
  <td>Makes the game engine treat this vehicle as a plane when used with "default.ide" attributes.</li>
 +
</tr>
 +
<tr>
 +
  <td>20</td>
 +
  <td>IS_BOAT</td>
 +
  <td>Makes the game engine treat this vehicle as a boat when used with "default.ide" attributes.</li>
 +
</tr>
 +
<tr>
 +
  <td>21</td>
 +
  <td>NO_EXHAUST</td>
 +
  <td>Removes the exhaust animation particle for this vehicle.</li>
 +
</tr>
 +
<tr>
 +
  <td>22</td>
 +
  <td>REARWHEEL_1ST</td>
 +
  <td>Seems to have no effect.</li>
 +
</tr>
 +
<tr>
 +
  <td>23</td>
 +
  <td>HANDBRAKE_TYRE</td>
 +
  <td>Seems to have no effect.</li>
 +
</tr>
 +
<tr>
 +
  <td>24</td>
 +
  <td>SIT_IN_BOAT</td>
 +
  <td>Makes the player sit in this boat.</li>
 +
</tr>
 +
<tr>
 +
  <td>25</td>
 +
  <td>FAT_REARW</td>
 +
  <td>Doubles the width of the rear wheels.</li>
 +
</tr>
 +
<tr>
 +
  <td>26</td>
 +
  <td>NARROW_FRONTW</td>
 +
  <td>Halves the width of the front wheels.</li>
 +
</tr>
 +
<tr>
 +
  <td>27</td>
 +
  <td>GOOD_INSAND</td>
 +
  <td>Prevents vehicle from bogging down on sand surface.</li>
 +
</tr>
 +
<tr>
 +
  <td>28</td>
 +
  <td>SPECIAL_FLIGHT</td>
 +
  <td>Unsure of application and not mentioned in the "handling.cfg" comments. This is applied to some flying vehicles.</td>
 +
</tr>
 +
</table>
 +
 
 +
==External Links==
 +
* [http://projectcerbera.com/apps/cfgstudio.html CFG Studio] - a comprehensive handling editor for GTA3, GTAVC and GTASA by [[User:Cerbera|Cerbera]].
  
'' Cerbera intends to add content to this page soon. ''
 
  
 
{{file-stub}}
 
{{file-stub}}
 
[[Category:Vehicle Formats]][[Category:GTA VC]]
 
[[Category:Vehicle Formats]][[Category:GTA VC]]

Revision as of 19:37, 23 December 2005

The "handling.cfg" file is a text data file format which sets many performance and behaviour values for each vehicle in GTAVC.

Standard Data

The below table provides the column letter, column name and a brief description for each setting available in GTAVC's "handling.cfg" file format.

Column Letter Column Name Description
a vehicle identifier Relates this data with default.ide and other files.
b fMass Mass of the vehicle in kilograms.
c Dimensions.x Width of the vehicle in metres, used for aerodynamic and motion effects.
d Dimensions.y Length of the vehicle in metres, used for aerodynamic and motion effects.
e Dimensions.z Height of the vehicle in metres, used for aerodynamic and motion effects.
f CentreOfMass.x Distance from the centre of the car in metres to the right for the centre of mass.
g CentreOfMass.y Distance from the centre of the car in metres forward for the centre of mass.
h CentreOfMass.z Distance from the centre of the car in metres upward for the centre of mass.
i nPercentSubmerged Percentage of the vehicle height required to be submerged for the car to float.
j fTractionMultiplier Cornering grip of the vehicle as a multiplier of the tyre surface friction.
k fTractionLoss Accelerating/braking grip of the vehicle as a multiplier of the tyre surface friction.
l fTractionBias Ratio of front axle grip to rear axle grip; higher value shifts grip forwards.
m TransmissionData.nNumberOfGears Number of gearchange animations and sound effects to use.
n TransmissionData.fMaxVelocity Explained in other tutorials.
o TransmissionData.fEngineAcceleration Explained in other tutorials.
p TransmissionData.nDriveType Assigns Front, Rear or 4 wheel drive.
q TransmissionData.nEngineType Assigns Petrol, Diesel or Electric engine characteristics.
r fBrakeDeceleration Overall decelerative force, set so keyboard controls do not quite lock up the wheels.
s fBrakeBias Ratio of braking force of front compared to rear; higher values move bias forward.
t bABS Seems to have no effect.
u fSteeringLock Maximum rotation of steering arc in degrees; use negatives for rear wheel steered vehicles.
v fSuspensionForceLevel Explained in my suspension tutorial.
w fSuspensionDampingLevel Explained in my suspension tutorial.
x fSeatOffsetDistance Distance from door position to seat postion.
y fCollisionDamageMultiplier How much damage vehicle engine gets from collisions. Higher value means more damage.
z nMonetaryValue Seems to have no effect.
aa suspension upper limit Explained in my suspension tutorial.
ab suspension lower limit Explained in my suspension tutorial.
ac suspension bias Ratio of suspension force to apply at the rear compared to the front.
ad suspension anti-dive multiplier Changes the amount of body pitching under braking and acceleration.
ad Flags Special features which can be enabled or disabled.
ae front lights Defines the size of the head lights of the vehicle. Using numbers out of range has unusual effects.
af rear lights Same as above but for the tail lights.

Flag Data

Column "ae", called "Flags", is a sixteen-bit integer value stored as a hexadecimal value in four bytes (characters). The number is written with the smallest value on the right, which is bit number one, with the higher value bits to the left. The below table describes what each of the sixteen bits in this setting do:

Bit Position Column Name Description
1 1G_BOOST Makes tyres spin more readily from standing starts.
2 2G_BOOST Makes tyres spin more readily at low speeds.
3 REV_BONNET Reverses the direction boot and bonnet axis operate.
4 HANGING_BOOT Manipulates operation of boot object.
5 NO_DOORS Eemoves all testing for doors; used with BF Injection.
6 IS_VAN Allows double boot object.
7 IS_BUS Unsure of precise application.
8 IS_LOW Makes driver recline into seat.
9 DBL_EXHAUST Allows second exhaust particle animation.
10 TAILGATE_BOOT Manipulates operation of boot object.
11 NOSWING_BOOT Manipulates operation of boot object.
12 NONPLAYER_STABILISER Seems to have no effect.
13 NEUTRALHANDLING Seems to have no effect.
14 HAS_NO_ROOF Various slight effects.
15 IS_BIG Changes the way that the AI drives around corners.
16 HALOGEN_LIGHTS Slightly manipulates appearence of vehicle lights.
17 IS_BIKE Makes the game engine treat this vehicle as a motorbike when used with "default.ide" attributes.
18 IS_HELI Makes the game engine treat this vehicle as a helicopter when used with "default.ide" attributes.
19 IS_PLANE Makes the game engine treat this vehicle as a plane when used with "default.ide" attributes.
20 IS_BOAT Makes the game engine treat this vehicle as a boat when used with "default.ide" attributes.
21 NO_EXHAUST Removes the exhaust animation particle for this vehicle.
22 REARWHEEL_1ST Seems to have no effect.
23 HANDBRAKE_TYRE Seems to have no effect.
24 SIT_IN_BOAT Makes the player sit in this boat.
25 FAT_REARW Doubles the width of the rear wheels.
26 NARROW_FRONTW Halves the width of the front wheels.
27 GOOD_INSAND Prevents vehicle from bogging down on sand surface.
28 SPECIAL_FLIGHT Unsure of application and not mentioned in the "handling.cfg" comments. This is applied to some flying vehicles.

External Links