C# Class MissionController.MissionGoal

A single mission goal.
Inheritance: InstructionSet
Show file Open project: pweingardt/KSPMissionController Class Usage Examples

Public Properties

Property Type Description
crewCount int
description String
doneOnce bool
id String
maxTotalMass double
minSeconds double
minTotalMass double
nonPermanent bool
optional bool
repeatable bool
reward int
throttleDown bool
vesselIndenpendent bool

Public Methods

Method Description
getType ( ) : String

Caption in the window for this mission goal
getValues ( Vessel vessel, GameEvent events ) : List

Returns all values related to this mission goal
isDone ( Vessel vessel, GameEvent events ) : bool

Checks, if this mission goal has been accomplished.

Protected Methods

Method Description
values ( Vessel v, GameEvent events ) : List

Returns an array of necessary values, like orbital parameters.

Method Details

getType() public method

Caption in the window for this mission goal
public getType ( ) : String
return String

getValues() public method

Returns all values related to this mission goal
public getValues ( Vessel vessel, GameEvent events ) : List
vessel Vessel current vessel
events GameEvent
return List

isDone() public method

Checks, if this mission goal has been accomplished.
public isDone ( Vessel vessel, GameEvent events ) : bool
vessel Vessel current vessel
events GameEvent
return bool

values() protected method

Returns an array of necessary values, like orbital parameters.
protected values ( Vessel v, GameEvent events ) : List
v Vessel current vessel, might be null when in editor mode or in space center mode!
events GameEvent
return List

Property Details

crewCount public property

The minimal crew count needed for this mission goal
public int crewCount
return int

description public property

The mission goals description
public String description
return String

doneOnce public property

Indicates that the mission goals has been finished once. Don't set this inside a mission file.
public bool doneOnce
return bool

id public property

Used to store finished mission goals. Do not set manually!
public String id
return String

maxTotalMass public property

public double maxTotalMass
return double

minSeconds public property

Minimal time for this mission goal in seconds.
public double minSeconds
return double

minTotalMass public property

The maximal and minimal total mass
public double minTotalMass
return double

nonPermanent public property

nonPermanent = false makes the mission goal a permanent condition to finish the mission goal. Use with caution.
public bool nonPermanent
return bool

optional public property

optional = true makes this mission goal optional
public bool optional
return bool

repeatable public property

If repeatable = true, this mission goals can be accomplished more than once.
public bool repeatable
return bool

reward public property

Optional reward for this specific mission goal
public int reward
return int

throttleDown public property

If true, the vessel needs to be throttled down in order to finish this mission goal
public bool throttleDown
return bool

vesselIndenpendent public property

If true it does not matter with which vessel this goal has been finished.
public bool vesselIndenpendent
return bool