Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | Properties | List of all members
Strategies.StrategyEffect Class Reference
Inheritance diagram for Strategies.StrategyEffect:
Strategies.CurrencyExchanger Strategies.Effects.CurrencyConverter Strategies.Effects.CurrencyOperation Strategies.Effects.ValueModifier

Public Member Functions

virtual bool CanActivate (ref string reason)
 
void Load (ConfigNode node)
 
void LoadFromConfig (ConfigNode node)
 
void Register ()
 If active, registers itself in GameEvents.Buffs More...
 
void Save (ConfigNode node)
 
 StrategyEffect (Strategy parent)
 
void Unregister ()
 Removes itself from all events More...
 
void Update ()
 Called once per frame when strategy is active More...
 

Protected Member Functions

virtual string GetDescription ()
 Description of this effect as set by designer of the GameBuffEffect Can be overridden by the parent GameBuff if required More...
 
virtual void OnLoad (ConfigNode node)
 
virtual void OnLoadFromConfig (ConfigNode node)
 
virtual void OnRegister ()
 
virtual void OnSave (ConfigNode node)
 
virtual void OnUnregister ()
 
virtual void OnUpdate ()
 
float ParentLerp (float minValue, float maxValue)
 
string ToPercentage (float percentage, string format="F0")
 

Properties

string Description [get]
 
Strategy Parent [get]
 Parent Strategy that this effect is attached to More...
 

Constructor & Destructor Documentation

Strategies.StrategyEffect.StrategyEffect ( Strategy  parent)
inline

Member Function Documentation

virtual bool Strategies.StrategyEffect.CanActivate ( ref string  reason)
inlinevirtual
virtual string Strategies.StrategyEffect.GetDescription ( )
inlineprotectedvirtual

Description of this effect as set by designer of the GameBuffEffect Can be overridden by the parent GameBuff if required

Reimplemented in Strategies.Effects.CurrencyConverter, Strategies.CurrencyExchanger, Strategies.Effects.CurrencyOperation, and Strategies.Effects.ValueModifier.

void Strategies.StrategyEffect.Load ( ConfigNode  node)
inline
void Strategies.StrategyEffect.LoadFromConfig ( ConfigNode  node)
inline
virtual void Strategies.StrategyEffect.OnLoad ( ConfigNode  node)
inlineprotectedvirtual
virtual void Strategies.StrategyEffect.OnLoadFromConfig ( ConfigNode  node)
inlineprotectedvirtual
virtual void Strategies.StrategyEffect.OnRegister ( )
inlineprotectedvirtual
virtual void Strategies.StrategyEffect.OnSave ( ConfigNode  node)
inlineprotectedvirtual
virtual void Strategies.StrategyEffect.OnUnregister ( )
inlineprotectedvirtual
virtual void Strategies.StrategyEffect.OnUpdate ( )
inlineprotectedvirtual
float Strategies.StrategyEffect.ParentLerp ( float  minValue,
float  maxValue 
)
inlineprotected
void Strategies.StrategyEffect.Register ( )
inline

If active, registers itself in GameEvents.Buffs

void Strategies.StrategyEffect.Save ( ConfigNode  node)
inline
string Strategies.StrategyEffect.ToPercentage ( float  percentage,
string  format = "F0" 
)
inlineprotected
void Strategies.StrategyEffect.Unregister ( )
inline

Removes itself from all events

void Strategies.StrategyEffect.Update ( )
inline

Called once per frame when strategy is active

Property Documentation

string Strategies.StrategyEffect.Description
get
Strategy Strategies.StrategyEffect.Parent
get

Parent Strategy that this effect is attached to


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