OnDefaultItemsReceive

OxideCarbonPlayer

Called when default items receive occurs.

object OnDefaultItemsReceive(PlayerInventory playerInventory)

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

Parameters

playerInventory: PlayerInventory

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 OnDefaultItemsReceive(PlayerInventory playerInventory)
{
    Puts("OnDefaultItemsReceive");

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

Passes: PlayerInventory playerInventory

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

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

public void GiveDefaultItems()
{
	if (Interface.CallHook("OnDefaultItemsReceive", this) != null)
	{
		return;
	}
	Strip();
	BaseGameMode activeGameMode = BaseGameMode.GetActiveGameMode(serverside: true);
	if (activeGameMode != null && activeGameMode.HasLoadouts())
	{
		BaseGameMode.GetActiveGameMode(serverside: true).LoadoutPlayer(baseEntity);
// …

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.