OnVendingShopRename

OxideCarbonVending

Called when vending shop rename occurs.

object OnVendingShopRename(VendingMachine vendingMachine, string local1, BasePlayer local0)

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

Parameters

vendingMachine: VendingMachine
local1: string
local0: 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 OnVendingShopRename(VendingMachine vendingMachine, string local1, BasePlayer local0)
{
    Puts("OnVendingShopRename");

    // 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 VendingMachine.RPC_UpdateShopName(BaseEntity.RPCMessage)

Passes: VendingMachine vendingMachine, string local1, BasePlayer local0

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

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

[RPC_Server]
[RPC_Server.IsVisible(3f)]
public virtual void RPC_UpdateShopName(RPCMessage msg)
{
	BasePlayer player = msg.player;
	string text = msg.read.String(32);
	if (CanPlayerAdmin(player))
	{
		if (Interface.CallHook("OnVendingShopRename", this, text, player) != null)
		{
			return;
		}
		shopName = text;
		nameLastEditedBy = player.userID.Get();
		UpdateMapMarker();
		Analytics.Azure.OnUGCCreated(player, this, "vending_machine_name", text.Length);
	}
// …

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.