OnPayForUpgrade

OxideCarbonPlayer

Called when a pay for upgrades.

object OnPayForUpgrade(BasePlayer player, BuildingBlock buildingBlock, ConstructionGrade g)

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

Parameters

player: BasePlayer
buildingBlock: BuildingBlock
g: ConstructionGrade

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 OnPayForUpgrade(BasePlayer player, BuildingBlock buildingBlock, ConstructionGrade g)
{
    Puts("OnPayForUpgrade");

    // 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 BuildingBlock.PayForUpgrade(ConstructionGrade, BasePlayer)

Passes: BasePlayer player, BuildingBlock buildingBlock, ConstructionGrade g

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

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

private void PayForUpgrade(ConstructionGrade g, BasePlayer player)
{
	if (Interface.CallHook("OnPayForUpgrade", player, this, g) != null)
	{
		return;
	}
	if (player.IsInCreativeMode && Creative.freeBuild)
	{
		return;
	}
	List<Item> list = new List<Item>();
// …

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.