Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
Strategies.Strategy Class Reference

Public Member Functions

bool Activate ()
 
bool CanBeActivated (out string reason)
 
bool CanBeDeactivated (out string reason)
 
bool Deactivate ()
 
void Load (ConfigNode node)
 
void Register ()
 
void Save (ConfigNode node)
 
void Unregister ()
 
void Update ()
 

Static Public Member Functions

static Strategy Create (System.Type type, StrategyConfig config)
 

Protected Member Functions

virtual bool CanActivate (ref string reason)
 
virtual bool CanDeactivate (ref string reason)
 
float FactorLerp (float minValue, float maxValue)
 
double FactorLerp (double minValue, double maxValue)
 
virtual string GetEffectText ()
 
virtual string GetText ()
 
virtual string MessageDeactivatedMaxTime ()
 
virtual void OnLoad (ConfigNode node)
 
virtual void OnRegister ()
 
virtual void OnSave (ConfigNode node)
 
virtual void OnUnregister ()
 
virtual void OnUpdate ()
 
void SendStateMessage (string title, string message, MessageSystemButton.MessageButtonColor color, MessageSystemButton.ButtonIcons icon)
 

Protected Attributes

float factor
 
float factorSliderDefault
 
int factorSliderSteps
 
bool hasFactorSlider
 
float initialCostFundsMax
 
float initialCostFundsMin
 
float initialCostReputationMax
 
float initialCostReputationMin
 
float initialCostScienceMax
 
float initialCostScienceMin
 
double maxLeastDuration
 
double maxLongestDuration
 
double minLeastDuration
 
double minLongestDuration
 
float requiredReputationMax
 
float requiredReputationMin
 

Properties

StrategyConfig Config [get, set]
 
double DateActivated [get]
 Date/time at which that this stragey was activated More...
 
DepartmentConfig Department [get]
 department config name for this buff. only one buff per category is allowed More...
 
string DepartmentName [get]
 string category name for this buff. only one buff per category is allowed More...
 
string Description [get]
 long description More...
 
string Effect [get]
 Returns the list of effects as text More...
 
List< StrategyEffectEffects [get]
 
float Factor [get, set]
 a designer defined factor for ease of balancing. this modifies all GameBuffEffect's in the effects list can also be set via the optional slider More...
 
float FactorSliderDefault [get]
 Optional: Slider's default value More...
 
int FactorSliderSteps [get]
 Optional: Number of steps that the slider has (0 if analogue) More...
 
string[] GroupTags [get]
 group tags, used to match conflicting strategies More...
 
bool HasFactorSlider [get]
 Optional: boolean to show/hide factor slider in buff enactment window. NOTE: Once the buff is enacted, the slider is no longer shown. More...
 
float InitialCostFunds [get]
 
float InitialCostFundsMax [get]
 Optional: Initial monetary cost to enact this buff More...
 
float InitialCostFundsMin [get]
 Optional: Initial monetary cost to enact this buff More...
 
float InitialCostReputation [get]
 
float InitialCostReputationMax [get]
 Optional: Initial reputation cost to enact this buff More...
 
float InitialCostReputationMin [get]
 Optional: Initial reputation cost to enact this buff More...
 
float InitialCostScience [get]
 
float InitialCostScienceMax [get]
 Optional: Initial science cost to enact this buff More...
 
float InitialCostScienceMin [get]
 Optional: Initial science cost to enact this buff More...
 
bool IsActive [get]
 Boolean denoting if this strategy is currently active More...
 
double LeastDuration [get]
 Optional: The least amount of time this strategy must be active for before cancellation is allowed. More...
 
double LongestDuration [get]
 Optional: The longest possible amount of time this strategy may be active for. More...
 
double MaxLeastDuration [get]
 
double MaxLongestDuration [get]
 
double MinLeastDuration [get]
 
double MinLongestDuration [get]
 
bool NoDuration [get]
 Return True if there is No Duration for this strategy. It's a one time event. More...
 
float RequiredReputation [get]
 
float RequiredReputationMax [get]
 
float RequiredReputationMin [get]
 
string Text [get]
 Returns the compiled Administration building text More...
 
string Title [get]
 title for the buff to display in SC building More...
 

Member Function Documentation

bool Strategies.Strategy.Activate ( )
inline
virtual bool Strategies.Strategy.CanActivate ( ref string  reason)
inlineprotectedvirtual
bool Strategies.Strategy.CanBeActivated ( out string  reason)
inline
bool Strategies.Strategy.CanBeDeactivated ( out string  reason)
inline
virtual bool Strategies.Strategy.CanDeactivate ( ref string  reason)
inlineprotectedvirtual
static Strategy Strategies.Strategy.Create ( System.Type  type,
StrategyConfig  config 
)
inlinestatic
bool Strategies.Strategy.Deactivate ( )
inline
float Strategies.Strategy.FactorLerp ( float  minValue,
float  maxValue 
)
inlineprotected
double Strategies.Strategy.FactorLerp ( double  minValue,
double  maxValue 
)
inlineprotected
virtual string Strategies.Strategy.GetEffectText ( )
inlineprotectedvirtual

< Effects

< active/inactive vars

virtual string Strategies.Strategy.GetText ( )
inlineprotectedvirtual

< Description

< active/inactive vars

void Strategies.Strategy.Load ( ConfigNode  node)
inline
virtual string Strategies.Strategy.MessageDeactivatedMaxTime ( )
inlineprotectedvirtual
virtual void Strategies.Strategy.OnLoad ( ConfigNode  node)
inlineprotectedvirtual
virtual void Strategies.Strategy.OnRegister ( )
inlineprotectedvirtual
virtual void Strategies.Strategy.OnSave ( ConfigNode  node)
inlineprotectedvirtual
virtual void Strategies.Strategy.OnUnregister ( )
inlineprotectedvirtual
virtual void Strategies.Strategy.OnUpdate ( )
inlineprotectedvirtual
void Strategies.Strategy.Register ( )
inline
void Strategies.Strategy.Save ( ConfigNode  node)
inline
void Strategies.Strategy.SendStateMessage ( string  title,
string  message,
MessageSystemButton.MessageButtonColor  color,
MessageSystemButton.ButtonIcons  icon 
)
inlineprotected
void Strategies.Strategy.Unregister ( )
inline
void Strategies.Strategy.Update ( )
inline

Member Data Documentation

float Strategies.Strategy.factor
protected
float Strategies.Strategy.factorSliderDefault
protected
int Strategies.Strategy.factorSliderSteps
protected
bool Strategies.Strategy.hasFactorSlider
protected
float Strategies.Strategy.initialCostFundsMax
protected
float Strategies.Strategy.initialCostFundsMin
protected
float Strategies.Strategy.initialCostReputationMax
protected
float Strategies.Strategy.initialCostReputationMin
protected
float Strategies.Strategy.initialCostScienceMax
protected
float Strategies.Strategy.initialCostScienceMin
protected
double Strategies.Strategy.maxLeastDuration
protected
double Strategies.Strategy.maxLongestDuration
protected
double Strategies.Strategy.minLeastDuration
protected
double Strategies.Strategy.minLongestDuration
protected
float Strategies.Strategy.requiredReputationMax
protected
float Strategies.Strategy.requiredReputationMin
protected

Property Documentation

StrategyConfig Strategies.Strategy.Config
getset
double Strategies.Strategy.DateActivated
get

Date/time at which that this stragey was activated

DepartmentConfig Strategies.Strategy.Department
get

department config name for this buff. only one buff per category is allowed

string Strategies.Strategy.DepartmentName
get

string category name for this buff. only one buff per category is allowed

string Strategies.Strategy.Description
get

long description

string Strategies.Strategy.Effect
get

Returns the list of effects as text

List<StrategyEffect> Strategies.Strategy.Effects
get
float Strategies.Strategy.Factor
getset

a designer defined factor for ease of balancing. this modifies all GameBuffEffect's in the effects list can also be set via the optional slider

float Strategies.Strategy.FactorSliderDefault
get

Optional: Slider's default value

int Strategies.Strategy.FactorSliderSteps
get

Optional: Number of steps that the slider has (0 if analogue)

string [] Strategies.Strategy.GroupTags
get

group tags, used to match conflicting strategies

bool Strategies.Strategy.HasFactorSlider
get

Optional: boolean to show/hide factor slider in buff enactment window. NOTE: Once the buff is enacted, the slider is no longer shown.

float Strategies.Strategy.InitialCostFunds
get
float Strategies.Strategy.InitialCostFundsMax
get

Optional: Initial monetary cost to enact this buff

float Strategies.Strategy.InitialCostFundsMin
get

Optional: Initial monetary cost to enact this buff

float Strategies.Strategy.InitialCostReputation
get
float Strategies.Strategy.InitialCostReputationMax
get

Optional: Initial reputation cost to enact this buff

float Strategies.Strategy.InitialCostReputationMin
get

Optional: Initial reputation cost to enact this buff

float Strategies.Strategy.InitialCostScience
get
float Strategies.Strategy.InitialCostScienceMax
get

Optional: Initial science cost to enact this buff

float Strategies.Strategy.InitialCostScienceMin
get

Optional: Initial science cost to enact this buff

bool Strategies.Strategy.IsActive
get

Boolean denoting if this strategy is currently active

double Strategies.Strategy.LeastDuration
get

Optional: The least amount of time this strategy must be active for before cancellation is allowed.

double Strategies.Strategy.LongestDuration
get

Optional: The longest possible amount of time this strategy may be active for.

double Strategies.Strategy.MaxLeastDuration
get
double Strategies.Strategy.MaxLongestDuration
get
double Strategies.Strategy.MinLeastDuration
get
double Strategies.Strategy.MinLongestDuration
get
bool Strategies.Strategy.NoDuration
get

Return True if there is No Duration for this strategy. It's a one time event.

float Strategies.Strategy.RequiredReputation
get
float Strategies.Strategy.RequiredReputationMax
get
float Strategies.Strategy.RequiredReputationMin
get
string Strategies.Strategy.Text
get

Returns the compiled Administration building text

string Strategies.Strategy.Title
get

title for the buff to display in SC building


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