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

Tells the compiler that this method is an action and allows you to set up the KSP specific stuff. ** REQUIRED BY ALL ACTION METHODS ** More...

Inheritance diagram for KSPEvent:

Public Member Functions

 KSPEvent ()
 

Public Attributes

bool active
 Is this action initially active? More...
 
bool advancedTweakable
 Does this action require Advanced Tweakables to be enabled? More...
 
string category
 A string category id so can display all actions of certain types More...
 
bool externalToEVAOnly
 If available from other vessels, require that the other vessel be an EVA? More...
 
string groupDisplayName
 This event's group display name More...
 
string groupName
 This event's group name More...
 
bool groupStartCollapsed
 If this group will start collapsed More...
 
bool guiActive
 Is this action available to the user? More...
 
bool guiActiveEditor
 Is this action available to the GUI in editor More...
 
bool guiActiveUncommand
 Is this action available while the vessel is not under control? More...
 
bool guiActiveUnfocused
 Is this action available while focused on another vessel? More...
 
string guiIcon
 The guiIcon name (guiAction must be true) More...
 
bool isDefault
 Is this action assigned as the part's default? More...
 
bool isPersistent
 Should this event's fields be saved to craft/sfs More...
 
string name
 The external name of this action More...
 
bool requireFullControl
 Does this require full, not just partial, control? More...
 
float unfocusedRange
 if available from other vessels, what is the minimum range for activation? More...
 
bool wasActiveBeforePartWasAdjusted
 Was this event active before the part was adjusted? More...
 

Properties

string guiName [get, set]
 The gui name for this action (userAction must be true) More...
 

Detailed Description

Tells the compiler that this method is an action and allows you to set up the KSP specific stuff. ** REQUIRED BY ALL ACTION METHODS **

Constructor & Destructor Documentation

KSPEvent.KSPEvent ( )
inline

Member Data Documentation

bool KSPEvent.active

Is this action initially active?

bool KSPEvent.advancedTweakable

Does this action require Advanced Tweakables to be enabled?

string KSPEvent.category

A string category id so can display all actions of certain types

bool KSPEvent.externalToEVAOnly

If available from other vessels, require that the other vessel be an EVA?

string KSPEvent.groupDisplayName

This event's group display name

string KSPEvent.groupName

This event's group name

bool KSPEvent.groupStartCollapsed

If this group will start collapsed

bool KSPEvent.guiActive

Is this action available to the user?

bool KSPEvent.guiActiveEditor

Is this action available to the GUI in editor

bool KSPEvent.guiActiveUncommand

Is this action available while the vessel is not under control?

bool KSPEvent.guiActiveUnfocused

Is this action available while focused on another vessel?

string KSPEvent.guiIcon

The guiIcon name (guiAction must be true)

bool KSPEvent.isDefault

Is this action assigned as the part's default?

  • Will override any previous default *
bool KSPEvent.isPersistent

Should this event's fields be saved to craft/sfs

string KSPEvent.name

The external name of this action

bool KSPEvent.requireFullControl

Does this require full, not just partial, control?

float KSPEvent.unfocusedRange

if available from other vessels, what is the minimum range for activation?

bool KSPEvent.wasActiveBeforePartWasAdjusted

Was this event active before the part was adjusted?

Property Documentation

string KSPEvent.guiName
getset

The gui name for this action (userAction must be true)


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