Alarm#

public class Alarm#

Represents an alarm. Obtained by calling getAlarms(), alarmWithName(String) or alarmsWithType(AlarmType).

AlarmAction getAction()#

void setAction(AlarmAction value)#: The action that the alarm triggers.

double getMargin()#

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

double getTime()#

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

AlarmType getType()#: The type of the alarm.

String getID()#: The unique identifier for the alarm.

String getName()#

void setName(String value)#: The short name of the alarm.

String getNotes()#

void setNotes(String value)#: The long description of the alarm.

double getRemaining()#: The number of seconds until the alarm will fire.

boolean getEnabled()#

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

boolean getPlaySound()#

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

boolean getTriggered()#: 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.

boolean getRepeat()#

void setRepeat(boolean value)#: Whether the alarm will be repeated after it has fired. Only has an effect for alarm types that support repeating (see Alarm.getSupportsRepeat()).

boolean getSupportsRepeat()#: Whether this alarm’s type supports repeating (see Alarm.getRepeat()).

double getRepeatPeriod()#

void setRepeatPeriod(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 Alarm.getSupportsRepeatPeriod()).

boolean getSupportsRepeatPeriod()#: Whether this alarm’s type supports a repeat period (see Alarm.getRepeatPeriod()).

SpaceCenter.Vessel getVessel()#

void setVessel(SpaceCenter.Vessel value)#: The vessel that the alarm is attached to.

SpaceCenter.CelestialBody getXferOriginBody()#

void setXferOriginBody(SpaceCenter.CelestialBody value)#: The celestial body the vessel is departing from.

SpaceCenter.CelestialBody getXferTargetBody()#

void setXferTargetBody(SpaceCenter.CelestialBody value)#: The celestial body the vessel is arriving at.

void remove()#: Removes the alarm. Any further use of this object throws an exception.