OnFireworkDamage

OxideCarbonFirework

Called when a firework is damaged.

object OnFireworkDamage(BaseFirework baseFirework, HitInfo info)

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

Parameters

baseFirework: BaseFirework
info: HitInfo

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 OnFireworkDamage(BaseFirework baseFirework, HitInfo info)
{
    Puts("OnFireworkDamage");

    // 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 BaseFirework.OnAttacked(HitInfo)

Passes: BaseFirework baseFirework, HitInfo info

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: AllAssembly-CSharp.dll

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

public override void OnAttacked(HitInfo info)
{
	base.OnAttacked(info);
	if (isServer && info.damageTypes.Has(DamageType.Heat))
	{
		if (Interface.CallHook("OnFireworkDamage", this, info) != null)
		{
			return;
		}
		StaggeredTryLightFuse();
	}
}

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.