CanResearchItem

OxideCarbonPlayer

Called to determine whether to research item.

Return true to allow the action and false to block it.

object CanResearchItem(BasePlayer local0, Item local1)

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

Parameters

local0: BasePlayer
local1: Item

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 CanResearchItem(BasePlayer local0, Item local1)
{
    Puts("CanResearchItem");

    // 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 ResearchTable.DoResearch(BaseEntity.RPCMessage)

Passes: BasePlayer local0, Item local1

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

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

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

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.