OnDebrisSpawn

OxideCarbonEntity

Called when a debris is spawned.

object OnDebrisSpawn(DecayEntity decayEntity, Vector3 localPos, Quaternion rot, bool dropToTerrain)

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

Parameters

decayEntity: DecayEntity
localPos: Vector3
rot: Quaternion
dropToTerrain: bool

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 OnDebrisSpawn(DecayEntity decayEntity, Vector3 localPos, Quaternion rot, bool dropToTerrain)
{
    Puts("OnDebrisSpawn");

    // 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 DecayEntity.SpawnDebris(Vector3, Quaternion, bool)

Passes: DecayEntity decayEntity, Vector3 localPos, Quaternion rot, bool dropToTerrain

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

private void SpawnDebris(Vector3 localPos, Quaternion rot, bool dropToTerrain)
{
	if (Interface.CallHook("OnDebrisSpawn", this, localPos, rot, dropToTerrain) != null)
	{
		return;
	}
	Vector3 vector = transform.TransformPoint(localPos);
	if (dropToTerrain && Physics.Raycast(vector, Vector3.down, out var hitInfo, 6f, 8388608))
	{
		float num = vector.y - hitInfo.point.y;
		vector.y = hitInfo.point.y;
// …

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.