Firework (6)

All currently available hooks that are found in Carbon. Most hooks would be ones compatible with Oxide, although there are Carbon-only ones as well.

CanDesignFirework

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PatternFirework.PlayerCanModify of Assembly-CSharp.dll.

Example

object CanDesignFirework(BasePlayer player, PatternFirework self)
{
    Puts("CanDesignFirework was called!");
    return (bool) null;
}

OnFireworkDamage

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseFirework.OnAttacked of Assembly-CSharp.dll.

Example

object OnFireworkDamage(BaseFirework self)
{
    Puts("OnFireworkDamage was called!");
    return (object) null;
}

OnFireworkDesignChange

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PatternFirework.ServerSetFireworkDesign of Assembly-CSharp.dll.

Example

object OnFireworkDesignChange(PatternFirework self, ProtoBuf.PatternFirework.Design local0, BasePlayer player)
{
    Puts("OnFireworkDesignChange was called!");
    return (object) null;
}

OnFireworkDesignChanged

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches PatternFirework.ServerSetFireworkDesign of Assembly-CSharp.dll.

Example

void OnFireworkDesignChanged(PatternFirework self, ProtoBuf.PatternFirework.Design local0, BasePlayer player)
{
    Puts("OnFireworkDesignChanged was called!");
}

This hook requires OnFireworkDesignChange, which loads alongside OnFireworkDesignChanged.

OnFireworkExhausted

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseFirework.OnExhausted of Assembly-CSharp.dll.

Example

void OnFireworkExhausted(BaseFirework self)
{
    Puts("OnFireworkExhausted was called!");
}

OnFireworkStarted

• Returning a non-null value cancels default behavior.

• This hook is compatible within Carbon and Oxide.

• Patches BaseFirework.Begin of Assembly-CSharp.dll.

Example

void OnFireworkStarted(BaseFirework self)
{
    Puts("OnFireworkStarted was called!");
}