Torque Game Engine DocumentationVersion 1.3.x
| Torque Game Engine Documentation Version 1.3.x |
FlyingVehicleData derives from VehicleData and aids the creation of flying vehicle objects. FlyingVehicleData defines a few fields beyond those described in VehicleData. These new fields are listed in the table below.
Table D.7. FlyingVehicleData Member Fields
| Field Name | Type | Default Value | Description |
|---|---|---|---|
| Special Effects Data | |||
| jetSound | AudioProfilePtr | NULL | Points to the AudioProfile used to produce sounds for the jet. If specified, must point to an object of type AudioProfile. Must adhere to the semantics associated with AudioProfile*, as defined in the Torque Game Engine. |
| engineSound | AudioProfilePtr | NULL | Points to the AudioProfile used to produce sounds for the engine. If specified, must point to an object of type AudioProfile. Must adhere to the semantics associated with AudioProfile*, as defined in the Torque Game Engine. |
| forwardJetEmitter | ParticleEmitterDataPtr | NULL | Points to the ParticleEmitterData used in the production of particles for forward jet thrust. If specified, must point to an object of type AudioProfile. Must adhere to the semantics associated with AudioProfile*, as defined in the Torque Game Engine. |
| backwardJetEmitter | ParticleEmitterDataPtr | NULL | Points to the ParticleEmitterData used in the production of particles for Bacjward jet thrust. If specified, must point to an object of type AudioProfile. Must adhere to the semantics associated with AudioProfile*, as defined in the Torque Game Engine. |
| downJetEmitter | ParticleEmitterDataPtr | NULL | Points to the ParticleEmitterData used in the production of particles for downward jet thurst. If specified, must point to an object of type AudioProfile. Must adhere to the semantics associated with AudioProfile*, as defined in the Torque Game Engine. |
| trailEmitter | ParticleEmitterDataPtr | NULL | Points to the ParticleEmitterData used in the production of particles for jet trails. If specified, must point to an object of type AudioProfile. Must adhere to the semantics associated with AudioProfile*, as defined in the Torque Game Engine. |
| Physics Data | |||
| maneuveringForce | Float | 0.0 | The force generated by movements in the x or y (horizontal) directions. Also used to determine the FlyingVehicle's maximum speed, by dividing with minDrag (defined in VehicleData). |
| horizontalSurfaceForce | Float | 0.0 | The dampening force of the vehicle's horizontal surfaces (wing) against it's movement force. |
| verticalSurfaceForce | Float | 0.0 | The dampening force of the vehicle's vertical surfaces (fins) against it's movement force. |
| rollForce | Float | 1.0 | The dampening force against rolling maneuvers (rotation about the y-axis). Affect's the vehicle's rigid body torque and serves to adjust roll to the stable position over time. |
| steeringForce | Float | 1.0 | The force generated by the steering jets, affect's the vehicle's rigid body torque. |
| steeringRollForce | Float | 1.0 | The roll force generated by steering turns. Plays against rollForce, which corrects the effect of steeringRollForce on the vehicle's rigid body torque. |
| maxAutoSpeed | Float | 0.0 | The threshold speed at which automatic vehicle control assistance stops. Vehicles travelling at speeds above this value do not get control assitance. |
| autoAngularForce | Float | 0.0 | The corrective angular force applied to vehicles. The lower the vehicle's speed, the greater the effect of the autoAngularForce. Affect's the vehicle's rigid body torque. |
| autoLinearForce | Float | 0.0 | The corrective linear force applied only to vehicles travelling below the maxAutoSpeed (autoAngularForce applies to vehicles flying at any speed, but its effect increases when below the maxAutoSpeed). Affect's the vehicle's rigid body Torque, and has the effect of slowing the vehicle down. |
| autoInputDamping | Float | 1.0 | The scalar factor by which steering input is dampened when the vehicle is travelling at speeds below maxAutoSpeed. autoInputDamping is multiplied by the vehicle's steering vector. |
| vertThrustMultiple | Float | 1.0 | The scalar multiple applied to the jetForce (defined in VehicleData) when thrusting vertically. |
| rotationalDrag | Float | 0.0 | The scalar dampening drag against the vehicle's rigid body angular momentum. |
| hoverHeight | Float | 2.0 | The vehicle's height off the ground when at rest. |
| createHoverHeight | Float | 2.0 | The vehicle's height off the ground when it is first created. |
| minTrailSpeed | Float | 1.0 | The minimum speed at which the vehicle must be travelling in order to begin generating a contrail. |
As you can see, FlyingVehicleData defines a number of interesting new fields and enables the easy creation of flying vehicles with robust physical simulation characteristics. In the next section, we'll take a look at the HoverVehicleData datablock.