OnHuntEventStart

OxideCarbonSeasonal

Called when a hunt event starts.

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

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

Passes: EggHuntEvent eggHuntEvent

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: JustThisAssembly-CSharp.dll

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

private void StartEvent()
{
	if (Interface.CallHook("OnHuntEventStart", this) != null)
	{
		return;
	}
	int count = BasePlayer.activePlayerList.Count;
	if (includeBots)
	{
		count = GetCombinedPlayerList(wantBots: true).Count;
	}
// …

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.