OnItemLock

OxideCarbonItem

Called when an item is locked.

object OnItemLock(bool bNewState)

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

Parameters

bNewState: bool

Return value

objectReturn non-null to stop the game method.

Example

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

private object OnItemLock(bool bNewState)
{
    Puts("OnItemLock");

    // 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 Item.LockUnlock(bool)

Passes: bool bNewState

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

public void LockUnlock(bool bNewState)
{
	if (HasFlag(Flag.IsLocked) != bNewState)
	{
		if (Interface.CallHook("OnItemLock", bNewState) != null)
		{
			return this;
		}
		SetFlag(Flag.IsLocked, bNewState);
		MarkDirty();
	}
}

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.