CanAffordToPlace

OxideCarbonStructure

Called to determine whether to afford to place.

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

object CanAffordToPlace(BasePlayer local0, Planner planner, Construction component)

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

Parameters

local0: BasePlayer
planner: Planner
component: Construction

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 CanAffordToPlace(BasePlayer local0, Planner planner, Construction component)
{
    Puts("CanAffordToPlace");

    // 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 Planner.CanAffordToPlace(Construction)

Passes: BasePlayer local0, Planner planner, Construction component

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

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

// …
{
	return true;
}
BasePlayer ownerPlayer = GetOwnerPlayer();
if (!ownerPlayer)
{
	return false;
}
object returnvar = Interface.CallHook("CanAffordToPlace", ownerPlayer, this, component);
if (returnvar is bool)
{
	return (bool)returnvar;
}
if (ownerPlayer.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.