OnSprayRemove

OxideCarbonEntity

Called when a spray is removed.

object OnSprayRemove(SprayCanSpray sprayCanSpray, BasePlayer local0)

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

Parameters

sprayCanSpray: SprayCanSpray
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 OnSprayRemove(SprayCanSpray sprayCanSpray, BasePlayer local0)
{
    Puts("OnSprayRemove");

    // 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 SprayCanSpray.Server_RequestWaterClear(BaseEntity.RPCMessage)

Passes: SprayCanSpray sprayCanSpray, BasePlayer local0

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

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

[RPC_Server]
private void Server_RequestWaterClear(RPCMessage msg)
{
	BasePlayer player = msg.player;
	if (!(player == null) && Menu_WaterClear_ShowIf(player))
	{
		if (Interface.CallHook("OnSprayRemove", this, player) != null)
		{
			return;
		}
		Kill();
	}
}

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.