RustTip

OnHuntEventEnd

OxideCarbonSeasonal

Called when a hunt event ends.

object OnHuntEventEnd(EggHuntEvent eggHuntEvent)
Works — the game method in this build is the one the hook was written for.

Parameters

eggHuntEvent
EggHuntEvent

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 OnHuntEventEnd(EggHuntEvent eggHuntEvent)
{
    Puts("OnHuntEventEnd");

    // 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 EggHuntEvent.Update()

Passes: EggHuntEvent eggHuntEvent

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: UseArgumentString (this)Assembly-CSharp.dll

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

// …
}
using FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate);
if (timeAlive - warmupTime > durationSeconds - warnTime)
{
	flagsUpdateScope.Set(Flags.Reserved1, b: true);
}
if (timeAlive - warmupTime > durationSeconds && !IsInvoking(Cooldown))
{
	if (Interface.CallHook("OnHuntEventEnd", this) != null)
	{
		return;
	}
	flagsUpdateScope.Set(Flags.Reserved2, b: true);
	CleanupEggs();
	PrintWinnersAndAward();
	Invoke(Cooldown, 10f);
}
// …

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.