OnApartmentMasterKeyPurchase

OxideCarbonApartments

object OnApartmentMasterKeyPurchase(BasePlayer player)

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

Parameters

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 OnApartmentMasterKeyPurchase(BasePlayer player)
{
    Puts("OnApartmentMasterKeyPurchase");

    // 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 NPCApartmentSecurity.OnPurchaseKey(BasePlayer, Vector3)

Passes: BasePlayer player

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

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

public static void OnPurchaseKey(BasePlayer player, Vector3 position)
{
	if (Interface.CallHook("OnApartmentMasterKeyPurchase", player) != null)
	{
		return;
	}
	ItemDefinition itemDefinition = ItemManager.FindItemDefinition("scrap");
	int masterkeyprice = ApartmentCommands.masterkeyprice;
	if (player.inventory.GetAmount(itemDefinition) < masterkeyprice)
	{
		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.