CanBuild

OxideCarbonStructure

Called to determine whether to build.

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

object CanBuild(Planner planner, Construction local1, Construction.Target local3)

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

Parameters

planner: Planner
local1: Construction
local3: Construction.Target

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 CanBuild(Planner planner, Construction local1, Construction.Target local3)
{
    Puts("CanBuild");

    // 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 Planner.DoBuild(ProtoBuf.CreateBuilding)

Passes: Planner planner, Construction local1, Construction.Target local3

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, l1, l3)Assembly-CSharp.dll

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

// …
target.rotation = msg.rotation;
target.player = ownerPlayer;
target.isHoldingShift = msg.isHoldingShift;
target.snappingMode = msg.snappingMode;
target.isSnapped = msg.isSnapped;
target.snappedPosition = msg.snappedPosition;
target.snappedRotation = msg.snappedRotation;
target.valid = true;
if (Interface.CallHook("CanBuild", this, construction, target) != null)
{
	return;
}
target.shouldParent = ShouldParent(target.entity, deployable);
if (target.shouldParent)
{
	PlayerBoat parentPlayerBoat = PlayerBoat.GetParentPlayerBoat(target.entity, includeEntityItself: true);
	if (parentPlayerBoat != null && (!parentPlayerBoat.VerifyDeployablePlacement(ownerPlayer) || (!construction.canBypassBuildingPermission && !parentPlayerBoat.IsAuthedForBuilding(ownerPlayer))))
// …

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.