OnApartmentRoomPurchase

OxideCarbonApartments

object OnApartmentRoomPurchase(ApartmentRoom local0, BasePlayer player, ApartmentSize size, ApartmentBuilding apartmentBuilding)

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

Parameters

local0: ApartmentRoom
player: BasePlayer
size: ApartmentSize
apartmentBuilding: ApartmentBuilding

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 OnApartmentRoomPurchase(ApartmentRoom local0, BasePlayer player, ApartmentSize size, ApartmentBuilding apartmentBuilding)
{
    Puts("OnApartmentRoomPurchase");

    // 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 ApartmentBuilding.PurchaseRoom(BasePlayer, ApartmentSize)

Passes: ApartmentRoom local0, BasePlayer player, ApartmentSize size, ApartmentBuilding apartmentBuilding

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: UseArgumentString ( l0, a0, a1, this)Assembly-CSharp.dll

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

private void PurchaseRoom(BasePlayer player, ApartmentSize size)
{
	ApartmentRoom apartmentRoom = FetchClosestUnoccupiedRoom(size);
	if (apartmentRoom == null)
	{
		Debug.LogError($"Player tried to purchase an apartment of size {size} but no unoccupied rooms were found!");
		return;
	}
	if (Interface.CallHook("OnApartmentRoomPurchase", apartmentRoom, player, size, this) != null)
	{
		return;
	}
	int purchaseScrapCost = GetPurchaseScrapCost(size);
	player.inventory.Take(null, ItemManager.Items.Scrap.itemid, purchaseScrapCost);
	GiveRoomToPlayer(player, apartmentRoom);
	player.GiveAchievement("RENT_APARTMENT");
	Analytics.Azure.OnApartmentCheckIn(player, apartmentRoom, purchaseScrapCost);
// …

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.