OnLivestockAnimalClaim

OxideAnimal

object OnLivestockAnimalClaim(Rust.Ai.Gen2.LivestockAnimal livestockAnimal, HitchTrough trough)

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

Parameters

livestockAnimal: Rust.Ai.Gen2.LivestockAnimal
trough: HitchTrough

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 OnLivestockAnimalClaim(Rust.Ai.Gen2.LivestockAnimal livestockAnimal, HitchTrough trough)
{
    Puts("OnLivestockAnimalClaim");

    // 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 Rust.Ai.Gen2.LivestockAnimal.ClaimByTrough(HitchTrough)

Passes: Rust.Ai.Gen2.LivestockAnimal livestockAnimal, HitchTrough trough

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

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

public void ClaimByTrough(HitchTrough trough)
{
	if (!(trough == null) && trough.OwnerID != 0L)
	{
		if (Interface.CallHook("OnLivestockAnimalClaim", this, trough) != null)
		{
			return;
		}
		SetOwner(trough.OwnerID, OwnerChangeReason.Trough);
		AdoptHomeOf(trough);
	}
}

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.