Alarm#

type krpc_KerbalAlarmClock_Alarm_t#

Represents an alarm. Obtained by calling krpc_KerbalAlarmClock_Alarms(), krpc_KerbalAlarmClock_AlarmWithName() or krpc_KerbalAlarmClock_AlarmsWithType().

krpc_error_t krpc_KerbalAlarmClock_Alarm_Action(krpc_connection_t connection, krpc_KerbalAlarmClock_AlarmAction_t *result)#

void krpc_KerbalAlarmClock_Alarm_set_Action(krpc_KerbalAlarmClock_AlarmAction_t value)#: The action that the alarm triggers.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Margin(krpc_connection_t connection, double *result)#

void krpc_KerbalAlarmClock_Alarm_set_Margin(double value)#: The number of seconds before the event that the alarm will fire.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Time(krpc_connection_t connection, double *result)#

void krpc_KerbalAlarmClock_Alarm_set_Time(double value)#: The time at which the alarm will fire.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Type(krpc_connection_t connection, krpc_KerbalAlarmClock_AlarmType_t *result)#: The type of the alarm.

krpc_error_t krpc_KerbalAlarmClock_Alarm_ID(krpc_connection_t connection, char **result)#: The unique identifier for the alarm.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Name(krpc_connection_t connection, char **result)#

void krpc_KerbalAlarmClock_Alarm_set_Name(const char *value)#: The short name of the alarm.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Notes(krpc_connection_t connection, char **result)#

void krpc_KerbalAlarmClock_Alarm_set_Notes(const char *value)#: The long description of the alarm.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Remaining(krpc_connection_t connection, double *result)#: The number of seconds until the alarm will fire.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Enabled(krpc_connection_t connection, bool *result)#

void krpc_KerbalAlarmClock_Alarm_set_Enabled(bool value)#: Whether the alarm is enabled. A disabled alarm does not fire.

krpc_error_t krpc_KerbalAlarmClock_Alarm_PlaySound(krpc_connection_t connection, bool *result)#

void krpc_KerbalAlarmClock_Alarm_set_PlaySound(bool value)#: Whether the alarm plays a sound when it fires.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Triggered(krpc_connection_t connection, bool *result)#: 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.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Repeat(krpc_connection_t connection, bool *result)#

void krpc_KerbalAlarmClock_Alarm_set_Repeat(bool value)#: Whether the alarm will be repeated after it has fired. Only has an effect for alarm types that support repeating (see krpc_KerbalAlarmClock_Alarm_SupportsRepeat()).

krpc_error_t krpc_KerbalAlarmClock_Alarm_SupportsRepeat(krpc_connection_t connection, bool *result)#: Whether this alarm’s type supports repeating (see krpc_KerbalAlarmClock_Alarm_Repeat()).

krpc_error_t krpc_KerbalAlarmClock_Alarm_RepeatPeriod(krpc_connection_t connection, double *result)#

void krpc_KerbalAlarmClock_Alarm_set_RepeatPeriod(double value)#: 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 krpc_KerbalAlarmClock_Alarm_SupportsRepeatPeriod()).

krpc_error_t krpc_KerbalAlarmClock_Alarm_SupportsRepeatPeriod(krpc_connection_t connection, bool *result)#: Whether this alarm’s type supports a repeat period (see krpc_KerbalAlarmClock_Alarm_RepeatPeriod()).

krpc_error_t krpc_KerbalAlarmClock_Alarm_Vessel(krpc_connection_t connection, krpc_SpaceCenter_Vessel_t *result)#

void krpc_KerbalAlarmClock_Alarm_set_Vessel(krpc_SpaceCenter_Vessel_t value)#: The vessel that the alarm is attached to.

krpc_error_t krpc_KerbalAlarmClock_Alarm_XferOriginBody(krpc_connection_t connection, krpc_SpaceCenter_CelestialBody_t *result)#

void krpc_KerbalAlarmClock_Alarm_set_XferOriginBody(krpc_SpaceCenter_CelestialBody_t value)#: The celestial body the vessel is departing from.

krpc_error_t krpc_KerbalAlarmClock_Alarm_XferTargetBody(krpc_connection_t connection, krpc_SpaceCenter_CelestialBody_t *result)#

void krpc_KerbalAlarmClock_Alarm_set_XferTargetBody(krpc_SpaceCenter_CelestialBody_t value)#: The celestial body the vessel is arriving at.

krpc_error_t krpc_KerbalAlarmClock_Alarm_Remove(krpc_connection_t connection)#: Removes the alarm. Any further use of this object throws an exception.