OnExperimentStart

OxideCarbonPlayer

Called when an experiment starts.

object OnExperimentStart(Workbench workbench, BasePlayer local0)

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

Parameters

workbench: Workbench
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 OnExperimentStart(Workbench workbench, BasePlayer local0)
{
    Puts("OnExperimentStart");

    // 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 Workbench.RPC_BeginExperiment(BaseEntity.RPCMessage)

Passes: Workbench workbench, BasePlayer local0

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

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

// …
		break;
	}
}
if (pendingBlueprint == null)
{
	player.ChatMessage("You have already unlocked everything for this workbench tier.");
	return;
}
if (Interface.CallHook("OnExperimentStart", this, player) != null)
{
	return;
}
Item slot = inventory.GetSlot(0);
if (slot != null)
{
	if (!slot.MoveToContainer(player.inventory.containerMain))
	{
// …

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.