Torque Game Engine DocumentationVersion 1.3.x
| Torque Game Engine Documentation Version 1.3.x |
ProjectileData derives from GameBaseData and is used to provide rendering, behavior, and physics data for Projectile objects.
The table below details the fields in ProjectileData. For the sake of space and clarity we will continue to omit the two fields (category and className) which children of GameBaseData inherit.
Table D.11. ProjectileData Member Fields
| Field Name | Type | Default Value | Description |
|---|---|---|---|
| Special Effects Data | |||
| particleEmitter | ParticleEmitterDataPtr | NULL | Points to the ParticleEmitter datablock used to generate particles for the projectile when it is out of water, and when entering or leaving water. Must adhere to the semantics associated with the ParticleEmitterDataPtr datatype, as defined in the engine. |
| particleWaterEmitter | ParticleEmitterDataPtr | NULL | Points to the ParticleEmitter datablock used to generate particles for the projectile when it is under water, and when it is entering or leaving water. Both the basic particleEmitter and that particleWaterEmitter are used to generate particles when the Projectile object is coming out of or entering water. Must adhere to the semantics associated with the ParticleEmitterDataPtr datatype, as defined in the engine. |
| explosion | ExplosionDataPtr | NULL | Points to the ExplosionData datablock used when the Projectile object blows up out of water. Must adhere to the semantics associated with the ExplosionDataPtr datatype, as defined in the engine. |
| waterExplosion | ExplosionDataPtr | NULL | Points to the ExplosionData datablock used when the Projectile object blows up in the water. Must adhere to the semantics associated with the ExplosionDataPtr datatype, as defined in the engine. |
| sound | AudioProfilePtr | NULL | Points to the AudioProfile used to generate the Projectile object's sound. Must adhere to the semantics associated with the AudioProfilePtr datatype, as defined in the engine. |
| splash | SplashDataPtr | NULL | Points to the SplashData datablock used in the generation of splash effects when the Projectile is entering or leaving water. Must adhere to the semantics associated with the SplashDataPtr datatype, as defined in the engine. |
| decal | DecalDataPtr (array) | NULL [NumDecals] | Array of pointers to DecalData datablocks. A non-NULL decal object will be randomly chosen from the array when the Projectile collides with the terrain or an interior. Values in the array must adhere to the semantics associated with the DecalDataPtr datatype, as defined in the engine. |
| Rendering Data | |||
| projectileShapeName | Filename | NULL | The name of the shape file for the Projectile object. Must adhere to the semantics associated with the Filename datatype as defined in the engine. |
| hasLight | Boolean | False | Specifies whether the Projectile object sheds light when not in water. If so, a point light object is used with the radius and color specified in the lightRadius and lightColor fields. |
| hasWaterLight | Boolean | False | Specifies whether the Projectile object sheds light when in water. If so, a point light object is used with the radius and color specified in the lightRadius and waterLightColor fields. |
| lightRadius | Float | 1.0 | The projectile's point light radius. Valid range is 1.0 to 20.0 |
| lightColor | ColorF | (1.0, 1.0, 1.0) | The projectile's point light color for use when not in water. |
| waterLightColor | ColorF | (1.0, 1.0, 1.0) | The projectile's point light color for use when in water. |
| Scale | Point3F | (1.0, 1.0, 1.0) | The rendering scale transformations to be applied along the shape's x-, y-, and z- axes, respectively. |
| Behavior Data | |||
| lifetime | Integer | 62 | The number of ticks the Projectile should survive for. Also used along with fadeDelay to determine the transparency of the Projectile object at a given time. See the fadeDelay field documentation for more information. The valid range for lifetime values is 0 to Projectile::MaxLivingTicks (4095 by default). |
| armingDelay | Integer | 0 | The number of ticks that must pass after the Projectile is created before it can explode. Valid range is 0 to Projectile::MaxLivingTicks (4095 by default). |
| fadeDelay | Integer | 62 | The number of ticks that must pass after the Projectile is created before it will begin becoming transparent. Projectile's opacity will follow a linear degression starting fadeDelay number of ticks after it is creating and ending at lifetime number of ticks. Valid range is 0 to Projectile::MaxLivingTicks (4095 by default). |
| Physics Data | |||
| isBallistic | Boolean | False | Specifies whether the Projectile will be affected by gravity, and whether it can bounce before exploding. |
| velInheritFactor | Float | 1.0 | Note: this field currently has no tangible effect in the engine simulation itself, but it is useful in script, and its valid range is checked by the engine. Valid range is from 0.0 to 1.0. |
| muzzleVelocity | Float | 50.0 | Note: this field currently has no tangible effect in the engine simulation itself, but it is useful in script, and its valid range is checked by the engine. Valid range is from 0.0 to 10,000.0 |
| bounceElasticity | Float | 0.999 | Used to simulate the Projectile's bounce elasticity, if it collides with something but does not explode. The bounce elasticity scales the velocity from a bounce, after friction is taken into account. Valid range is from 0.0 to 0.999. |
| gravityMod | Float | 1.0 | If isBallistic is true, scales the effect of gravity on the Projectile. Valid range is 0.0 to 1.0. |
In the next section we examine DebrisData, which also dervies from GameBaseData.