Struct Alarm

Namespace

Luny

Assembly

Luny.dll

A lightweight readonly struct representing a fixed point in the future. Used for high-performance polling in update loops.

public readonly struct Alarm

Constructors

Alarm(double)

Creates an alarm set to fire after the specified time or ticks.

public Alarm(double target)

Parameters

target double

Fields

Target

public readonly double Target

Field Value

double

Methods

At(double)

Creates an alarm at a specific absolute time.

public static Alarm At(double absoluteTime)

Parameters

absoluteTime double

Returns

Alarm

At(long)

Creates an alarm at a specific total number of ticks.

public static Alarm At(long totalTicks)

Parameters

totalTicks long

Returns

Alarm

CompareTo(Alarm)

public int CompareTo(Alarm other)

Parameters

other Alarm

Returns

int

CompareTo(double)

public int CompareTo(double other)

Parameters

other double

Returns

int

Equals(Alarm)

public bool Equals(Alarm other)

Parameters

other Alarm

Returns

bool

Equals(double)

public bool Equals(double other)

Parameters

other double

Returns

bool

Equals(object)

public override bool Equals(object obj)

Parameters

obj object

Returns

bool

From(double)

Returns a new alarm relative to the provided time. Example: Alarm.In(5).From(Time.ElapsedSeconds)

public Alarm From(double now)

Parameters

now double

Returns

Alarm

From(long)

Returns a new alarm relative to the provided tick. Example: Alarm.In(5).From(Time.FrameCount)

public Alarm From(long currentTick)

Parameters

currentTick long

Returns

Alarm

GetHashCode()

public override int GetHashCode()

Returns

int

In(double)

Creates an alarm set to fire after the specified seconds. Note: Use From(now) to make it relative to a specific time.

public static Alarm In(double seconds)

Parameters

seconds double

Returns

Alarm

In(long)

Creates an alarm set to fire after the specified number of ticks. Note: Use From(now) to make it relative to a specific tick count.

public static Alarm In(long ticks)

Parameters

ticks long

Returns

Alarm

InHours(double)

Creates an alarm set to fire after the specified hours.

public static Alarm InHours(double h)

Parameters

h double

Returns

Alarm

InMilliseconds(double)

Creates an alarm set to fire after the specified milliseconds.

public static Alarm InMilliseconds(double ms)

Parameters

ms double

Returns

Alarm

InMinutes(double)

Creates an alarm set to fire after the specified minutes.

public static Alarm InMinutes(double m)

Parameters

m double

Returns

Alarm

IsElapsed(double)

Returns true if the target time has been reached or passed.

public bool IsElapsed(double now)

Parameters

now double

Returns

bool

RemainingMilliseconds(double)

Returns the remaining time in milliseconds.

public double RemainingMilliseconds(double now)

Parameters

now double

Returns

double

RemainingMinutes(double)

Returns the remaining time in minutes.

public double RemainingMinutes(double now)

Parameters

now double

Returns

double

RemainingSeconds(double)

Returns the remaining time in seconds.

public double RemainingSeconds(double now)

Parameters

now double

Returns

double

ToString()

public override string ToString()

Returns

string

Operators

operator ==(Alarm, Alarm)

public static bool operator ==(Alarm left, Alarm right)

Parameters

left Alarm

right Alarm

Returns

bool

operator ==(Alarm, double)

public static bool operator ==(Alarm left, double right)

Parameters

left Alarm

right double

Returns

bool

operator ==(double, Alarm)

public static bool operator ==(double left, Alarm right)

Parameters

left double

right Alarm

Returns

bool

operator >(Alarm, Alarm)

public static bool operator >(Alarm left, Alarm right)

Parameters

left Alarm

right Alarm

Returns

bool

operator >(Alarm, double)

public static bool operator >(Alarm left, double right)

Parameters

left Alarm

right double

Returns

bool

operator >(double, Alarm)

public static bool operator >(double left, Alarm right)

Parameters

left double

right Alarm

Returns

bool

operator >=(Alarm, Alarm)

public static bool operator >=(Alarm left, Alarm right)

Parameters

left Alarm

right Alarm

Returns

bool

operator >=(Alarm, double)

public static bool operator >=(Alarm left, double right)

Parameters

left Alarm

right double

Returns

bool

operator >=(double, Alarm)

public static bool operator >=(double left, Alarm right)

Parameters

left double

right Alarm

Returns

bool

operator !=(Alarm, Alarm)

public static bool operator !=(Alarm left, Alarm right)

Parameters

left Alarm

right Alarm

Returns

bool

operator !=(Alarm, double)

public static bool operator !=(Alarm left, double right)

Parameters

left Alarm

right double

Returns

bool

operator !=(double, Alarm)

public static bool operator !=(double left, Alarm right)

Parameters

left double

right Alarm

Returns

bool

operator <(Alarm, Alarm)

public static bool operator <(Alarm left, Alarm right)

Parameters

left Alarm

right Alarm

Returns

bool

operator <(Alarm, double)

public static bool operator <(Alarm left, double right)

Parameters

left Alarm

right double

Returns

bool

operator <(double, Alarm)

public static bool operator <(double left, Alarm right)

Parameters

left double

right Alarm

Returns

bool

operator <=(Alarm, Alarm)

public static bool operator <=(Alarm left, Alarm right)

Parameters

left Alarm

right Alarm

Returns

bool

operator <=(Alarm, double)

public static bool operator <=(Alarm left, double right)

Parameters

left Alarm

right double

Returns

bool

operator <=(double, Alarm)

public static bool operator <=(double left, Alarm right)

Parameters

left double

right Alarm

Returns

bool