OnExperimentEnd

OxideCarbonPlayer

Called when an experiment ends.

object OnExperimentEnd(Workbench workbench)

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

Parameters

workbench: Workbench

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 OnExperimentEnd(Workbench workbench)
{
    Puts("OnExperimentEnd");

    // 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.ExperimentComplete()

Passes: Workbench workbench

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void ExperimentComplete()
{
	Item experimentResourceItem = GetExperimentResourceItem();
	int scrapForExperiment = GetScrapForExperiment();
	if (pendingBlueprint == null)
	{
		Debug.LogWarning("Pending blueprint was null!");
	}
	if (Interface.CallHook("OnExperimentEnd", this) != null)
	{
		return;
	}
	if (experimentResourceItem != null && experimentResourceItem.amount >= scrapForExperiment && pendingBlueprint != null)
	{
		experimentResourceItem.UseItem(scrapForExperiment);
		Item item = ItemManager.Create(GetBlueprintTemplate(), 1, 0uL, isServerSide: true, 0uL);
		item.blueprintTarget = pendingBlueprint.itemid;
// …

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.