OnCollectiblePickup

OxideCarbonResource

Called when a collectible is picked up.

object OnCollectiblePickup(CollectibleEntity collectibleEntity, BasePlayer reciever, bool eat)

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

Parameters

collectibleEntity: CollectibleEntity
reciever: BasePlayer
eat: bool

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 OnCollectiblePickup(CollectibleEntity collectibleEntity, BasePlayer reciever, bool eat)
{
    Puts("OnCollectiblePickup");

    // 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 CollectibleEntity.DoPickup(BasePlayer, bool)

Passes: CollectibleEntity collectibleEntity, BasePlayer reciever, bool eat

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

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

public void DoPickup(BasePlayer reciever, bool eat = false)
{
	if (itemList == null)
	{
		return;
	}
	if (Interface.CallHook("OnCollectiblePickup", this, reciever, eat) != null)
	{
		return;
	}
	float num = ((reciever.modifiers != null) ? reciever.modifiers.GetValue(Modifier.ModifierType.Collectible_DoubleYield) : 0f);
	bool flag = num != 0f && Random.value < num;
	ItemAmount[] array = itemList;
	foreach (ItemAmount itemAmount in array)
	{
// …

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.