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

Structure of actions to be taken when an alarm is triggered More...

Inheritance diagram for AlarmActions:
IConfigNode

Public Types

enum  MessageEnum { MessageEnum.No, MessageEnum.Yes, MessageEnum.YesIfOtherVessel }
 Message Actions More...
 
enum  WarpEnum { WarpEnum.DoNothing, WarpEnum.KillWarp, WarpEnum.PauseGame }
 Warp Actions More...
 

Public Member Functions

 AlarmActions ()
 Constructor More...
 
 AlarmActions (WarpEnum Warp, MessageEnum Message, bool PlaySound, bool DeleteWhenDone)
 Constructor More...
 
AlarmActions Duplicate ()
 Make a copy of the action object More...
 
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 
override string ToString ()
 

Public Attributes

bool deleteWhenDone = false
 Should the alarm be deleted once actioned More...
 
MessageEnum message = MessageEnum.Yes
 What type of message to display More...
 
bool playSound = false
 Should a sound be played when the alarm is hit More...
 
WarpEnum warp = WarpEnum.KillWarp
 How to handle Timewarp More...
 

Detailed Description

Structure of actions to be taken when an alarm is triggered

Member Enumeration Documentation

Message Actions

Enumerator
No 
Yes 
YesIfOtherVessel 

Warp Actions

Enumerator
DoNothing 
KillWarp 
PauseGame 

Constructor & Destructor Documentation

AlarmActions.AlarmActions ( )
inline

Constructor

AlarmActions.AlarmActions ( WarpEnum  Warp,
MessageEnum  Message,
bool  PlaySound,
bool  DeleteWhenDone 
)
inline

Constructor

Parameters
WarpWarp Effect
MessageMessage Options
PlaySoundPlay a sound
DeleteWhenDoneDelete when actioned

Member Function Documentation

AlarmActions AlarmActions.Duplicate ( )
inline

Make a copy of the action object

Returns
A new copy of this object
void AlarmActions.Load ( ConfigNode  node)
inline

Implements IConfigNode.

void AlarmActions.Save ( ConfigNode  node)
inline

Implements IConfigNode.

override string AlarmActions.ToString ( )
inline

Member Data Documentation

bool AlarmActions.deleteWhenDone = false

Should the alarm be deleted once actioned

MessageEnum AlarmActions.message = MessageEnum.Yes

What type of message to display

bool AlarmActions.playSound = false

Should a sound be played when the alarm is hit

WarpEnum AlarmActions.warp = WarpEnum.KillWarp

How to handle Timewarp


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