OnCargoShipSpawnCrate

OxideCarbonEntity

Called when cargo ship spawn crate occurs.

Use this to scale timing based on context, player state, or location.

object OnCargoShipSpawnCrate(CargoShip cargoShip)

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

Parameters

cargoShip: CargoShip

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 OnCargoShipSpawnCrate(CargoShip cargoShip)
{
    Puts("OnCargoShipSpawnCrate");

    // 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 CargoShip.RespawnLoot()

Passes: CargoShip cargoShip

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void RespawnLoot()
{
	if (Interface.CallHook("OnCargoShipSpawnCrate", this) != null)
	{
		return;
	}
	InvokeRepeating(PlayHorn, 0f, 8f);
	SpawnCrate(lockedCratePrefab.resourcePath);
	SpawnCrate(eliteCratePrefab.resourcePath);
	for (int i = 0; i < 4; i++)
	{
// …

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.