ModuleResource Class Reference

Inheritance diagram for ModuleResource:

Public Member Functions
bool	IsDeprived (float requestThreshold=0.9f)
void	Load (ConfigNode node)
	ModuleResource ()
virtual void	OnAwake ()
string	PrintRate (double mult=1d)
string	PrintRate (bool showFlowMode, double mult=1d)
void	Save (ConfigNode node)

Public Attributes
double	amount
	The amount of the resource. More...
ModuleResourceAutoShiftState	autoStateShifter
	The shift state reference More...
bool	available
	Used in modules to hold the availability. Meaningless if not used in your module logic. More...
double	currentAmount
	The current amount of the resource being requested. More...
double	currentRequest
	The currently requested amount of resource. More...
double	displayUnitMult = 1d
ResourceFlowMode	flowMode = ResourceFlowMode.NULL
	Optional: can override the default resource flow mode on resource requests if this is specified. More...
int	id
	The hashtag id of the resource (hash of the name) More...
bool	isDeprived
	Used by ModuleGenerator. Other modules use the method, IsDeprived. More...
string	name
	The name of the resource More...
double	rate
	the rate at which the resource will be consumed. More...
float	shutOffAmount
	The minimum amount of resource available before auto-shutting down More...
bool	shutOffHandler = false
	Is the consumer using auto-shutdown behavior More...
float	shutOffPercent
	The minimum percent of resource available before auto-shutting down More...
bool	shutOffStartUpUsePercent
	If the consumer is using auto-shutdown/start behavior, whether it detects net amount or percentage. False = net amount, True = percentage. More...
float	startUpAmount
	The amount of resource needed to auto-start More...
bool	startUpHandler = false
	Is the consumer using auto-start behavior More...
float	startUpPercent
	The percentage of resource needed to auto-start More...
string	title
	The title of the resource More...
string	unitName = ""
bool	useSI = false
bool	varyTime = true
	Will format the amount used figures to an appropriate measure if true. If false will use SI units or the default unit specified in the resource definition. More...

Properties
PartResourceDefinition	resourceDef [get]
	The PartResourceDefinition for this Resource. Returns Null if not found. More...

Constructor & Destructor Documentation

ModuleResource.ModuleResource ( )

inline

Member Function Documentation

bool ModuleResource.IsDeprived ( float  requestThreshold = 0.9f )

inline

void ModuleResource.Load ( ConfigNode  node )

inline

Implements IConfigNode.

virtual void ModuleResource.OnAwake ( )

inlinevirtual

string ModuleResource.PrintRate ( double  mult = 1d )

inline

string ModuleResource.PrintRate ( bool  showFlowMode, double  mult = 1d  )

inline

void ModuleResource.Save ( ConfigNode  node )

inline

Implements IConfigNode.

Member Data Documentation

double ModuleResource.amount

The amount of the resource.

ModuleResourceAutoShiftState ModuleResource.autoStateShifter

The shift state reference

bool ModuleResource.available

Used in modules to hold the availability. Meaningless if not used in your module logic.

double ModuleResource.currentAmount

The current amount of the resource being requested.

double ModuleResource.currentRequest

The currently requested amount of resource.

double ModuleResource.displayUnitMult = 1d

ResourceFlowMode ModuleResource.flowMode = ResourceFlowMode.NULL

Optional: can override the default resource flow mode on resource requests if this is specified.

int ModuleResource.id

The hashtag id of the resource (hash of the name)

bool ModuleResource.isDeprived

Used by ModuleGenerator. Other modules use the method, IsDeprived.

string ModuleResource.name

The name of the resource

double ModuleResource.rate

the rate at which the resource will be consumed.

float ModuleResource.shutOffAmount

The minimum amount of resource available before auto-shutting down

bool ModuleResource.shutOffHandler = false

Is the consumer using auto-shutdown behavior

float ModuleResource.shutOffPercent

The minimum percent of resource available before auto-shutting down

bool ModuleResource.shutOffStartUpUsePercent

If the consumer is using auto-shutdown/start behavior, whether it detects net amount or percentage. False = net amount, True = percentage.

float ModuleResource.startUpAmount

The amount of resource needed to auto-start

bool ModuleResource.startUpHandler = false

Is the consumer using auto-start behavior

float ModuleResource.startUpPercent

The percentage of resource needed to auto-start

string ModuleResource.title

The title of the resource

string ModuleResource.unitName = ""

bool ModuleResource.useSI = false

bool ModuleResource.varyTime = true

Will format the amount used figures to an appropriate measure if true. If false will use SI units or the default unit specified in the resource definition.

Property Documentation

PartResourceDefinition ModuleResource.resourceDef

get

The PartResourceDefinition for this Resource. Returns Null if not found.

---

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

• KSP/Assets/Scripts/Part Scripts/PartModules/Util/ModuleResource.cs