OnEventCollectablePickup

OxideCarbonSeasonal

Called when an event collectable is picked up.

object OnEventCollectablePickup(BasePlayer player, CollectableEasterEgg collectableEasterEgg)

Works — the game method in this build is the one the hook was written for.

Parameters

player: BasePlayer
collectableEasterEgg: CollectableEasterEgg

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 OnEventCollectablePickup(BasePlayer player, CollectableEasterEgg collectableEasterEgg)
{
    Puts("OnEventCollectablePickup");

    // 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 CollectableEasterEgg.RPC_PickUp(BaseEntity.RPCMessage)

Passes: BasePlayer player, CollectableEasterEgg collectableEasterEgg

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

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

// …
	return;
}
if ((bool)EggHuntEvent.serverEvent)
{
	if (!EggHuntEvent.serverEvent.IsEventActive())
	{
		return;
	}
	if (Interface.CallHook("OnEventCollectablePickup", msg.player, this) != null)
	{
		return;
	}
	EggHuntEvent.serverEvent.OnEggCollected(msg.player, this);
	int iAmount = 1;
	msg.player.GiveItem(ItemManager.Create(itemToGive, iAmount, 0uL, isServerSide: true, 0uL));
}
Effect.server.Run(pickupEffect.resourcePath, transform.position + Vector3.up * 0.3f, Vector3.up);
// …

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.