OnRecyclerToggle

OxideCarbonEntity

Called when a recycler toggles.

object OnRecyclerToggle(Recycler recycler, BasePlayer player)

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

Parameters

recycler: Recycler
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 OnRecyclerToggle(Recycler recycler, BasePlayer player)
{
    Puts("OnRecyclerToggle");

    // 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 Recycler.SVSwitch(BaseEntity.RPCMessage)

Passes: Recycler recycler, BasePlayer player

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

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

// …
[RPC_Server.MaxDistance(3f)]
private void SVSwitch(RPCMessage msg)
{
	bool flag = msg.read.Bit();
	if (flag == IsOn() || msg.player == null || (onlyOneUser && msg.player.inventory.loot.entitySource != this) || (flag && GetRecyclerState() == RecyclerState.Unpowered) || (flag && !HasRecyclable()))
	{
		return;
	}
	if (Interface.CallHook("OnRecyclerToggle", this, msg.player) != null)
	{
		return;
	}
	if (flag)
	{
		foreach (Item item in inventory.itemList)
		{
			item.CollectedForCrafting(msg.player);
// …

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.