ICanPickupEntity

OxidePlayer

object ICanPickupEntity(BasePlayer player, DoorCloser doorCloser)
object ICanPickupEntity(BasePlayer player, RFTimedExplosive rFTimedExplosive)

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

Parameters

player: BasePlayer
doorCloser: DoorCloser

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

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

private object ICanPickupEntity(BasePlayer player, DoorCloser doorCloser)
{
    Puts("ICanPickupEntity");

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

    // to affect the game:
    // return null; // null — the game continues as usual
}

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

Injection point 1

Rust.opj (Oxide)

void DoorCloser.RPC_Take(BaseEntity.RPCMessage)

Passes: BasePlayer player, DoorCloser doorCloser

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
public void RPC_Take(RPCMessage rpc)
{
	if (Interface.CallHook("ICanPickupEntity", rpc.player, this) != null)
	{
		return;
	}
	if (!rpc.player.CanInteract() || !rpc.player.CanBuild())
	{
		return;
	}
	Door door = GetDoor();
// …

Injection point 2

Rust.opj (Oxide)

void RFTimedExplosive.Pickup(BaseEntity.RPCMessage)

Passes: BasePlayer player, RFTimedExplosive rFTimedExplosive

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

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

[RPC_Server]
[RPC_Server.IsVisible(3f)]
public void Pickup(RPCMessage msg)
{
	if (Interface.CallHook("ICanPickupEntity", msg.player, this) != null)
	{
		return;
	}
	if (!msg.player.CanInteract() || !IsArmed())
	{
		return;
	}
	Item item = ItemManager.Create(pickupDefinition, 1, 0uL, isServerSide: true, 0uL);
// …

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.