OnCupboardClearList

OxideCarbonStructure

Called when cupboard clear list occurs.

object OnCupboardClearList(BuildingPrivlidge buildingPrivlidge, BasePlayer player)
object OnCupboardClearList(VehiclePrivilege vehiclePrivilege, BasePlayer player)

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

Parameters

buildingPrivlidge: BuildingPrivlidge
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 OnCupboardClearList(BuildingPrivlidge buildingPrivlidge, BasePlayer player)
{
    Puts("OnCupboardClearList");

    // 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 1

Rust.opj (Oxide)

void BuildingPrivlidge.ClearList(BaseEntity.RPCMessage)

Passes: BuildingPrivlidge buildingPrivlidge, 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)]
private void ClearList(RPCMessage rpc)
{
	if (rpc.player.CanInteract() && CanAdministrate(rpc.player))
	{
		if (Interface.CallHook("OnCupboardClearList", this, rpc.player) != null)
		{
			return;
		}
		ClearAuthList();
		SendNetworkUpdate();
	}
}

Injection point 2

Rust.opj (Oxide)

void VehiclePrivilege.ClearList(BaseEntity.RPCMessage)

Passes: VehiclePrivilege vehiclePrivilege, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
private void ClearList(RPCMessage rpc)
{
	if (rpc.player.CanInteract() && CanModifyAuth(rpc.player))
	{
		if (Interface.CallHook("OnCupboardClearList", this, rpc.player) != null)
		{
			return;
		}
		authorizedPlayers.Clear();
		UpdateMaxAuthCapacity();
		UpdatePrivilegeReceivers();
		SendNetworkUpdate();
	}
// …

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.