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
BaseEvent Class Reference

A part action More...

Public Member Functions

 BaseEvent (BaseEventList listParent, string name, BaseEventDelegate onEvent, KSPEvent actionAttr)
 Create a new action More...
 
 BaseEvent (BaseEventList listParent, string name, BaseEventDetailsDelegate onDataEvent, KSPEvent actionAttr)
 Create a new action More...
 
void Invoke ()
 
void Invoke (BaseEventDetails data)
 
void OnLoad (ConfigNode node)
 
void OnSave (ConfigNode node)
 
override string ToString ()
 
void VariantToggleEventDisabled (bool disabled)
 Allows part variants to disable or enable events. More...
 

Public Attributes

bool active
 Is this action going to recieve inputs More...
 
bool advancedTweakable
 Does this action require Advanced Tweakables to be enabled? More...
 
bool assigned
 Do not use 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...
 
BasePAWGroup group
 The group that this item will appear in in the PartActionWindow More...
 
bool guiActive
 Is this action available to the GUI More...
 
bool guiActiveEditor
 Is this action available to the GUI in editor More...
 
bool guiActiveUncommand
 Is this action available when the vessel is not under control More...
 
bool guiActiveUnfocused
 Is this action available while focused on another vessel? More...
 
string guiIcon
 string name of the gui icon to load More...
 
bool isPersistent
 Should this event's fields be serialized in craft/sfs? More...
 
BaseEventList listParent
 
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

bool EventIsDisabledByVariant [get]
 Has the event been disabled by a part variant? More...
 
string guiName [get, set]
 The name of this action presented in the gui (user readable name) More...
 
string GUIName [get]
 Returns guiName unless it is null or empty in which case returns the event name More...
 
int id [get, set]
 The hash of the action name More...
 
string name [get, set]
 The exposed action name More...
 
BaseEventDetailsDelegate onDataEvent [get, set]
 The delegate method this action fires if it takes a data reference More...
 
BaseEventDelegate onEvent [get, set]
 The delegate method this action fires More...
 

Detailed Description

A part action

Constructor & Destructor Documentation

BaseEvent.BaseEvent ( BaseEventList  listParent,
string  name,
BaseEventDelegate  onEvent,
KSPEvent  actionAttr 
)
inline

Create a new action

Parameters
nameExposed action name
onEventReflected method delegate
actionAttrAction's attribute data
BaseEvent.BaseEvent ( BaseEventList  listParent,
string  name,
BaseEventDetailsDelegate  onDataEvent,
KSPEvent  actionAttr 
)
inline

Create a new action

Parameters
nameExposed action name
onEventReflected method delegate
actionAttrAction's attribute data

Member Function Documentation

void BaseEvent.Invoke ( )
inline
void BaseEvent.Invoke ( BaseEventDetails  data)
inline
void BaseEvent.OnLoad ( ConfigNode  node)
inline
void BaseEvent.OnSave ( ConfigNode  node)
inline
override string BaseEvent.ToString ( )
inline
void BaseEvent.VariantToggleEventDisabled ( bool  disabled)
inline

Allows part variants to disable or enable events.

Member Data Documentation

bool BaseEvent.active

Is this action going to recieve inputs

bool BaseEvent.advancedTweakable

Does this action require Advanced Tweakables to be enabled?

bool BaseEvent.assigned

Do not use

string BaseEvent.category

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

bool BaseEvent.externalToEVAOnly

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

BasePAWGroup BaseEvent.group

The group that this item will appear in in the PartActionWindow

bool BaseEvent.guiActive

Is this action available to the GUI

bool BaseEvent.guiActiveEditor

Is this action available to the GUI in editor

bool BaseEvent.guiActiveUncommand

Is this action available when the vessel is not under control

bool BaseEvent.guiActiveUnfocused

Is this action available while focused on another vessel?

string BaseEvent.guiIcon

string name of the gui icon to load

bool BaseEvent.isPersistent

Should this event's fields be serialized in craft/sfs?

BaseEventList BaseEvent.listParent
bool BaseEvent.requireFullControl

Does this require full, not just partial, control?

float BaseEvent.unfocusedRange

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

bool BaseEvent.wasActiveBeforePartWasAdjusted

Was this event active before the part was adjusted?

Property Documentation

bool BaseEvent.EventIsDisabledByVariant
get

Has the event been disabled by a part variant?

string BaseEvent.guiName
getset

The name of this action presented in the gui (user readable name)

string BaseEvent.GUIName
get

Returns guiName unless it is null or empty in which case returns the event name

int BaseEvent.id
getset

The hash of the action name

string BaseEvent.name
getset

The exposed action name

BaseEventDetailsDelegate BaseEvent.onDataEvent
getsetprotected

The delegate method this action fires if it takes a data reference

BaseEventDelegate BaseEvent.onEvent
getsetprotected

The delegate method this action fires


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