RustTip

OnStructureRepair

OxideCarbonStructure

Called when a structure is repaired.

object OnStructureRepair(BaseCombatEntity baseCombatEntity, BasePlayer player)
Works — the game method in this build is the one the hook was written for.

Parameters

baseCombatEntity
BaseCombatEntity
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 OnStructureRepair(BaseCombatEntity baseCombatEntity, BasePlayer player)
{
    Puts("OnStructureRepair");

    // 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 BaseCombatEntity.DoRepair(BasePlayer)

Passes: BaseCombatEntity baseCombatEntity, BasePlayer player

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

public virtual void DoRepair(BasePlayer player)
{
	if (!repair.enabled)
	{
		return;
	}
	if (Interface.CallHook("OnStructureRepair", this, player) != null)
	{
		return;
	}
	float num = GetDamageRepairCooldown();
	if (player.IsInCreativeMode && Creative.freeRepair)
	{
		num = 0f;
	}
// …

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.