CanPickupEntity

OxideCarbonPlayer

Called to determine whether to pickup entity.

Return true to allow the action and false to block it.

object CanPickupEntity(BasePlayer player, BaseCombatEntity baseCombatEntity)

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

Parameters

player: BasePlayer
baseCombatEntity: BaseCombatEntity

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object CanPickupEntity(BasePlayer player, BaseCombatEntity baseCombatEntity)
{
    Puts("CanPickupEntity");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Where it is called

Oxide core (Oxide.Rust)

RustCore::ICanPickupEntity(BasePlayer basePlayer, BaseEntity entity)

Oxide core code — the hook is called from here

private object ICanPickupEntity(BasePlayer basePlayer, BaseEntity entity)
{
    object callHook = Interface.CallHook("CanPickupEntity", basePlayer, entity);
    return callHook is bool result && !result ? (object)true : null;
}

Injection point

Rust.opj (Oxide)

bool BaseCombatEntity.CanCompletePickup(BasePlayer)

Passes: BasePlayer player, BaseCombatEntity baseCombatEntity

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

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

protected virtual bool CanCompletePickup(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanPickupEntity", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	return true;
}

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.