afxZodiacData

consoledoc.h

A datablock that specifies a decal-like Zodiac effect.

More...

Public Attributes

bool

When true, zodiac fades out as altitude increases.

float

The altitude at which zodiac begins to fade and/or shrink.

float

The altitude at which zodiac becomes invisible as the result of fading out or becoming too small.

bool

When true, zodiac becomes smaller as altitude increases.

A blending style for the zodiac. Possible values: normal, additive, or subtractive.

LinearColorF

A color value for the zodiac.

float

The distance from camera at which the zodiac begins to fade out.

float

The distance from camera at which the zodiac becomes invisible as the result of fading out.

Point2F

Zodiac will render on polygons with gradients within the range specified by gradientRange. 0 for floor polys, 90 for wall polys, 180 for ceiling polys.

float

A duration of time in seconds over which the zodiac grows from a zero size to its full size as specified by the radius.

float

A rate in meters-per-second at which the zodiac grows in size. A negative value will shrink the zodiac.

bool

Specifies if interior zodiacs should be rendered exclusively on perfectly horizontal interior surfaces.

bool

Specifies if interior zodiacs should not be rendered on interior surface which are backfacing to the zodiac's center.

bool

Specifies if interior zodiacs should not be rendered on perfectly vertical interior surfaces.

bool

When true, the zodiac will render on polygons with gradients outside of the range specified by gradientRange.

bool

When true, a gradientRange specified on an InteriorInstance or TSStatic will be used instead of the zodiac's gradientRange.

float

The zodiac's radius in scene units.

float

The rate of rotation in degrees-per-second. Zodiacs with a positive rotationRate rotate clockwise, while those with negative values turn counter-clockwise.

bool

Specifies if the zodiac's verticalRange should scale according to changes in the radius. When a zodiacs is used as an expanding shockwave, this value should be set to false, otherwise the zodiac can expand to cover an entire interior.

bool

Specifies if the zodiac should be rendered on the non-reflection rendering pass of the object it will be projected onto.

bool

Specifies if the zodiac should be rendered on the reflection rendering pass of the object it will be projected onto.

bool

Specifies if the zodiac should be rendered on interior or interior-like surfaces.

bool

Specifies if the zodiac should be rendered on terrain or terrain-like surfaces.

float

A duration of time in seconds over which the zodiac shrinks from full size to invisible.

float

The starting angle in degrees of the zodiac's rotation.

filename

An image to use as the zodiac's texture.

bool

Specifies if the zodiac's rotation should be defined by its constrained transformation.

bool

When true, gradientRange will be used to determine on which polygons the zodiac will render.

Point2F

For interior zodiacs only, verticalRange specifies distances above and below the zodiac's position. If both values are 0.0, the radius is used.

Detailed Description

A datablock that specifies a decal-like Zodiac effect.

Zodiacs are special-purpose decal textures, often circular, that are always projected vertically onto the ground. Parameters control dynamic rotation and scale as well as texture, color, and blending style.

Zodiacs render on objects of type TerrainBlock, InteriorInstance, GroundPlane, MeshRoad, and TSStatic. They are very effective as spellcasting lighting rings, explosion shockwaves, scorched earth decals, and selection indicators.

Public Attributes

bool altitudeFades 

When true, zodiac fades out as altitude increases.

float altitudeFalloff 

The altitude at which zodiac begins to fade and/or shrink.

float altitudeMax 

The altitude at which zodiac becomes invisible as the result of fading out or becoming too small.

bool altitudeShrinks 

When true, zodiac becomes smaller as altitude increases.

afxZodiac_BlendType blend 

A blending style for the zodiac. Possible values: normal, additive, or subtractive.

LinearColorF color 

A color value for the zodiac.

float distanceFalloff 

The distance from camera at which the zodiac begins to fade out.

float distanceMax 

The distance from camera at which the zodiac becomes invisible as the result of fading out.

Point2F gradientRange 

Zodiac will render on polygons with gradients within the range specified by gradientRange. 0 for floor polys, 90 for wall polys, 180 for ceiling polys.

float growInTime 

A duration of time in seconds over which the zodiac grows from a zero size to its full size as specified by the radius.

float growthRate 

A rate in meters-per-second at which the zodiac grows in size. A negative value will shrink the zodiac.

bool interiorHorizontalOnly 

Specifies if interior zodiacs should be rendered exclusively on perfectly horizontal interior surfaces.

bool interiorIgnoreBackfaces 

Specifies if interior zodiacs should not be rendered on interior surface which are backfacing to the zodiac's center.

bool interiorIgnoreOpaque 
bool interiorIgnoreTransparent 
bool interiorIgnoreVertical 

Specifies if interior zodiacs should not be rendered on perfectly vertical interior surfaces.

bool invertGradientRange 

When true, the zodiac will render on polygons with gradients outside of the range specified by gradientRange.

bool preferDestinationGradients 

When true, a gradientRange specified on an InteriorInstance or TSStatic will be used instead of the zodiac's gradientRange.

float radius 

The zodiac's radius in scene units.

float rotationRate 

The rate of rotation in degrees-per-second. Zodiacs with a positive rotationRate rotate clockwise, while those with negative values turn counter-clockwise.

bool scaleVerticalRange 

Specifies if the zodiac's verticalRange should scale according to changes in the radius. When a zodiacs is used as an expanding shockwave, this value should be set to false, otherwise the zodiac can expand to cover an entire interior.

bool showInNonReflections 

Specifies if the zodiac should be rendered on the non-reflection rendering pass of the object it will be projected onto.

bool showInReflections 

Specifies if the zodiac should be rendered on the reflection rendering pass of the object it will be projected onto.

bool showOnInteriors 

Specifies if the zodiac should be rendered on interior or interior-like surfaces.

bool showOnTerrain 

Specifies if the zodiac should be rendered on terrain or terrain-like surfaces.

float shrinkOutTime 

A duration of time in seconds over which the zodiac shrinks from full size to invisible.

float startAngle 

The starting angle in degrees of the zodiac's rotation.

filename texture 

An image to use as the zodiac's texture.

bool trackOrientConstraint 

Specifies if the zodiac's rotation should be defined by its constrained transformation.

bool useGradientRange 

When true, gradientRange will be used to determine on which polygons the zodiac will render.

Point2F verticalRange 

For interior zodiacs only, verticalRange specifies distances above and below the zodiac's position. If both values are 0.0, the radius is used.