OnVehicleLockRequest

OxideCarbonVehicle

Called when vehicle lock request occurs.

object OnVehicleLockRequest(ModularCarGarage modularCarGarage, BasePlayer local0, string local1)

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

Parameters

modularCarGarage: ModularCarGarage
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 OnVehicleLockRequest(ModularCarGarage modularCarGarage, BasePlayer local0, string local1)
{
    Puts("OnVehicleLockRequest");

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

Passes: ModularCarGarage modularCarGarage, BasePlayer local0, string local1

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, 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 code = msg.read.String();
	if (Interface.CallHook("OnVehicleLockRequest", this, player, code) != null)
	{
		return;
	}
	ItemAmount itemAmount = lockResourceCost;
	if ((float)player.inventory.GetAmount(itemAmount.itemDef.itemid) >= itemAmount.amount && carOccupant.CarLock.TryAddALock(code, player.userID))
	{
		player.inventory.Take(null, itemAmount.itemDef.itemid, Mathf.CeilToInt(itemAmount.amount));
		Effect.server.Run(addRemoveLockEffect.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.