Inheritance diagram for AlarmTypeBase:

Public Member Functions
	AlarmTypeBase ()

virtual string	CannotSetAlarmText ()
	Override this to set displayText for when an alarm cannot be created More...

abstract bool	CanSetAlarm (AlarmUIDisplayMode displayMode)
	Method that returns whether the params of this alarm are valid for creating/Editing an alarm More...

object	Clone ()
	Generic ICloning interface implementation. More...

virtual AlarmTypeBase	CloneAlarm ()
	Clone an alarm More...

abstract string	GetDefaultTitle ()
	The default string to display for this alarm types title More...

virtual 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...

virtual MapObject.ObjectType	MapNodeType ()
	Override this with a mapnode type to More...

virtual void	OnActioned ()
	Method to override that will be called when an alarm is actioned More...

virtual void	OnAlarmLoad (ConfigNode node)

virtual void	OnAlarmSave (ConfigNode node)

virtual void	OnInputPanelUpdate (AlarmUIDisplayMode displayMode)

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	OnScenarioUpdate ()
	Update method called after base work is done by the scenario module More...

virtual void	OnTriggered ()
	Method to override that will be called when an alarm is triggered More...

virtual 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...

virtual 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...

virtual void	OnUIInputPanelDataChanged (AlarmUIDisplayMode displayMode)
	Called when the data is changed by an input panel More...

abstract bool	RequiresVessel ()
	Does this alarm require a vessel link for creation More...

virtual bool	ShowAlarmMapObject (MapObject mapObject)
	Override this with the method that determines if an add button shoudl be shown at this time 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)

Public Attributes
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 = ""

Properties
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...

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...

Protected Attributes inherited from KSP.UI.AppUI_Data
Callback	onDataChanged

Constructor & Destructor Documentation

AlarmTypeBase.AlarmTypeBase ( )

inline

Member Function Documentation

virtual string AlarmTypeBase.CannotSetAlarmText ( )

inlinevirtual

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

Returns

Reimplemented in AlarmTypeManeuver, AlarmTypeTransferWindow, AlarmTypeApoapsis, AlarmTypePeriapsis, and AlarmTypeSOI.

abstract bool AlarmTypeBase.CanSetAlarm ( AlarmUIDisplayMode displayMode )

pure virtual

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

displayMode Mode of the add/edit window

Returns: true if alarm can be created

Implemented in AlarmTypeManeuver, AlarmTypeTransferWindow, AlarmTypeRaw, AlarmTypeApoapsis, AlarmTypePeriapsis, and AlarmTypeSOI.

object AlarmTypeBase.Clone ( )

inline

Generic ICloning interface implementation.

Use CloneAlarm to get the typecast version

Returns

virtual AlarmTypeBase AlarmTypeBase.CloneAlarm ( )

inlinevirtual

Clone an alarm

Returns: Copy of the alarm

abstract string AlarmTypeBase.GetDefaultTitle ( )

pure virtual

The default string to display for this alarm types title

Returns: Default Title

Implemented in AlarmTypeManeuver, AlarmTypeTransferWindow, AlarmTypeApoapsis, AlarmTypePeriapsis, AlarmTypeSOI, and AlarmTypeRaw.

virtual bool AlarmTypeBase.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

mapObject

The object that was sent to setup the alarm/param>

Returns: True if the creation should proceed

Reimplemented in AlarmTypeManeuver, AlarmTypePeriapsis, AlarmTypeSOI, and AlarmTypeApoapsis.

virtual MapObject.ObjectType AlarmTypeBase.MapNodeType ( )

inlinevirtual

Override this with a mapnode type to

Returns

Reimplemented in AlarmTypeManeuver, AlarmTypeApoapsis, AlarmTypePeriapsis, and AlarmTypeSOI.

virtual void AlarmTypeBase.OnActioned ( )

inlinevirtual

Method to override that will be called when an alarm is actioned

virtual void AlarmTypeBase.OnAlarmLoad ( ConfigNode node )

inlinevirtual

Reimplemented in AlarmTypeManeuver, AlarmTypeTransferWindow, and AlarmTypeFlightNodeBase.

virtual void AlarmTypeBase.OnAlarmSave ( ConfigNode node )

inlinevirtual

Reimplemented in AlarmTypeManeuver, AlarmTypeTransferWindow, and AlarmTypeFlightNodeBase.

virtual void AlarmTypeBase.OnInputPanelUpdate ( AlarmUIDisplayMode displayMode )

inlinevirtual

Reimplemented in AlarmTypeManeuver, AlarmTypeTransferWindow, AlarmTypeFlightNodeBase, and AlarmTypeRaw.

sealed override void AlarmTypeBase.OnLoad ( ConfigNode node )

inlinevirtual

IConfigNode hook for the Load routine

Parameters

node

Reimplemented from KSP.UI.AppUI_Data.

virtual void AlarmTypeBase.OnManeuversLoaded	(	Vessel	vessel,
		PatchedConicSolver	solver
	)

inlinevirtual

Reimplemented in AlarmTypeManeuver.

sealed override void AlarmTypeBase.OnSave ( ConfigNode node )

inlinevirtual

Reimplemented from KSP.UI.AppUI_Data.

virtual void AlarmTypeBase.OnScenarioUpdate ( )

inlinevirtual

Update method called after base work is done by the scenario module

Reimplemented in AlarmTypeManeuver, AlarmTypeTransferWindow, and AlarmTypeFlightNodeBase.

virtual void AlarmTypeBase.OnTriggered ( )

inlinevirtual

Method to override that will be called when an alarm is triggered

virtual void AlarmTypeBase.OnUIEndInitialization ( AlarmUIDisplayMode displayMode )

inlinevirtual

Called when the alarm is displayed as a new alarm to edit. Occurs when teh app "Create" button is pressed

Reimplemented in AlarmTypeManeuver, AlarmTypeTransferWindow, AlarmTypeFlightNodeBase, and AlarmTypeRaw.

virtual void AlarmTypeBase.OnUIInitialization ( AlarmUIDisplayMode displayMode )

inlinevirtual

Called when the alarm is displayed as a new alarm to edit. Occurs when teh app "Create" button is pressed

Parameters

displayMode The mode in which the display is currently - add/edit/etc

Reimplemented in AlarmTypeManeuver, AlarmTypeTransferWindow, AlarmTypeFlightNodeBase, and AlarmTypeRaw.

virtual void AlarmTypeBase.OnUIInputPanelDataChanged ( AlarmUIDisplayMode displayMode )

inlinevirtual

Called when the data is changed by an input panel

Reimplemented in AlarmTypeTransferWindow.

abstract bool AlarmTypeBase.RequiresVessel ( )

pure virtual

Does this alarm require a vessel link for creation

Returns: True if a vessel is required

Implemented in AlarmTypeManeuver, AlarmTypeTransferWindow, AlarmTypeRaw, and AlarmTypeFlightNodeBase.

virtual bool AlarmTypeBase.ShowAlarmMapObject ( MapObject mapObject )

inlinevirtual

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

Parameters

mapObject The mapobject that the mmouse is now hovering

Returns: True to have the addalarm button show up

Reimplemented in AlarmTypeManeuver, AlarmTypeApoapsis, AlarmTypePeriapsis, and AlarmTypeSOI.

sealed override void AlarmTypeBase.UIInputPanelDataChanged ( )

inlinevirtual

Called when the input fields are set and can be overridden directly in the data class to catch these there

Reimplemented from KSP.UI.AppUI_Data.

sealed override void AlarmTypeBase.UIInputPanelUpdate ( )

inlinevirtual

/This one takes the UIInput update and seals it so alarm types cannot override. Provides an OnInputPanelUpdate method for alarm types

Reimplemented from KSP.UI.AppUI_Data.

Member Data Documentation

AlarmActions AlarmTypeBase.actions

Actions to take when the alarm is triggered

string AlarmTypeBase.description = ""

Any extra details

double AlarmTypeBase.eventOffset = 0

The offset (in s) from the alarm to the associated event

string AlarmTypeBase.iconURL = "default"

The URL path to the icon in the gamedatabase.

it can be an absolute path from GameData or a simple name for images in Squad

int AlarmTypeBase.soundRepeatsOverride = -1

An override to the general how many times to play the sound

-1 means use the alarm clock global one

string AlarmTypeBase.soundURLOverride = ""

An override to the general alarm sound to play

empty string means use the alarm clock global one

string AlarmTypeBase.title = ""

The shortname for the alarm

double AlarmTypeBase.ut = 0

The Universe Time (in s) of the alarm

uint AlarmTypeBase.vesselId

Vessel ID associated with this alarm

string AlarmTypeBase.vesselName = ""

Property Documentation

bool AlarmTypeBase.Actioned

get

Has the alarm been actioned - ie actions were triggered and then completed or closed

Boolean AlarmTypeBase.HaltWarp

get

Is the game to be returned to real time (1x) when an alarm is triggered

uint AlarmTypeBase.Id

get

Unique Identifier for the alarm

bool AlarmTypeBase.IsActive

get

Is this alarm active in the scenario list

bool AlarmTypeBase.IsAlarmVesselTheAvailableVessel

get

Is this alarm for the alarmclockscenarios available vessel

bool AlarmTypeBase.IsEditing

get

Is the alarm open in a UI Panel and being edited

bool AlarmTypeBase.IsMapNodeDefined

get

Has a mapnode type been defined here

Boolean AlarmTypeBase.PauseGame

get

Is the game to be paused when an alarm is triggered

Boolean AlarmTypeBase.ShowMessage

get

Is a message to be shown when the alarm is triggered

double AlarmTypeBase.TimeToAlarm

getset

How long in UT till the alarm is triggered

double AlarmTypeBase.TimeToEvent

getset

How ling in UT till the event related to the alarm is - eg alarm + the offset

bool AlarmTypeBase.Triggered

get

Has the alarm been triggered - ie passed the time of alarm and actions triggered

string AlarmTypeBase.TypeName

get

The Typename of this alarm class

Vessel AlarmTypeBase.Vessel

get

Vessel that the alarm is attached to

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

KSP/Assets/Scripts/AlarmClock/AlarmTypeBase.cs

Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

Property Documentation