Alarm¶
- class KerbalAlarmClock.Alarm¶
Represents an alarm. Obtained by calling
KerbalAlarmClock.alarms,KerbalAlarmClock.alarm_with_name()orKerbalAlarmClock.alarms_with_type().- action: KerbalAlarmClock.AlarmAction¶
The action that the alarm triggers.
- Attribute:
Can be read or written
- Return type:
- margin: number¶
The number of seconds before the event that the alarm will fire.
- Attribute:
Can be read or written
- Return type:
number
- time: number¶
The time at which the alarm will fire.
- Attribute:
Can be read or written
- Return type:
number
- type: KerbalAlarmClock.AlarmType¶
The type of the alarm.
- Attribute:
Read-only, cannot be set
- Return type:
- id: string¶
The unique identifier for the alarm.
- Attribute:
Read-only, cannot be set
- Return type:
string
- name: string¶
The short name of the alarm.
- Attribute:
Can be read or written
- Return type:
string
- notes: string¶
The long description of the alarm.
- Attribute:
Can be read or written
- Return type:
string
- remaining: number¶
The number of seconds until the alarm will fire.
- Attribute:
Read-only, cannot be set
- Return type:
number
- repeat: boolean¶
Whether the alarm will be repeated after it has fired.
- Attribute:
Can be read or written
- Return type:
boolean
- repeat_period: number¶
The time delay to automatically create an alarm after it has fired.
- Attribute:
Can be read or written
- Return type:
number
- vessel: SpaceCenter.Vessel¶
The vessel that the alarm is attached to.
- Attribute:
Can be read or written
- Return type:
- xfer_origin_body: SpaceCenter.CelestialBody¶
The celestial body the vessel is departing from.
- Attribute:
Can be read or written
- Return type:
- xfer_target_body: SpaceCenter.CelestialBody¶
The celestial body the vessel is arriving at.
- Attribute:
Can be read or written
- Return type:
- remove()¶
Removes the alarm.