OnHorseLead

OxideAnimal

object OnHorseLead(RidableHorse ridableHorse, BasePlayer basePlayer)

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

Parameters

ridableHorse: RidableHorse
basePlayer: BasePlayer

Return value

objectReturn a value of the method's result type and the game returns it immediately; null continues as usual.

Example

object — you can affect the game: return a value to change or cancel the action.

private object OnHorseLead(RidableHorse ridableHorse, BasePlayer basePlayer)
{
    Puts("OnHorseLead");

    // change nothing — the game continues as usual
    return null;

    // to affect the game:
    // return null; // null — the game continues as usual
}

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

Injection point

Rust.opj (Oxide)

void RidableHorse.SERVER_Lead(BaseEntity.RPCMessage)

Passes: RidableHorse ridableHorse, BasePlayer basePlayer

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

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

// …
		{
			return;
		}
	}
	else if (!CanStopLead(player))
	{
		return;
	}
	if (Interface.CallHook("OnHorseLead", this, player) != null)
	{
		return;
	}
	SetLeading(flag ? player : 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.