CanAffordUpgrade

OxideCarbonStructure

Called to determine whether to afford upgrade.

Return true to allow the action and false to block it.

object CanAffordUpgrade(BasePlayer player, BuildingBlock buildingBlock, BuildingGrade.Enum iGrade, ulong iSkin)

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

Parameters

player: BasePlayer
buildingBlock: BuildingBlock
iGrade: BuildingGrade.Enum
iSkin: ulong

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

object — you can affect the game: return a value to change or cancel the action.

private object CanAffordUpgrade(BasePlayer player, BuildingBlock buildingBlock, BuildingGrade.Enum iGrade, ulong iSkin)
{
    Puts("CanAffordUpgrade");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return false; // your value instead of the game result
}

Works in both Oxide and Carbon: Carbon loads Oxide plugins as is.

Injection point

Rust.opj (Oxide)

bool BuildingBlock.CanAffordUpgrade(BuildingGrade.Enum, ulong, BasePlayer)

Passes: BasePlayer player, BuildingBlock buildingBlock, BuildingGrade.Enum iGrade, ulong iSkin

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

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

private bool CanAffordUpgrade(BuildingGrade.Enum iGrade, ulong iSkin, BasePlayer player)
{
	object returnvar = Interface.CallHook("CanAffordUpgrade", player, this, iGrade, iSkin);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	if (player != null && player.IsInCreativeMode && Creative.freeBuild)
	{
		return true;
	}
// …

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.