RustTip

OnDigitalClockAlarmsSet

OxideCarbonElectronic

Called when digital clock alarms set occurs.

object OnDigitalClockAlarmsSet(DigitalClock digitalClock, ProtoBuf.DigitalClockMessage local0)
Works — the game method in this build is the one the hook was written for.

Parameters

digitalClock
DigitalClock
local0
ProtoBuf.DigitalClockMessage

Return value

objectReturn non-null to cancel the game action.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnDigitalClockAlarmsSet(DigitalClock digitalClock, ProtoBuf.DigitalClockMessage local0)
{
    Puts("OnDigitalClockAlarmsSet");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // non-null cancels the game action
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)
void DigitalClock.RPC_SetAlarms(BaseEntity.RPCMessage)

Passes: DigitalClock digitalClock, ProtoBuf.DigitalClockMessage local0

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, l0)Assembly-CSharp.dll

Where it is called (this branch's game code)

// …
[RPC_Server.MaxRepeatedElements(5)]
public void RPC_SetAlarms(RPCMessage msg)
{
	if (!CanPlayerAdmin(msg.player))
	{
		return;
	}
	using DigitalClockMessage digitalClockMessage = msg.read.Proto<DigitalClockMessage>();
	if (Interface.CallHook("OnDigitalClockAlarmsSet", this, local0) != null)
	{
		return;
	}
	if (digitalClockMessage.alarms.Count > 5)
	{
		return;
	}
	foreach (DigitalClockAlarm alarm in digitalClockMessage.alarms)
// …

Sources: Rust.opj from OxideMod/Oxide.Rust (MIT) and hook metadata of the Carbon documentation (MIT). Method code is decompiled from this branch's server.