Contracts.ContractParameter Class Reference

Inheritance diagram for Contracts.ContractParameter:

Public Member Functions
	ContractParameter ()
ContractParameter	AddParameter (ContractParameter parameter, string id=null)
bool	AllChildParametersComplete ()
bool	AnyChildParametersFailed ()
long	CreateID ()
void	Disable ()
void	Enable ()
T	GetParameter< T > (string id=null)
ContractParameter	GetParameter (int index)
ContractParameter	GetParameter (string id)
ContractParameter	GetParameter (Type type)
void	Load (ConfigNode node)
void	NestToParent (IContractParameterHost parent)
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	SetFunds (float completion, CelestialBody body=null)
void	SetFunds (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	Unregister ()
void	Update ()

Public Attributes
double	FundsCompletion
double	FundsFailure
EventData< ContractParameter, ParameterState >	OnStateChange
float	ReputationCompletion
float	ReputationFailure
float	ScienceCompletion

Protected Member Functions
virtual void	AwardCompletion ()
virtual string	GetHashString ()
virtual string	GetMessageComplete ()
virtual string	GetMessageFailed ()
virtual string	GetMessageIncomplete ()
virtual string	GetNotes ()
virtual string	GetTitle ()
virtual void	OnLoad (ConfigNode node)
virtual void	OnParameterStateChange (ContractParameter p)
virtual void	OnRegister ()
virtual void	OnSave (ConfigNode node)
virtual void	OnUnregister ()
virtual void	OnUpdate ()
virtual void	PenalizeFailure ()
void	SendStateMessage (string title, string message, MessageSystemButton.MessageButtonColor color, MessageSystemButton.ButtonIcons icon)
void	SetComplete ()
void	SetFailed ()
void	SetIncomplete ()

Protected Attributes
bool	disableOnStateChange
bool	enabled
string	id
bool	optional
ParameterState	state

Properties
IEnumerable< ContractParameter >	AllParameters [get]
bool	DisableOnStateChange [get, set]
bool	Enabled [get, set]
string	HashString [get]
string	ID [get, set]
string	MessageComplete [get]
string	MessageFailed [get]
string	MessageIncomplete [get]
string	Notes [get]
bool	Optional [get, set]
int	ParameterCount [get]
IContractParameterHost	Parent [get]
Contract	Root [get]
ParameterState	State [get]
string	Title [get]
ContractParameter	this[int index] [get]
ContractParameter	this[string id] [get]
ContractParameter	this[Type type] [get]

Constructor & Destructor Documentation

Contracts.ContractParameter.ContractParameter

(

)

Member Function Documentation

ContractParameter Contracts.ContractParameter.AddParameter	(	ContractParameter	parameter,
		string	id = null
	)

bool Contracts.ContractParameter.AllChildParametersComplete

(

)

bool Contracts.ContractParameter.AnyChildParametersFailed

(

)

virtual void Contracts.ContractParameter.AwardCompletion ( )

protectedvirtual

long Contracts.ContractParameter.CreateID

(

)

void Contracts.ContractParameter.Disable

(

)

void Contracts.ContractParameter.Enable

(

)

virtual string Contracts.ContractParameter.GetHashString ( )

protectedvirtual

virtual string Contracts.ContractParameter.GetMessageComplete ( )

protectedvirtual

virtual string Contracts.ContractParameter.GetMessageFailed ( )

protectedvirtual

virtual string Contracts.ContractParameter.GetMessageIncomplete ( )

protectedvirtual

virtual string Contracts.ContractParameter.GetNotes ( )

protectedvirtual

ContractParameter Contracts.ContractParameter.GetParameter

(

int

index

)

ContractParameter Contracts.ContractParameter.GetParameter

(

string

id

)

ContractParameter Contracts.ContractParameter.GetParameter

(

Type

type

)

T Contracts.ContractParameter.GetParameter< T >

(

string

id = null

)

Type Constraints

T

:

ContractParameter

virtual string Contracts.ContractParameter.GetTitle ( )

protectedvirtual

void Contracts.ContractParameter.Load

(

ConfigNode

node

)

void Contracts.ContractParameter.NestToParent

(

IContractParameterHost

parent

)

virtual void Contracts.ContractParameter.OnLoad ( ConfigNode  node )

protectedvirtual

virtual void Contracts.ContractParameter.OnParameterStateChange ( ContractParameter  p )

protectedvirtual

virtual void Contracts.ContractParameter.OnRegister ( )

protectedvirtual

virtual void Contracts.ContractParameter.OnSave ( ConfigNode  node )

protectedvirtual

virtual void Contracts.ContractParameter.OnUnregister ( )

protectedvirtual

virtual void Contracts.ContractParameter.OnUpdate ( )

protectedvirtual

void Contracts.ContractParameter.ParameterStateUpdate

(

ContractParameter

p

)

virtual void Contracts.ContractParameter.PenalizeFailure ( )

protectedvirtual

void Contracts.ContractParameter.Register

(

)

void Contracts.ContractParameter.RemoveParameter

(

ContractParameter

parameter

)

void Contracts.ContractParameter.RemoveParameter

(

int

index

)

void Contracts.ContractParameter.RemoveParameter

(

string

id

)

void Contracts.ContractParameter.RemoveParameter

(

Type

type

)

void Contracts.ContractParameter.Save

(

ConfigNode

node

)

void Contracts.ContractParameter.SendStateMessage ( string  title, string  message, MessageSystemButton.MessageButtonColor  color, MessageSystemButton.ButtonIcons  icon  )

protected

void Contracts.ContractParameter.SetComplete ( )

protected

void Contracts.ContractParameter.SetFailed ( )

protected

void Contracts.ContractParameter.SetFunds	(	float	completion,
		CelestialBody	body = null
	)

void Contracts.ContractParameter.SetFunds	(	float	completion,
		float	failure,
		CelestialBody	body = null
	)

void Contracts.ContractParameter.SetIncomplete ( )

protected

void Contracts.ContractParameter.SetReputation	(	float	completion,
		CelestialBody	body = null
	)

void Contracts.ContractParameter.SetReputation	(	float	completion,
		float	failure,
		CelestialBody	body = null
	)

void Contracts.ContractParameter.SetScience	(	float	completion,
		CelestialBody	body = null
	)

void Contracts.ContractParameter.Unregister

(

)

void Contracts.ContractParameter.Update

(

)

Member Data Documentation

bool Contracts.ContractParameter.disableOnStateChange

protected

bool Contracts.ContractParameter.enabled

protected

double Contracts.ContractParameter.FundsCompletion

double Contracts.ContractParameter.FundsFailure

string Contracts.ContractParameter.id

protected

EventData<ContractParameter, ParameterState> Contracts.ContractParameter.OnStateChange

bool Contracts.ContractParameter.optional

protected

float Contracts.ContractParameter.ReputationCompletion

float Contracts.ContractParameter.ReputationFailure

float Contracts.ContractParameter.ScienceCompletion

ParameterState Contracts.ContractParameter.state

protected

Property Documentation

IEnumerable<ContractParameter> Contracts.ContractParameter.AllParameters

get

bool Contracts.ContractParameter.DisableOnStateChange

getset

bool Contracts.ContractParameter.Enabled

getset

string Contracts.ContractParameter.HashString

get

string Contracts.ContractParameter.ID

getset

string Contracts.ContractParameter.MessageComplete

get

string Contracts.ContractParameter.MessageFailed

get

string Contracts.ContractParameter.MessageIncomplete

get

string Contracts.ContractParameter.Notes

get

bool Contracts.ContractParameter.Optional

getset

int Contracts.ContractParameter.ParameterCount

get

IContractParameterHost Contracts.ContractParameter.Parent

get

Contract Contracts.ContractParameter.Root

get

ParameterState Contracts.ContractParameter.State

get

ContractParameter Contracts.ContractParameter.this[int index]

get

ContractParameter Contracts.ContractParameter.this[string id]

get

ContractParameter Contracts.ContractParameter.this[Type type]

get

string Contracts.ContractParameter.Title

get

---

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

• src/ContractParameter.cs