class
#include <Spore ModAPI/Spore/UTFWin/Effect.h>
IBiStateEffect
Base classes
- class UTFWinObject
Derived classes
- class BiStateEffect
Public static variables
Public functions
- auto ToWinProc() -> IWinProc* pure virtual
- Get the IWinProc instance that represents this class.
- auto GetTime() const -> float pure virtual
- Get the duration of the effect.
- auto SetTime(float value) -> void pure virtual
- Set the duration of the effect.
- auto GetTriggerType() const -> TriggerType pure virtual
- Get the type of event that triggers this effect, in the TriggerType enum.
- auto SetTriggerType(TriggerType value) -> void pure virtual
- Set the type of event that triggers this effect, in the TriggerType enum.
- auto GetEase(float& easeIn, float& easeOut) const -> void pure virtual
- Get ease-in and ease-out time, between 0 and 1.
- auto SetEase(float easeIn, float easeOut) -> void pure virtual
- Set ease-in and ease-out time, between 0 and 1.
- auto GetInterpolationType() const -> InterpolationType pure virtual
- Get the interpolation type for the effect envelope, in the InterpolationType enum.
- auto SetInterpolationType(InterpolationType value) -> void pure virtual
- Set the interpolation type for the effect envelope, in the InterpolationType enum.
- auto GetDamping() const -> float pure virtual
- Get spring damping factor (0-1).
- auto SetDamping(float value) -> void pure virtual
- Set spring damping factor (0-1).
Function documentation
void UTFWin:: IBiStateEffect:: SetTriggerType(TriggerType value) pure virtual
Set the type of event that triggers this effect, in the TriggerType enum.
Parameters | |
---|---|
value | The new type of event, in the TriggerType value. |
void UTFWin:: IBiStateEffect:: SetInterpolationType(InterpolationType value) pure virtual
Set the interpolation type for the effect envelope, in the InterpolationType enum.
Parameters | |
---|---|
value | The new interpolation type, in the InterpolationType enum. |
void UTFWin:: IBiStateEffect:: SetDamping(float value) pure virtual
Set spring damping factor (0-1).
Parameters | |
---|---|
value |