OnCargoShipHarborLeave

OxideCarbonEntity

Called when a cargo ship harbor leaves.

void OnCargoShipHarborLeave(CargoShip cargoShip)

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

Parameters

cargoShip: CargoShip

Return value

voidThe return value is ignored — the hook only notifies.

Example

private void OnCargoShipHarborLeave(CargoShip cargoShip)
{
    Puts("OnCargoShipHarborLeave");
}

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

Injection point

Rust.opj (Oxide)

void CargoShip.LeaveHarbor()

Passes: CargoShip cargoShip

WorksReturnBehavior: ContinueArgumentBehavior: JustThisAssembly-CSharp.dll

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

// …
	}
	PlayHorn();
	using (FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate))
	{
		flagsUpdateScope.Set(Flags.Reserved1, b: false);
		flagsUpdateScope.Set(Flags.Reserved2, b: true);
	}
	currentHarborApproachNode++;
Interface.CallHook("OnCargoShipHarborLeave", this);
}

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.