OnConstructionPlace

OxideCarbonStructure

Called when a construction is placed.

object OnConstructionPlace(BaseEntity baseEntity, Construction component, Construction.Target placement, BasePlayer basePlayer)

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

Parameters

baseEntity: BaseEntity
component: Construction
placement: Construction.Target
basePlayer: BasePlayer

Return value

objectReturn non-null to stop the game method.

Example

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

private object OnConstructionPlace(BaseEntity baseEntity, Construction component, Construction.Target placement, BasePlayer basePlayer)
{
    Puts("OnConstructionPlace");

    // 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)

GameObject Planner.DoPlacement(Construction.Target, Construction)

Passes: BaseEntity baseEntity, Construction component, Construction.Target placement, BasePlayer basePlayer

WorksReturnBehavior: ExitWhenNonNullAssembly-CSharp.dll

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

// …
	{
		return null;
	}
	BaseEntity baseEntity = component.CreateConstruction(placement, bNeedsValidPlacement: true);
	if (!baseEntity)
	{
		return null;
	}
	if (Interface.CallHook("OnConstructionPlace", baseEntity, component, placement, ownerPlayer) != null)
	{
		return BaseNetworkableEx.IsValid(baseEntity);
	}
	return SpawnConstruction(baseEntity, ownerPlayer, 0uL);
}

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.