sc2-gamedata
Public Attributes | List of all members
CEffectApplyForce Class Reference

Apply Force. More...

#include <Effect.h>

Inheritance diagram for CEffectApplyForce:
Inheritance graph
[legend]
Collaboration diagram for CEffectApplyForce:
Collaboration graph
[legend]

Public Attributes

SEffectWhichLocation WhichLocation
 Location. More...
 
SEffectWhichUnit WhichUnit
 Unit. More...
 
CFixed Amount
 Amount. More...
 
CFixed MassFraction
 Mass Fraction. More...
 
SEffectWhichTimeScale TimeScaleSource
 Time Scale Source. More...
 

Detailed Description

Apply Force.

Remarks
Unknown

Member Data Documentation

◆ Amount

CFixed CEffectApplyForce::Amount

Amount.

Amount of force that is applied by the effect. Negative values draw units into the epicenter of the effect.

◆ MassFraction

CFixed CEffectApplyForce::MassFraction

Mass Fraction.

Determines how much of the affected unit’s mass value should be taken into account to modify the requested force amount. A fraction of 1 means that the unit mass will provide normal inertia. A fraction of 0 means that the mass is ignored when calculating the force to be applied.

◆ TimeScaleSource

SEffectWhichTimeScale CEffectApplyForce::TimeScaleSource

Time Scale Source.

Determines the time reference to multiply the force by.

◆ WhichLocation

SEffectWhichLocation CEffectApplyForce::WhichLocation

Location.

Location where the effect occurs

◆ WhichUnit

SEffectWhichUnit CEffectApplyForce::WhichUnit

Unit.

Specifies which unit in the effect tree to apply the force to.


The documentation for this class was generated from the following file: