KSP API
Public Types | Public Member Functions | Static Public Member Functions | Public Attributes | Protected Types | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Properties | List of all members
Contracts.Contract Class Reference
Inheritance diagram for Contracts.Contract:

Public Types

enum  ContractPrestige { ContractPrestige.Trivial = 0, ContractPrestige.Significant = 1, ContractPrestige.Exceptional = 2 }
 
enum  DeadlineType { DeadlineType.Fixed = 0, DeadlineType.Floating = 1, DeadlineType.None = 2 }
 
enum  State {
  State.Generated = 0, State.Offered = 1, State.OfferExpired = 2, State.Declined = 3,
  State.Cancelled = 4, State.Active = 5, State.Completed = 6, State.DeadlineExpired = 7,
  State.Failed = 8, State.Withdrawn = 9
}
 

Public Member Functions

 Contract ()
 
bool Accept ()
 
ContractParameter AddParameter (ContractParameter parameter, string id=null)
 
virtual bool CanBeCancelled ()
 
virtual bool CanBeDeclined ()
 
bool Cancel ()
 
bool Complete ()
 
bool Decline ()
 
bool Fail ()
 
void GenerateFailed ()
 
GetParameter< T > (string id=null)
 
ContractParameter GetParameter (int index)
 
ContractParameter GetParameter (string id)
 
ContractParameter GetParameter (Type type)
 
bool IsFinished ()
 
void Kill ()
 
virtual bool MeetRequirements ()
 
virtual string MissionControlTextRich ()
 
bool Offer ()
 
void ParameterStateUpdate (ContractParameter p)
 
void Register ()
 
void RemoveParameter (ContractParameter parameter)
 
void RemoveParameter (int index)
 
void RemoveParameter (string id)
 
void RemoveParameter (Type type)
 
void Save (ConfigNode node)
 
void Unregister ()
 
void Update ()
 
void Withdraw ()
 

Static Public Member Functions

static Contract Generate (Type contractType, Contract.ContractPrestige difficulty, int seed, Contract.State state)
 
static Contract Load (Contract contract, ConfigNode node)
 

Public Attributes

bool AutoAccept
 
double FundsAdvance
 
double FundsCompletion
 
double FundsFailure
 
EventData< Contract.StateOnStateChange
 
float ReputationCompletion
 
float ReputationFailure
 
float ScienceCompletion
 
double TimeDeadline
 
double TimeExpiry
 

Protected Types

enum  ProgressState { ProgressState.Unreached = 0, ProgressState.Reached = 1, ProgressState.Complete = 2 }
 

Protected Member Functions

bool AddKeywords (params string[] keywords)
 
bool AddKeywordsRequired (params string[] keywords)
 
virtual void AwardAdvance ()
 
virtual void AwardCompletion ()
 
virtual bool Generate ()
 
virtual string GetDescription ()
 
float GetDestinationWeight (CelestialBody body)
 
virtual string GetHashString ()
 
virtual string GetNotes ()
 
virtual string GetSynopsys ()
 
virtual string GetTitle ()
 
virtual string MessageAccepted ()
 
virtual string MessageAdvances ()
 
virtual string MessageCancellationPenalties (double fundsPenalty, float repPenalty)
 
virtual string MessageCancelled ()
 
virtual string MessageCompleted ()
 
virtual string MessageDeadlineExpired ()
 
virtual string MessageFailed ()
 
virtual string MessageFailurePenalties ()
 
virtual string MessageOffered ()
 
virtual string MessageOfferExpired ()
 
virtual string MessageRewards ()
 
string MissionNotes ()
 
string MissionParameter (ContractParameter parameter, int indent)
 
virtual void OnAccepted ()
 
virtual void OnCancelled ()
 
virtual void OnCompleted ()
 
virtual void OnDeadlineExpired ()
 
virtual void OnDeclined ()
 
virtual void OnFailed ()
 
virtual void OnFinished ()
 
virtual void OnGenerateFailed ()
 
virtual void OnLoad (ConfigNode node)
 
virtual void OnOffered ()
 
virtual void OnOfferExpired ()
 
virtual void OnParameterStateChange (ContractParameter p)
 
virtual void OnRegister ()
 
virtual void OnSave (ConfigNode node)
 
virtual void OnUnregister ()
 
virtual void OnUpdate ()
 
virtual void OnWithdrawn ()
 
virtual void PenalizeCancellation ()
 
virtual void PenalizeFailure ()
 
void SendStateMessage (string title, string message, MessageSystemButton.MessageButtonColor color, MessageSystemButton.ButtonIcons icon)
 
void SetDeadlineDays (float days, CelestialBody body=null)
 
void SetDeadlineYears (float years, CelestialBody body=null)
 
void SetExpiry ()
 
void SetExpiry (float minDays, float maxDays)
 
void SetExpiry (int minDays, int maxDays)
 
void SetFunds (float advance, float completion, CelestialBody body=null)
 
void SetFunds (float advance, float completion, float failure, CelestialBody body=null)
 
void SetReputation (float completion, CelestialBody body=null)
 
void SetReputation (float completion, float failure, CelestialBody body=null)
 
void SetScience (float completion, CelestialBody body=null)
 
void SetState (Contract.State newState)
 

Static Protected Member Functions

static int CountBodies_Complete (bool includeKerbin, bool includeSun, string nodeComplete)
 
static int CountBodies_Reached (bool includeKerbin, bool includeSun)
 
static List< CelestialBodyGetBodies (bool includeKerbin, bool includeSun)
 
static List< CelestialBodyGetBodies (Contract.ProgressState bodyState, Func< CelestialBody, bool > where=null)
 
static List< CelestialBodyGetBodies (string nodeName, Contract.ProgressState nodeState, Func< CelestialBody, bool > where=null)
 
static List< CelestialBodyGetBodies (Contract.ProgressState bodyState, string nodeName, Contract.ProgressState nodeState, Func< CelestialBody, bool > where=null)
 
static List< CelestialBodyGetBodies_Complete (bool includeKerbin, bool includeSun, string complete)
 
static List< CelestialBodyGetBodies_InComplete (bool includeKerbin, bool includeSun, string notComplete)
 
static List< CelestialBodyGetBodies_NextUnreached (int depth, Func< CelestialBody, bool > where=null)
 
static List< CelestialBodyGetBodies_NotReached (bool includeKerbin, bool includeSun)
 
static List< CelestialBodyGetBodies_Reached (bool includeKerbin, bool includeSun)
 

Protected Attributes

Agent agent
 
double dateAccepted
 
double dateDeadline
 
double dateExpire
 
double dateFinished
 
Contract.DeadlineType deadlineType
 
Contract.DeadlineType expiryType
 
Contract.ContractPrestige prestige
 

Properties

Agent Agent [get]
 
IEnumerable< ContractParameterAllParameters [get]
 
Guid ContractGuid [get]
 
long ContractID [get]
 
static int contractsInExistance [get]
 
Contract.State ContractState [get]
 
double DateAccepted [get]
 
double DateDeadline [get]
 
double DateExpire [get]
 
double DateFinished [get]
 
string Description [get]
 
static double GameTime [get]
 
List< string > Keywords [get]
 
List< string > KeywordsRequired [get]
 
int MissionSeed [get]
 
string Notes [get]
 
int ParameterCount [get]
 
IContractParameterHost Parent [get]
 
Contract.ContractPrestige Prestige [get]
 
Contract Root [get]
 
string Synopsys [get]
 
string Title [get]
 
ContractParameter this[int index] [get]
 
ContractParameter this[string id] [get]
 
ContractParameter this[Type type] [get]
 

Member Enumeration Documentation

Enumerator
Trivial 
Significant 
Exceptional 
Enumerator
Fixed 
Floating 
None 
enum Contracts.Contract.ProgressState
strongprotected
Enumerator
Unreached 
Reached 
Complete 
Enumerator
Generated 
Offered 
OfferExpired 
Declined 
Cancelled 
Active 
Completed 
DeadlineExpired 
Failed 
Withdrawn 

Constructor & Destructor Documentation

Contracts.Contract.Contract ( )

Member Function Documentation

bool Contracts.Contract.Accept ( )
bool Contracts.Contract.AddKeywords ( params string[]  keywords)
protected
bool Contracts.Contract.AddKeywordsRequired ( params string[]  keywords)
protected
ContractParameter Contracts.Contract.AddParameter ( ContractParameter  parameter,
string  id = null 
)
virtual void Contracts.Contract.AwardAdvance ( )
protectedvirtual
virtual void Contracts.Contract.AwardCompletion ( )
protectedvirtual
virtual bool Contracts.Contract.CanBeCancelled ( )
virtual
virtual bool Contracts.Contract.CanBeDeclined ( )
virtual
bool Contracts.Contract.Cancel ( )
bool Contracts.Contract.Complete ( )
static int Contracts.Contract.CountBodies_Complete ( bool  includeKerbin,
bool  includeSun,
string  nodeComplete 
)
staticprotected
static int Contracts.Contract.CountBodies_Reached ( bool  includeKerbin,
bool  includeSun 
)
staticprotected
bool Contracts.Contract.Decline ( )
bool Contracts.Contract.Fail ( )
virtual bool Contracts.Contract.Generate ( )
protectedvirtual
static Contract Contracts.Contract.Generate ( Type  contractType,
Contract.ContractPrestige  difficulty,
int  seed,
Contract.State  state 
)
static
void Contracts.Contract.GenerateFailed ( )
static List<CelestialBody> Contracts.Contract.GetBodies ( bool  includeKerbin,
bool  includeSun 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies ( Contract.ProgressState  bodyState,
Func< CelestialBody, bool >  where = null 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies ( string  nodeName,
Contract.ProgressState  nodeState,
Func< CelestialBody, bool >  where = null 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies ( Contract.ProgressState  bodyState,
string  nodeName,
Contract.ProgressState  nodeState,
Func< CelestialBody, bool >  where = null 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies_Complete ( bool  includeKerbin,
bool  includeSun,
string  complete 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies_InComplete ( bool  includeKerbin,
bool  includeSun,
string  notComplete 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies_NextUnreached ( int  depth,
Func< CelestialBody, bool >  where = null 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies_NotReached ( bool  includeKerbin,
bool  includeSun 
)
staticprotected
static List<CelestialBody> Contracts.Contract.GetBodies_Reached ( bool  includeKerbin,
bool  includeSun 
)
staticprotected
virtual string Contracts.Contract.GetDescription ( )
protectedvirtual
float Contracts.Contract.GetDestinationWeight ( CelestialBody  body)
protected
virtual string Contracts.Contract.GetHashString ( )
protectedvirtual
virtual string Contracts.Contract.GetNotes ( )
protectedvirtual
ContractParameter Contracts.Contract.GetParameter ( int  index)
ContractParameter Contracts.Contract.GetParameter ( string  id)
ContractParameter Contracts.Contract.GetParameter ( Type  type)
T Contracts.Contract.GetParameter< T > ( string  id = null)
Type Constraints
T :ContractParameter 
virtual string Contracts.Contract.GetSynopsys ( )
protectedvirtual
virtual string Contracts.Contract.GetTitle ( )
protectedvirtual
bool Contracts.Contract.IsFinished ( )
void Contracts.Contract.Kill ( )
static Contract Contracts.Contract.Load ( Contract  contract,
ConfigNode  node 
)
static
virtual bool Contracts.Contract.MeetRequirements ( )
virtual
virtual string Contracts.Contract.MessageAccepted ( )
protectedvirtual
virtual string Contracts.Contract.MessageAdvances ( )
protectedvirtual
virtual string Contracts.Contract.MessageCancellationPenalties ( double  fundsPenalty,
float  repPenalty 
)
protectedvirtual
virtual string Contracts.Contract.MessageCancelled ( )
protectedvirtual
virtual string Contracts.Contract.MessageCompleted ( )
protectedvirtual
virtual string Contracts.Contract.MessageDeadlineExpired ( )
protectedvirtual
virtual string Contracts.Contract.MessageFailed ( )
protectedvirtual
virtual string Contracts.Contract.MessageFailurePenalties ( )
protectedvirtual
virtual string Contracts.Contract.MessageOffered ( )
protectedvirtual
virtual string Contracts.Contract.MessageOfferExpired ( )
protectedvirtual
virtual string Contracts.Contract.MessageRewards ( )
protectedvirtual
virtual string Contracts.Contract.MissionControlTextRich ( )
virtual
string Contracts.Contract.MissionNotes ( )
protected
string Contracts.Contract.MissionParameter ( ContractParameter  parameter,
int  indent 
)
protected
bool Contracts.Contract.Offer ( )
virtual void Contracts.Contract.OnAccepted ( )
protectedvirtual
virtual void Contracts.Contract.OnCancelled ( )
protectedvirtual
virtual void Contracts.Contract.OnCompleted ( )
protectedvirtual
virtual void Contracts.Contract.OnDeadlineExpired ( )
protectedvirtual
virtual void Contracts.Contract.OnDeclined ( )
protectedvirtual
virtual void Contracts.Contract.OnFailed ( )
protectedvirtual
virtual void Contracts.Contract.OnFinished ( )
protectedvirtual
virtual void Contracts.Contract.OnGenerateFailed ( )
protectedvirtual
virtual void Contracts.Contract.OnLoad ( ConfigNode  node)
protectedvirtual
virtual void Contracts.Contract.OnOffered ( )
protectedvirtual
virtual void Contracts.Contract.OnOfferExpired ( )
protectedvirtual
virtual void Contracts.Contract.OnParameterStateChange ( ContractParameter  p)
protectedvirtual
virtual void Contracts.Contract.OnRegister ( )
protectedvirtual
virtual void Contracts.Contract.OnSave ( ConfigNode  node)
protectedvirtual
virtual void Contracts.Contract.OnUnregister ( )
protectedvirtual
virtual void Contracts.Contract.OnUpdate ( )
protectedvirtual
virtual void Contracts.Contract.OnWithdrawn ( )
protectedvirtual
void Contracts.Contract.ParameterStateUpdate ( ContractParameter  p)
virtual void Contracts.Contract.PenalizeCancellation ( )
protectedvirtual
virtual void Contracts.Contract.PenalizeFailure ( )
protectedvirtual
void Contracts.Contract.Register ( )
void Contracts.Contract.RemoveParameter ( ContractParameter  parameter)
void Contracts.Contract.RemoveParameter ( int  index)
void Contracts.Contract.RemoveParameter ( string  id)
void Contracts.Contract.RemoveParameter ( Type  type)
void Contracts.Contract.Save ( ConfigNode  node)
void Contracts.Contract.SendStateMessage ( string  title,
string  message,
MessageSystemButton.MessageButtonColor  color,
MessageSystemButton.ButtonIcons  icon 
)
protected
void Contracts.Contract.SetDeadlineDays ( float  days,
CelestialBody  body = null 
)
protected
void Contracts.Contract.SetDeadlineYears ( float  years,
CelestialBody  body = null 
)
protected
void Contracts.Contract.SetExpiry ( )
protected
void Contracts.Contract.SetExpiry ( float  minDays,
float  maxDays 
)
protected
void Contracts.Contract.SetExpiry ( int  minDays,
int  maxDays 
)
protected
void Contracts.Contract.SetFunds ( float  advance,
float  completion,
CelestialBody  body = null 
)
protected
void Contracts.Contract.SetFunds ( float  advance,
float  completion,
float  failure,
CelestialBody  body = null 
)
protected
void Contracts.Contract.SetReputation ( float  completion,
CelestialBody  body = null 
)
protected
void Contracts.Contract.SetReputation ( float  completion,
float  failure,
CelestialBody  body = null 
)
protected
void Contracts.Contract.SetScience ( float  completion,
CelestialBody  body = null 
)
protected
void Contracts.Contract.SetState ( Contract.State  newState)
protected
void Contracts.Contract.Unregister ( )
void Contracts.Contract.Update ( )
void Contracts.Contract.Withdraw ( )

Member Data Documentation

Agent Contracts.Contract.agent
protected
bool Contracts.Contract.AutoAccept
double Contracts.Contract.dateAccepted
protected
double Contracts.Contract.dateDeadline
protected
double Contracts.Contract.dateExpire
protected
double Contracts.Contract.dateFinished
protected
Contract.DeadlineType Contracts.Contract.deadlineType
protected
Contract.DeadlineType Contracts.Contract.expiryType
protected
double Contracts.Contract.FundsAdvance
double Contracts.Contract.FundsCompletion
double Contracts.Contract.FundsFailure
EventData<Contract.State> Contracts.Contract.OnStateChange
Contract.ContractPrestige Contracts.Contract.prestige
protected
float Contracts.Contract.ReputationCompletion
float Contracts.Contract.ReputationFailure
float Contracts.Contract.ScienceCompletion
double Contracts.Contract.TimeDeadline
double Contracts.Contract.TimeExpiry

Property Documentation

Agent Contracts.Contract.Agent
get
IEnumerable<ContractParameter> Contracts.Contract.AllParameters
get
Guid Contracts.Contract.ContractGuid
get
long Contracts.Contract.ContractID
get
int Contracts.Contract.contractsInExistance
staticget
Contract.State Contracts.Contract.ContractState
get
double Contracts.Contract.DateAccepted
get
double Contracts.Contract.DateDeadline
get
double Contracts.Contract.DateExpire
get
double Contracts.Contract.DateFinished
get
string Contracts.Contract.Description
get
double Contracts.Contract.GameTime
staticgetprotected
List<string> Contracts.Contract.Keywords
get
List<string> Contracts.Contract.KeywordsRequired
get
int Contracts.Contract.MissionSeed
get
string Contracts.Contract.Notes
get
int Contracts.Contract.ParameterCount
get
IContractParameterHost Contracts.Contract.Parent
get
Contract.ContractPrestige Contracts.Contract.Prestige
get
Contract Contracts.Contract.Root
get
string Contracts.Contract.Synopsys
get
ContractParameter Contracts.Contract.this[int index]
get
ContractParameter Contracts.Contract.this[string id]
get
ContractParameter Contracts.Contract.this[Type type]
get
string Contracts.Contract.Title
get

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