Kerbal Space Program  1.12.4
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros
Public Member Functions | Protected Member Functions | List of all members
AlarmTypeApoapsis Class Reference
Inheritance diagram for AlarmTypeApoapsis:
AlarmTypeFlightNodeBase AlarmTypeBase KSP.UI.AppUI_Data IConfigNode

Public Member Functions

 AlarmTypeApoapsis ()
 
override string CannotSetAlarmText ()
 Override this to set displayText for when an alarm cannot be created More...
 
override bool CanSetAlarm (AlarmUIDisplayMode displayMode)
 Method that returns whether the params of this alarm are valid for creating/Editing an alarm More...
 
override string GetDefaultTitle ()
 The default string to display for this alarm types title More...
 
override bool InitializeFromMapObject (MapObject mapObject)
 Called when an alarm is created from a MapNode button so you can set any values needed in the alarm More...
 
override MapObject.ObjectType MapNodeType ()
 Override this with a mapnode type to More...
 
override bool ShowAlarmMapObject (MapObject mapObject)
 Override this with the method that determines if an add button shoudl be shown at this time More...
 
- Public Member Functions inherited from AlarmTypeFlightNodeBase
 AlarmTypeFlightNodeBase ()
 
override void OnAlarmLoad (ConfigNode node)
 
override void OnAlarmSave (ConfigNode node)
 
override void OnInputPanelUpdate (AlarmUIDisplayMode displayMode)
 
override void OnScenarioUpdate ()
 Update method called after base work is done by the scenario module More...
 
override void OnUIEndInitialization (AlarmUIDisplayMode displayMode)
 Called when the alarm is displayed as a new alarm to edit. Occurs when teh app "Create" button is pressed More...
 
override void OnUIInitialization (AlarmUIDisplayMode displayMode)
 Called when the alarm is displayed as a new alarm to edit. Occurs when teh app "Create" button is pressed More...
 
override bool RequiresVessel ()
 Does this alarm require a vessel link for creation More...
 
- Public Member Functions inherited from AlarmTypeBase
 AlarmTypeBase ()
 
object Clone ()
 Generic ICloning interface implementation. More...
 
virtual AlarmTypeBase CloneAlarm ()
 Clone an alarm More...
 
virtual void OnActioned ()
 Method to override that will be called when an alarm is actioned More...
 
sealed override void OnLoad (ConfigNode node)
 IConfigNode hook for the Load routine More...
 
virtual void OnManeuversLoaded (Vessel vessel, PatchedConicSolver solver)
 
sealed override void OnSave (ConfigNode node)
 
virtual void OnTriggered ()
 Method to override that will be called when an alarm is triggered More...
 
virtual void OnUIInputPanelDataChanged (AlarmUIDisplayMode displayMode)
 Called when the data is changed by an input panel More...
 
sealed override void UIInputPanelDataChanged ()
 Called when the input fields are set and can be overridden directly in the data class to catch these there More...
 
sealed override void UIInputPanelUpdate ()
 /This one takes the UIInput update and seals it so alarm types cannot override. Provides an OnInputPanelUpdate method for alarm types More...
 
- Public Member Functions inherited from KSP.UI.AppUI_Data
void Load (ConfigNode node)
 
void Save (ConfigNode node)
 

Protected Member Functions

override double GetNodeUT ()
 Method called by the basetype to get the UT of the instances Node More...
 

Additional Inherited Members

- Static Public Member Functions inherited from KSP.UI.AppUI_Data
static List< T > CreateAppUIDataList< T > (ConfigNode[] nodes)
 
static T CreateInstanceOfAppUIData< T > (ConfigNode node)
 Creates a new part module adjuster, then loads the node information into it. More...
 
static T CreateInstanceOfAppUIData< T > (string className)
 Creates a new part module adjuster. More...
 
- Public Attributes inherited from AlarmTypeFlightNodeBase
double marginEntry = 60
 
- Public Attributes inherited from AlarmTypeBase
AlarmActions actions
 Actions to take when the alarm is triggered More...
 
string description = ""
 Any extra details More...
 
double eventOffset = 0
 The offset (in s) from the alarm to the associated event More...
 
string iconURL = "default"
 The URL path to the icon in the gamedatabase. More...
 
int soundRepeatsOverride = -1
 An override to the general how many times to play the sound More...
 
string soundURLOverride = ""
 An override to the general alarm sound to play More...
 
string title = ""
 The shortname for the alarm More...
 
double ut = 0
 The Universe Time (in s) of the alarm More...
 
uint vesselId
 Vessel ID associated with this alarm More...
 
string vesselName = ""
 
- Protected Attributes inherited from AlarmTypeFlightNodeBase
Orbit orbitCache = null
 
- Protected Attributes inherited from KSP.UI.AppUI_Data
Callback onDataChanged
 
- Properties inherited from AlarmTypeBase
bool Actioned [get]
 Has the alarm been actioned - ie actions were triggered and then completed or closed More...
 
Boolean HaltWarp [get]
 Is the game to be returned to real time (1x) when an alarm is triggered More...
 
uint Id [get]
 Unique Identifier for the alarm More...
 
bool IsActive [get]
 Is this alarm active in the scenario list More...
 
bool IsAlarmVesselTheAvailableVessel [get]
 Is this alarm for the alarmclockscenarios available vessel More...
 
bool IsEditing [get]
 Is the alarm open in a UI Panel and being edited More...
 
bool IsMapNodeDefined [get]
 Has a mapnode type been defined here More...
 
Boolean PauseGame [get]
 Is the game to be paused when an alarm is triggered More...
 
Boolean ShowMessage [get]
 Is a message to be shown when the alarm is triggered More...
 
double TimeToAlarm [get, set]
 How long in UT till the alarm is triggered More...
 
double TimeToEvent [get, set]
 How ling in UT till the event related to the alarm is - eg alarm + the offset More...
 
bool Triggered [get]
 Has the alarm been triggered - ie passed the time of alarm and actions triggered More...
 
string TypeName [get]
 The Typename of this alarm class More...
 
Vessel Vessel [get]
 Vessel that the alarm is attached to More...
 

Constructor & Destructor Documentation

AlarmTypeApoapsis.AlarmTypeApoapsis ( )
inline

Member Function Documentation

override string AlarmTypeApoapsis.CannotSetAlarmText ( )
inlinevirtual

Override this to set displayText for when an alarm cannot be created

Returns

Reimplemented from AlarmTypeBase.

override bool AlarmTypeApoapsis.CanSetAlarm ( AlarmUIDisplayMode  displayMode)
inlinevirtual

Method that returns whether the params of this alarm are valid for creating/Editing an alarm

eg If its a maneuver alarm and there is no maneuevr this would return false

Parameters
displayModeMode of the add/edit window
Returns
true if alarm can be created

Implements AlarmTypeBase.

override string AlarmTypeApoapsis.GetDefaultTitle ( )
inlinevirtual

The default string to display for this alarm types title

Returns
Default Title

Implements AlarmTypeBase.

override double AlarmTypeApoapsis.GetNodeUT ( )
inlineprotectedvirtual

Method called by the basetype to get the UT of the instances Node

Returns
UT of the node

Implements AlarmTypeFlightNodeBase.

override bool AlarmTypeApoapsis.InitializeFromMapObject ( MapObject  mapObject)
inlinevirtual

Called when an alarm is created from a MapNode button so you can set any values needed in the alarm

Parameters
mapObjectThe object that was sent to setup the alarm/param>
Returns
True if the creation should proceed

Reimplemented from AlarmTypeBase.

override MapObject.ObjectType AlarmTypeApoapsis.MapNodeType ( )
inlinevirtual

Override this with a mapnode type to

Returns

Reimplemented from AlarmTypeBase.

override bool AlarmTypeApoapsis.ShowAlarmMapObject ( MapObject  mapObject)
inlinevirtual

Override this with the method that determines if an add button shoudl be shown at this time

Parameters
mapObjectThe mapobject that the mmouse is now hovering
Returns
True to have the addalarm button show up

Reimplemented from AlarmTypeBase.


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