OnDeepSeaTeleport

OxideCarbonNaval

object OnDeepSeaTeleport(TriggerDeepSeaPortal triggerDeepSeaPortal, BaseEntity ent)

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

Parameters

triggerDeepSeaPortal: TriggerDeepSeaPortal
ent: BaseEntity

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 OnDeepSeaTeleport(TriggerDeepSeaPortal triggerDeepSeaPortal, BaseEntity ent)
{
    Puts("OnDeepSeaTeleport");

    // 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 TriggerDeepSeaPortal.OnEntityEnter(BaseEntity)

Passes: TriggerDeepSeaPortal triggerDeepSeaPortal, BaseEntity ent

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, l0.ent)Assembly-CSharp.dll

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

// …
	}
}
else
{
	if (!WillTeleport)
	{
		return;
	}
	if (Interface.CallHook("OnDeepSeaTeleport", this, local0.ent) != null)
	{
		return;
	}
	if (Portal.PortalMode == DeepSeaPortal.PortalModeEnum.Entrance)
	{
		Portal.NextFrames(() =>
		{
			PointEntity<DeepSeaManager>.ServerInstance.MoveToDeepSea(ent);
// …

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.