OnRidableAnimalClaim

OxideAnimal

object OnRidableAnimalClaim(RidableHorse ridableHorse, BasePlayer basePlayer, Item item)

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

Parameters

ridableHorse: RidableHorse
basePlayer: BasePlayer
item: Item

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 OnRidableAnimalClaim(RidableHorse ridableHorse, BasePlayer basePlayer, Item item)
{
    Puts("OnRidableAnimalClaim");

    // 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_Claim(BaseEntity.RPCMessage)

Passes: RidableHorse ridableHorse, BasePlayer basePlayer, Item item

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

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

// …
{
	BasePlayer player = msg.player;
	if (player == null || !IsForSale)
	{
		return;
	}
	int tokenItemID = msg.read.Int32();
	Item purchaseToken = GetPurchaseToken(player, tokenItemID);
	if (Interface.CallHook("OnRidableAnimalClaim", this, player, purchaseToken) != null)
	{
		return;
	}
	if (purchaseToken != null && ItemIsSaddle(purchaseToken))
	{
		using (FlagsUpdateScope flagsUpdateScope = StartSetFlags(FlagsUpdateMode.SendNetworkUpdate))
		{
			flagsUpdateScope.Set(Flags.Reserved2, b: false);
// …

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.