OnCodeEntered

OxideCarbonStructure

Called when a code is entered.

object OnCodeEntered(CodeLock codeLock, BasePlayer player, string local0)

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

Parameters

codeLock: CodeLock
player: BasePlayer
local0: string

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 OnCodeEntered(CodeLock codeLock, BasePlayer player, string local0)
{
    Puts("OnCodeEntered");

    // 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 CodeLock.UnlockWithCode(BaseEntity.RPCMessage)

Passes: CodeLock codeLock, BasePlayer player, string local0

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

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

// …
[RPC_Server.MaxDistance(3f, CheckParent = true)]
private void UnlockWithCode(RPCMessage rpc)
{
	if (!rpc.player.CanInteract() || !IsLocked() || IsCodeEntryBlocked())
	{
		return;
	}
	string text = rpc.read.String();
	if (Interface.CallHook("OnCodeEntered", this, rpc.player, text) != null)
	{
		return;
	}
	bool flag = text == guestCode;
	bool flag2 = text == code;
	if (!(text == code) && (!hasGuestCode || !(text == guestCode)))
	{
		if (Time.realtimeSinceStartup > lastWrongTime + 60f)
// …

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.