OnApartmentRoomUpgrade

OxideCarbonApartments

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

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

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

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

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

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString ( l0, a0, a1, this)Assembly-CSharp.dll

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

// …
	return;
}
ApartmentRoom playerApartment = GetPlayerApartment(player);
if (playerApartment == null)
{
	Debug.LogError("Trying to upgrade room for player " + player.displayName + " but no current room was found!");
	return;
}
if (Interface.CallHook("OnApartmentRoomUpgrade", playerApartment, player, size, this) != null)
{
	return;
}
ApartmentRoom apartmentRoom = FetchClosestUnoccupiedRoom(size);
if (apartmentRoom == null)
{
	Debug.LogError($"Player tried to upgrade to an apartment of size {size} but no unoccupied rooms were found!");
	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.