CanUseLockedEntity

OxidePlayer

object CanUseLockedEntity(BasePlayer player, CodeLock codeLock)
object CanUseLockedEntity(BasePlayer player, KeyLock keyLock)

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

Parameters

player: BasePlayer
codeLock: CodeLock

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

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

private object CanUseLockedEntity(BasePlayer player, CodeLock codeLock)
{
    Puts("CanUseLockedEntity");

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

    // to affect the game:
    // return null; // null — the game continues as usual
}

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

Injection point 1

Rust.opj (Oxide)

bool CodeLock.OnTryToOpen(BasePlayer)

Passes: BasePlayer player, CodeLock codeLock

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0, this)Assembly-CSharp.dll

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

public override bool OnTryToOpen(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUseLockedEntity", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (!IsLocked())
	{
		return true;
	}
// …

Injection point 2

Rust.opj (Oxide)

bool CodeLock.OnTryToClose(BasePlayer)

Passes: BasePlayer player, CodeLock codeLock

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0, this)Assembly-CSharp.dll

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

public override bool OnTryToClose(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUseLockedEntity", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (!IsLocked())
	{
		return true;
	}
// …

Injection point 3

Rust.opj (Oxide)

bool KeyLock.OnTryToClose(BasePlayer)

Passes: BasePlayer player, KeyLock keyLock

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0, this)Assembly-CSharp.dll

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

public override bool OnTryToClose(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUseLockedEntity", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (HasLockPermission(player))
	{
		return true;
	}
// …

Injection point 4

Rust.opj (Oxide)

bool KeyLock.OnTryToOpen(BasePlayer)

Passes: BasePlayer player, KeyLock keyLock

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (a0, this)Assembly-CSharp.dll

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

public override bool OnTryToOpen(BasePlayer player)
{
	object returnvar = Interface.CallHook("CanUseLockedEntity", player, this);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (HasLockPermission(player))
	{
		return true;
	}
// …

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.