OnFireworkDesignChange

OxideCarbonFirework

Called when a firework design is changed.

object OnFireworkDesignChange(PatternFirework patternFirework, ProtoBuf.PatternFirework.Design local0, BasePlayer player)

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

Parameters

patternFirework: PatternFirework
local0: ProtoBuf.PatternFirework.Design
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 OnFireworkDesignChange(PatternFirework patternFirework, ProtoBuf.PatternFirework.Design local0, BasePlayer player)
{
    Puts("OnFireworkDesignChange");

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

Passes: PatternFirework patternFirework, ProtoBuf.PatternFirework.Design local0, BasePlayer player

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

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

// …
[RPC_Server.MaxRepeatedElements(35)]
private void ServerSetFireworkDesign(RPCMessage rpc)
{
	if (!PlayerCanModify(rpc.player))
	{
		return;
	}
	ProtoBuf.PatternFirework.Design design = rpc.read.Proto<ProtoBuf.PatternFirework.Design>();
	if (Interface.CallHook("OnFireworkDesignChange", this, design, rpc.player) != null)
	{
		return;
	}
	if (design?.stars != null)
	{
		while (design.stars.Count > MaxStars)
		{
			int index = design.stars.Count - 1;
// …

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.