RustTip

OnFindBurnable

OxideCarbonItem

Called when find burnable occurs.

object OnFindBurnable(BaseOven baseOven)
Works — the game method in this build is the one the hook was written for.

Parameters

baseOven
BaseOven

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnFindBurnable(BaseOven baseOven)
{
    Puts("OnFindBurnable");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return default(Item); // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)
Item BaseOven.FindBurnable()

Passes: BaseOven baseOven

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public Item FindBurnable()
{
	object returnvar = Interface.CallHook("OnFindBurnable", this);
	if (returnvar is Item)
	{
		return (Item)returnvar;
	}
	using (TimeWarning.New("FindBurnable"))
	{
		if (inventory == null)
		{
// …

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.