Alarm#
- class Alarm#
Represents an alarm. Obtained by calling
alarms,alarm_with_name()oralarms_with_type().- action#
The action that the alarm triggers.
- Attribute:
Can be read or written
- Return type:
- margin#
The number of seconds before the event that the alarm will fire.
- Attribute:
Can be read or written
- Return type:
float
- time#
The time at which the alarm will fire.
- Attribute:
Can be read or written
- Return type:
float
- id#
The unique identifier for the alarm.
- Attribute:
Read-only, cannot be set
- Return type:
str
- name#
The short name of the alarm.
- Attribute:
Can be read or written
- Return type:
str
- notes#
The long description of the alarm.
- Attribute:
Can be read or written
- Return type:
str
- remaining#
The number of seconds until the alarm will fire.
- Attribute:
Read-only, cannot be set
- Return type:
float
- enabled#
Whether the alarm is enabled. A disabled alarm does not fire.
- Attribute:
Can be read or written
- Return type:
bool
- play_sound#
Whether the alarm plays a sound when it fires.
- Attribute:
Can be read or written
- Return type:
bool
- triggered#
Whether the alarm has fired. Remains true once the alarm has fired; stream this or use it in an event expression to react to the alarm firing.
- Attribute:
Read-only, cannot be set
- Return type:
bool
- repeat#
Whether the alarm will be repeated after it has fired. Only has an effect for alarm types that support repeating (see
Alarm.supports_repeat).- Attribute:
Can be read or written
- Return type:
bool
- supports_repeat#
Whether this alarm’s type supports repeating (see
Alarm.repeat).- Attribute:
Read-only, cannot be set
- Return type:
bool
- repeat_period#
The time delay to automatically create an alarm after it has fired. Only has an effect for alarm types that support a repeat period (see
Alarm.supports_repeat_period).- Attribute:
Can be read or written
- Return type:
float
- supports_repeat_period#
Whether this alarm’s type supports a repeat period (see
Alarm.repeat_period).- Attribute:
Read-only, cannot be set
- Return type:
bool
- vessel#
The vessel that the alarm is attached to.
- Attribute:
Can be read or written
- Return type:
- xfer_origin_body#
The celestial body the vessel is departing from.
- Attribute:
Can be read or written
- Return type:
- xfer_target_body#
The celestial body the vessel is arriving at.
- Attribute:
Can be read or written
- Return type:
- remove()#
Removes the alarm. Any further use of this object throws an exception.