HoverVehicleData
Defines the properties of a HoverVehicle.
Public Attributes
float
Maximum speed below which a braking force is applied.
float
Force generated by braking.
float
Number of dust trail particles to generate based on vehicle speed.
Point3F
"X Y Z" offset from the vehicle's origin from which to generate dust trail particles.
Looping engine sound.
float
Scale factor applied to the vehicle gravitational force when the vehicle is floating.
float
Scalar applied to the vehicle's thrust force when the vehicle is floating.
Looping sound played while the vehicle is floating.
Emitter to generate particles for forward jet thrust.
float
Damping torque that acts against the vehicle's current angular momentum.
Looping sound played when the vehicle is jetting.
float
Force generated by thrusting the vehicle forward.
float
Force generated in the ground normal direction when the vehicle is not floating (within stabalizer length from the ground).
float
Pitch (rotation about the X-axis) force applied when steering in the y-axis direction.
float
Force generated to stabalize the vehicle (return it to neutral pitch/roll) when the vehicle is floating (more than stabalizer length from the ground.
float
Force generated by thrusting the vehicle backward.
float
Roll (rotation about the Y-axis) force applied when steering in the x-axis direction.
float
Damping spring force acting against changes in the stabalizer length.
float
Length of the base stabalizer when travelling at maximum speed (maxThrustSpeed).
float
Length of the base stabalizer when travelling at minimum speed (0).
float
Value used to generate stabalizer spring force. The force generated depends on stabilizer compression, that is how close the vehicle is to the ground proportional to current stabalizer length.
float
Yaw (rotation about the Z-axis) force applied when steering in the x-axis direction.about the vehicle's Z-axis)
float
Force generated by thrusting the vehicle to one side.
float
Maximum height above surface to emit dust trail particles.
float
Scale factor applied to the vehicle's thrust force when jetting.
Detailed Description
Defines the properties of a HoverVehicle.
Public Attributes
float brakingActivationSpeed
Maximum speed below which a braking force is applied.
float brakingForce
Force generated by braking.
The vehicle is considered to be braking if it is moving, but the throttle is off, and no left or right thrust is being applied. This force is only applied when the vehicle's velocity is less than brakingActivationSpeed.
float dustTrailFreqMod
Number of dust trail particles to generate based on vehicle speed.
The vehicle's speed is divided by this value to determine how many particles to generate each frame. Lower values give a more dense trail, higher values a more sparse trail.
Point3F dustTrailOffset
"X Y Z" offset from the vehicle's origin from which to generate dust trail particles.
By default particles are emitted directly beneath the origin of the vehicle model.
SFXProfile engineSound
Looping engine sound.
The volume is dynamically adjusted based on the current thrust level.
float floatingGravMag
Scale factor applied to the vehicle gravitational force when the vehicle is floating.
float floatingThrustFactor
Scalar applied to the vehicle's thrust force when the vehicle is floating.
note:The floatingThrustFactor must be between 0.0 and 1.0 (inclusive).
SFXProfile floatSound
Looping sound played while the vehicle is floating.
stabMinLen
ParticleEmitterData forwardJetEmitter
Emitter to generate particles for forward jet thrust.
Forward jet thrust particles are emitted from model nodes JetNozzle0 and JetNozzle1.
float gyroDrag
Damping torque that acts against the vehicle's current angular momentum.
SFXProfile jetSound
Looping sound played when the vehicle is jetting.
float mainThrustForce
Force generated by thrusting the vehicle forward.
Also used to determine the maxThrustSpeed:
maxThrustSpeed = (mainThrustForce + strafeThrustForce) / dragForce;
float normalForce
Force generated in the ground normal direction when the vehicle is not floating (within stabalizer length from the ground).
float pitchForce
Pitch (rotation about the X-axis) force applied when steering in the y-axis direction.
float restorativeForce
Force generated to stabalize the vehicle (return it to neutral pitch/roll) when the vehicle is floating (more than stabalizer length from the ground.
float reverseThrustForce
Force generated by thrusting the vehicle backward.
float rollForce
Roll (rotation about the Y-axis) force applied when steering in the x-axis direction.
float stabDampingConstant
Damping spring force acting against changes in the stabalizer length.
float stabLenMax
Length of the base stabalizer when travelling at maximum speed (maxThrustSpeed).
float stabLenMin
Length of the base stabalizer when travelling at minimum speed (0).
Each tick, the vehicle performs 2 raycasts (from the center back and center front of the vehicle) to check for contact with the ground. The base stabalizer length determines the length of that raycast; if neither raycast hit the ground, the vehicle is floating, stabalizer spring and ground normal forces are not applied.
float stabSpringConstant
Value used to generate stabalizer spring force. The force generated depends on stabilizer compression, that is how close the vehicle is to the ground proportional to current stabalizer length.
float steeringForce
Yaw (rotation about the Z-axis) force applied when steering in the x-axis direction.about the vehicle's Z-axis)
float strafeThrustForce
Force generated by thrusting the vehicle to one side.
Also used to determine the vehicle's maxThrustSpeed.
float triggerTrailHeight
Maximum height above surface to emit dust trail particles.
If the vehicle is less than triggerTrailHeight above a static surface with a material that has 'showDust' set to true, the vehicle will emit particles from the dustTrailEmitter.
float turboFactor
Scale factor applied to the vehicle's thrust force when jetting.