OnItemResearch

OxideCarbonItem

Called when an item is researched.

void OnItemResearch(ResearchTable researchTable, Item local1, BasePlayer local0)

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

Parameters

researchTable: ResearchTable
local1: Item
local0: BasePlayer

Return value

voidThe return value is ignored — the hook only notifies.

Example

private void OnItemResearch(ResearchTable researchTable, Item local1, BasePlayer local0)
{
    Puts("OnItemResearch");
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

void ResearchTable.DoResearch(BaseEntity.RPCMessage)

Passes: ResearchTable researchTable, Item local1, BasePlayer local0

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

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

// …
{
	return;
}
BasePlayer player = msg.player;
Item targetItem = GetTargetItem();
if (targetItem != null && targetItem.amount <= 1 && IsItemResearchable(targetItem) && (!onlyOneUser || !(msg.player.inventory.loot.entitySource != this)))
{
	targetItem.CollectedForCrafting(player);
	Interface.CallHook("OnItemResearch", this, targetItem, player);
	researchFinishedTime = Time.realtimeSinceStartup + researchDuration;
	Invoke(ResearchAttemptFinished, researchDuration);
	inventory.SetLocked(isLocked: true);
	int scrapCost = ScrapForResearch(targetItem);
	Analytics.Azure.OnResearchStarted(player, this, targetItem, scrapCost);
	SetFlagLocal(Flags.On, b: true);
	SendNetworkUpdate();
	player.inventory.loot.SendImmediate();
// …

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.