RustTip

OnRentableShopBreakInComplete

OxideCarbonApartments
object OnRentableShopBreakInComplete(RentableShop rentableShop, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

rentableShop
RentableShop
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 OnRentableShopBreakInComplete(RentableShop rentableShop, BasePlayer player)
{
    Puts("OnRentableShopBreakInComplete");

    // 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 RentableShop.CompleteBreakIn(BasePlayer)

Passes: RentableShop rentableShop, BasePlayer player

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

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

// …
{
	return;
}
breakInStarts.Remove(player.userID);
if ((float)value < ApartmentCommands.breakinseconds * 0.9f)
{
	return;
}
if (Interface.CallHook("OnRentableShopBreakInComplete", this, player) != null)
{
	return;
}
VendingMachine vendingMachine = SpawnedVendingMachineRef.Get(isServer);
if (vendingMachine == null)
{
	return;
}
// …

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.