OnStructureRotate

OxideCarbonStructure

Called when a structure is rotated.

object OnStructureRotate(BuildingBlock buildingBlock, BasePlayer player)

Method changed — check — the game method differs from the one the hook is recorded for in Oxide. The hook is still called, but its place may have shifted — worth checking after an update.

Parameters

buildingBlock: BuildingBlock
player: BasePlayer

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

    // 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.DoRotation(BaseEntity.RPCMessage)

Passes: BuildingBlock buildingBlock, BasePlayer player

Method changed — checkReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, a0.player)Assembly-CSharp.dll

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
private void DoRotation(RPCMessage msg)
{
	if (msg.player.CanInteract() && CanRotate(msg.player) && blockDefinition.canRotateAfterPlacement)
	{
		if (Interface.CallHook("OnStructureRotate", this, msg.player) != null)
		{
			return;
		}
		transform.localRotation *= Quaternion.Euler(blockDefinition.rotationAmount);
		Analytics.Azure.OnBuildingBlockRotated(msg.player, this);
		RefreshEntityLinks();
		UpdateSurroundingEntities();
		UpdateSkin(force: 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.