OnBonusItemDrop

OxideCarbonItem

Called when a bonus item is dropped.

object OnBonusItemDrop(Item local5, BasePlayer local0, ItemContainer container)

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

Parameters

local5: Item
local0: BasePlayer
container: ItemContainer

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 OnBonusItemDrop(Item local5, BasePlayer local0, ItemContainer container)
{
    Puts("OnBonusItemDrop");

    // 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 LootContainer.DropBonusItems(BaseEntity, ItemContainer)

Passes: Item local5, BasePlayer local0, ItemContainer container

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

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

// …
		variableValue -= (float)num3;
	}
	basePlayer.modifiers.SetVariableValue(Modifier.ModifierType.Scrap_Yield, variableValue);
	if (num3 > 0)
	{
		Item item = ItemManager.Create(ItemManager.Items.Scrap, num3, 0uL, isServerSide: true, 0uL);
		if (item != null)
		{
			if (Interface.CallHook("OnBonusItemDrop", item, basePlayer, container) != null)
			{
				return;
			}
			(item.Drop(GetDropPosition() + new Vector3(0f, 0.5f, 0f), GetInheritedDropVelocity()) as DroppedItem).DropReason = DroppedItem.DropReasonEnum.Loot;
		}
	}
}

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.