OnCargoShipEgress

OxideCarbonEntity

Called when a cargo ship egresses.

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

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

Passes: CargoShip cargoShip

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustThisAssembly-CSharp.dll

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

public void StartEgress()
{
	if (!isDoingHarborApproach && !egressing)
	{
		egressing = true;
		if (Interface.CallHook("OnCargoShipEgress", this) != null)
		{
			return;
		}
		CancelInvoke(PlayHorn);
		radiation.SetActive(value: true);
		using (FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate))
		{
			flagsUpdateScope.Set(Flags.Reserved8, b: true);
// …

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.