OnPlayerHandcuff

OxideCarbonPlayer

Called when player handcuff occurs.

object OnPlayerHandcuff(BasePlayer victim, BasePlayer handcuffer)

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

Parameters

victim: BasePlayer
handcuffer: BasePlayer

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 OnPlayerHandcuff(BasePlayer victim, BasePlayer handcuffer)
{
    Puts("OnPlayerHandcuff");

    // 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 Handcuffs.SV_HandcuffVictim(BasePlayer, BasePlayer)

Passes: BasePlayer victim, BasePlayer handcuffer

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: JustParamsAssembly-CSharp.dll

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

// …
{
	return;
}
Item ownerItem = GetOwnerItem();
if (ownerItem == null)
{
	return;
}
if (Interface.CallHook("OnPlayerHandcuff", victim, handcuffer) != null)
{
	return;
}
victim.SetPlayerFlag(BasePlayer.PlayerFlags.IsRestrained, b: true);
victim.SendNetworkUpdateImmediate();
ownerItem.SetFlag(Item.Flag.IsOn, b: true);
bool flag = true;
if (!ownerItem.MoveToContainer(victim.inventory.containerBelt))
// …

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.