OnLockRemove

OxideCarbonVehicle

Called when a lock is removed.

object OnLockRemove(ModularCar carOccupant, BasePlayer player)

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

Parameters

carOccupant: ModularCar
player: BasePlayer

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 OnLockRemove(ModularCar carOccupant, BasePlayer player)
{
    Puts("OnLockRemove");

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

Passes: ModularCar carOccupant, BasePlayer player

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
[RPC_Server.IsVisible(3f)]
public void RPC_RequestRemoveLock(RPCMessage msg)
{
	if (HasOccupant && carOccupant.CarLock.HasALock)
	{
		if (Interface.CallHook("OnLockRemove", this.carOccupant, msg.player) != null)
		{
			return;
		}
		carOccupant.CarLock.RemoveLock();
		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.