OnPortalUse

OxideCarbonPlayer

Called when a portal uses.

object OnPortalUse(BasePlayer player, BasePortal basePortal)

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

Parameters

player: BasePlayer
basePortal: BasePortal

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 OnPortalUse(BasePlayer player, BasePortal basePortal)
{
    Puts("OnPortalUse");

    // 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 BasePortal.UsePortal(BasePlayer)

Passes: BasePlayer player, BasePortal basePortal

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: UseArgumentString (a0, this)Assembly-CSharp.dll

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

public virtual void UsePortal(BasePlayer player)
{
	if (Interface.CallHook("OnPortalUse", player, this) != null)
	{
		return;
	}
	LinkPortal();
	if (targetPortal != null)
	{
		player.PauseFlyHackDetection();
		player.PauseSpeedHackDetection();
// …

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.