RustTip

OnCodeChange

OxideCarbonVehicle

Called when a code is changed.

object OnCodeChange(ModularCar carOccupant, BasePlayer local0, string local1)
Works — the game method in this build is the one the hook was written for.

Parameters

carOccupant
ModularCar
local0
BasePlayer
local1
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 OnCodeChange(ModularCar carOccupant, BasePlayer local0, string local1)
{
    Puts("OnCodeChange");

    // 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 ModularCarGarage.RPC_RequestNewCode(BaseEntity.RPCMessage)

Passes: ModularCar carOccupant, BasePlayer local0, string local1

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

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

// …
if (!HasOccupant || !carOccupant.CarLock.HasALock)
{
	return;
}
BasePlayer player = msg.player;
if (!(player == null))
{
	string newCode = msg.read.String();
	if (Interface.CallHook("OnCodeChange", this.carOccupant, player, newCode) != null)
	{
		return;
	}
	if (carOccupant.CarLock.TrySetNewCode(newCode, player.userID))
	{
		Effect.server.Run(changeLockCodeEffect.resourcePath, this, 0u, Vector3.zero, Vector3.zero);
	}
}
// …

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.