OnFireBallSpread

OxideCarbonWeapon

Called when fire ball spread occurs.

void OnFireBallSpread(FireBall fireBall, BaseEntity local1)

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

Parameters

fireBall: FireBall
local1: BaseEntity

Return value

voidThe return value is ignored — the hook only notifies.

Example

private void OnFireBallSpread(FireBall fireBall, BaseEntity local1)
{
    Puts("OnFireBallSpread");
}

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

Injection point

Rust.opj (Oxide)

void FireBall.TryToSpread()

Passes: FireBall fireBall, BaseEntity local1

WorksReturnBehavior: ContinueArgumentBehavior: UseArgumentString (this, l1)Assembly-CSharp.dll

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

// …
	{
		BaseEntity baseEntity = GameManager.server.CreateEntity(spreadSubEntity.resourcePath);
		if ((bool)baseEntity)
		{
			baseEntity.transform.position = transform.position + Vector3.up * 0.25f;
			baseEntity.Spawn();
			Vector3 modifiedAimConeDirection = AimConeUtil.GetModifiedAimConeDirection(45f, Vector3.up);
			baseEntity.creatorEntity = ((creatorEntity == null) ? baseEntity : creatorEntity);
			Interface.CallHook("OnFireBallSpread", this, baseEntity);
			baseEntity.SetVelocity(modifiedAimConeDirection * Random.Range(5f, 8f));
			baseEntity.SendMessage("SetGeneration", generation + 1f);
		}
	}
}

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.