OnCargoShipHarborApproach

OxideCarbonEntity

Called when cargo ship harbor approach occurs.

object OnCargoShipHarborApproach(CargoShip cargoShip, CargoNotifier cn)

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

Parameters

cargoShip: CargoShip
cn: CargoNotifier

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 OnCargoShipHarborApproach(CargoShip cargoShip, CargoNotifier cn)
{
    Puts("OnCargoShipHarborApproach");

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

Passes: CargoShip cargoShip, CargoNotifier cn

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: AllAssembly-CSharp.dll

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

private void StartHarborApproach(CargoNotifier cn)
{
	if (Interface.CallHook("OnCargoShipHarborApproach", this, cn) != null)
	{
		return;
	}
	PlayHorn();
	isDoingHarborApproach = true;
	dockCount++;
	shouldLookAhead = false;
	if (proxManager != null)
// …

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.