OnShopCancelClick

OxideCarbonShop

Called when shop cancel click occurs.

object OnShopCancelClick(ShopFront shopFront, BasePlayer player)

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

Parameters

shopFront: ShopFront
player: 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 OnShopCancelClick(ShopFront shopFront, BasePlayer player)
{
    Puts("OnShopCancelClick");

    // 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 ShopFront.CancelClicked(BaseEntity.RPCMessage)

Passes: ShopFront shopFront, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.IsVisible(3f)]
public void CancelClicked(RPCMessage msg)
{
	if (IsTradingPlayer(msg.player))
	{
		if (Interface.CallHook("OnShopCancelClick", this, msg.player) != null)
		{
			return;
		}
		_ = (bool)vendorPlayer;
		_ = (bool)customerPlayer;
		ResetTrade();
	}
}

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.