Main   Class List   Namespace List   Wiki

ForestWindEmitter Class Reference
[Special EffectsForest]

Object responsible for simulating wind in a level. More...

Inheritance diagram for ForestWindEmitter:
Inheritance graph
[legend]

List of all members.

Public Member Functions

void attachToObject (int objectID)
 Mounts the wind emitter to another scene object.

Public Attributes

ForestWind

float gustFrequency
 The frequency of gusting in seconds.
float gustStrength
 The maximum strength of a gust.
float gustWobbleStrength
 The amount of random wobble added to gust and turbulence vectors.
float gustYawAngle
 The amount of degrees the wind direction can drift (both positive and negative).
float gustYawFrequency
 The frequency of wind yaw drift, in seconds.
bool hasMount
 Determines if the emitter is mounted to another object.
bool radialEmitter
 Determines if the emitter is a global direction or local radial emitter.
float radius
 The radius of the emitter for local radial emitters.
float strength
 The strength of the wind force.
float turbulenceFrequency
 The frequency of gust turbulence, in seconds.
float turbulenceStrength
 The strength of gust turbulence.
bool windEnabled
 Determines if the emitter will be counted in wind calculations.

Static Public Attributes

static bool isRenderable
 Disables rendering of all instances of this type.
static bool isSelectable
 Disables selection of all instances of this type.

Detailed Description

Object responsible for simulating wind in a level.

When placed in the level, a ForestWindEmitter will cause tree branches to bend and sway, leaves to flutter, and create vertical bending on the tree's trunk.

Example:
// The following is a full declaration of a wind emitter
new ForestWindEmitter()
{
   position = "497.739 765.821 102.395";
   windEnabled = "1";
   radialEmitter = "1";
   strength = "1";
   radius = "3";
   gustStrength = "0.5";
   gustFrequency = "1";
   gustYawAngle = "10";
   gustYawFrequency = "4";
   gustWobbleStrength = "2";
   turbulenceStrength = "1";
   turbulenceFrequency = "2";
   hasMount = "0";
   scale = "3 3 3";
   canSave = "1";
   canSaveDynamicFields = "1";
   rotation = "1 0 0 0";
};

Member Function Documentation

void ForestWindEmitter::attachToObject ( int  objectID  ) 

Mounts the wind emitter to another scene object.

Parameters:
objectID Unique ID of the object wind emitter should attach to
Example:
// Wind emitter previously created and named %windEmitter
// Going to attach it to the player, making him a walking wind storm
%windEmitter.attachToObject(%player);

Member Data Documentation

The frequency of gusting in seconds.

The maximum strength of a gust.

The amount of random wobble added to gust and turbulence vectors.

The amount of degrees the wind direction can drift (both positive and negative).

The frequency of wind yaw drift, in seconds.

Determines if the emitter is mounted to another object.

Disables rendering of all instances of this type.

Reimplemented from SceneObject.

Disables selection of all instances of this type.

Reimplemented from SceneObject.

Determines if the emitter is a global direction or local radial emitter.

The radius of the emitter for local radial emitters.

The strength of the wind force.

The frequency of gust turbulence, in seconds.

The strength of gust turbulence.

Determines if the emitter will be counted in wind calculations.



Copyright © GarageGames, LLC. All Rights Reserved.