space_ex

v0.8.0

space_ex v0.8.0 SpaceEx.KerbalAlarmClock

This service provides functionality to interact with Kerbal Alarm Clock.

Link to this section Summary

Functions

alarm_with_name(conn, name)

Get the alarm with the given name, or nil if no alarms have that name

alarms(conn)

A list of all the alarms

alarms_with_type(conn, type)

Get a list of alarms of the specified type

available(conn)

Whether Kerbal Alarm Clock is available

create_alarm(conn, type, name, ut)

Create a new alarm and return it

Link to this section Functions

Link to this function alarm_with_name(conn, name)

Get the alarm with the given name, or nil if no alarms have that name.

If more than one alarm has the name, only returns one of them.

  • name — Name of the alarm to search for.

Returns: a reference to a SpaceEx.KerbalAlarmClock.Alarm object

Link to this function alarms(conn)

A list of all the alarms.

Returns: [alarm, ...], where alarm is a reference to a SpaceEx.KerbalAlarmClock.Alarm object

Link to this function alarms_with_type(conn, type)

Get a list of alarms of the specified type.

  • type — Type of alarm to return.

Returns: [alarm, ...], where alarm is a reference to a SpaceEx.KerbalAlarmClock.Alarm object

Link to this function available(conn)

Whether Kerbal Alarm Clock is available.

Returns: true or false

Link to this function create_alarm(conn, type, name, ut)

Create a new alarm and return it.

  • type — Type of the new alarm.

  • name — Name of the new alarm.

  • ut — Time at which the new alarm should trigger.

Returns: a reference to a SpaceEx.KerbalAlarmClock.Alarm object