space_ex v0.1.1 SpaceEx.KerbalAlarmClock.Alarm

Represents an alarm.

Obtained by calling SpaceEx.KerbalAlarmClock.get_alarms/1, SpaceEx.KerbalAlarmClock.alarm_with_name/2 or SpaceEx.KerbalAlarmClock.alarms_with_type/2.

Link to this section Summary

Functions

The action that the alarm triggers

The unique identifier for the alarm

The number of seconds before the event that the alarm will fire

The short name of the alarm

The long description of the alarm

The number of seconds until the alarm will fire

Whether the alarm will be repeated after it has fired

The time delay to automatically create an alarm after it has fired

The time at which the alarm will fire

The type of the alarm

The vessel that the alarm is attached to

The celestial body the vessel is departing from

The celestial body the vessel is arriving at

Removes the alarm

The action that the alarm triggers

The number of seconds before the event that the alarm will fire

The short name of the alarm

The long description of the alarm

Whether the alarm will be repeated after it has fired

The time delay to automatically create an alarm after it has fired

The time at which the alarm will fire

The vessel that the alarm is attached to

The celestial body the vessel is departing from

The celestial body the vessel is arriving at

Link to this section Functions

Link to this function get_action(conn, this)

The action that the alarm triggers.

Link to this function get_id(conn, this)

The unique identifier for the alarm.

Link to this function get_margin(conn, this)

The number of seconds before the event that the alarm will fire.

Link to this function get_name(conn, this)

The short name of the alarm.

Link to this function get_notes(conn, this)

The long description of the alarm.

Link to this function get_remaining(conn, this)

The number of seconds until the alarm will fire.

Link to this function get_repeat(conn, this)

Whether the alarm will be repeated after it has fired.

Link to this function get_repeat_period(conn, this)

The time delay to automatically create an alarm after it has fired.

Link to this function get_time(conn, this)

The time at which the alarm will fire.

Link to this function get_type(conn, this)

The type of the alarm.

Link to this function get_vessel(conn, this)

The vessel that the alarm is attached to.

Link to this function get_xfer_origin_body(conn, this)

The celestial body the vessel is departing from.

Link to this function get_xfer_target_body(conn, this)

The celestial body the vessel is arriving at.

Link to this function remove(conn, this)

Removes the alarm.

Link to this function set_action(conn, this, value)

The action that the alarm triggers.

Link to this function set_margin(conn, this, value)

The number of seconds before the event that the alarm will fire.

Link to this function set_name(conn, this, value)

The short name of the alarm.

Link to this function set_notes(conn, this, value)

The long description of the alarm.

Link to this function set_repeat(conn, this, value)

Whether the alarm will be repeated after it has fired.

Link to this function set_repeat_period(conn, this, value)

The time delay to automatically create an alarm after it has fired.

Link to this function set_time(conn, this, value)

The time at which the alarm will fire.

Link to this function set_vessel(conn, this, value)

The vessel that the alarm is attached to.

Link to this function set_xfer_origin_body(conn, this, value)

The celestial body the vessel is departing from.

Link to this function set_xfer_target_body(conn, this, value)

The celestial body the vessel is arriving at.