OnStructureDemolish

OxideStructure

object OnStructureDemolish(DecayEntity decayEntity, BasePlayer player, object true)

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

Parameters

decayEntity: DecayEntity
player: BasePlayer
true: object

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

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

private object OnStructureDemolish(DecayEntity decayEntity, BasePlayer player, object true)
{
    Puts("OnStructureDemolish");

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

    // to affect the game:
    // return null; // null — the game continues as usual
}

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

Injection point 1

Rust.opj (Oxide)

void DecayEntity.DoImmediateDemolish(BaseEntity.RPCMessage)

Passes: DecayEntity decayEntity, BasePlayer player, object true

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
private void DoImmediateDemolish(RPCMessage msg)
{
	if (msg.player.CanInteract() && msg.player.IsAdmin)
	{
		if (Interface.CallHook("OnStructureDemolish", this, msg.player, true) != null)
		{
			return;
		}
		StabilityEntity stabilityEntity = this as StabilityEntity;
		if (stabilityEntity != null)
		{
			Analytics.Azure.OnBuildingBlockDemolished(msg.player, stabilityEntity);
		}
// …

Injection point 2

Rust.opj (Oxide)

void DecayEntity.DoDemolish(BaseEntity.RPCMessage)

Passes: DecayEntity decayEntity, BasePlayer player, object false

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
private void DoDemolish(RPCMessage msg)
{
	if (msg.player.CanInteract() && CanDemolish(msg.player))
	{
		if (Interface.CallHook("OnStructureDemolish", this, msg.player, false) != null)
		{
			return;
		}
		StabilityEntity stabilityEntity = this as StabilityEntity;
		if (stabilityEntity != null)
		{
			Analytics.Azure.OnBuildingBlockDemolished(msg.player, stabilityEntity);
		}
// …

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.