RustTip

OnDoorKnocked

OxideStructure
void OnDoorKnocked(Door door, BasePlayer player)
void OnDoorKnocked(DoorKnocker doorKnocker, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

door
Door
player
BasePlayer

Return value

voidThe return value is ignored — the hook only notifies.

Example

private void OnDoorKnocked(Door door, BasePlayer player)
{
    Puts("OnDoorKnocked");
}

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

Injection point 1

Rust.opj (Oxide)
void Door.RPC_KnockDoor(BaseEntity.RPCMessage)

Passes: Door door, BasePlayer player

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

Injection point 2

Rust.opj (Oxide)
void DoorKnocker.Knock(BasePlayer)

Passes: DoorKnocker doorKnocker, BasePlayer player

WorksReturnBehavior: ContinueArgumentBehavior: AllAssembly-CSharp.dll

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

public void Knock(BasePlayer player)
{
	ClientRPC(RpcTarget.NetworkGroup("ClientKnock"), player.transform.position);
Interface.CallHook("OnDoorKnocked", this, player);
}

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.