OnLivestockAnimalFamiliarityAdd

OxideCarbonAnimal

object OnLivestockAnimalFamiliarityAdd(Rust.Ai.Gen2.LivestockAnimal livestockAnimal, ulong userId, float seconds, Rust.Ai.Gen2.LivestockAnimal.FamiliarityReason reason)

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

Parameters

livestockAnimal: Rust.Ai.Gen2.LivestockAnimal
userId: ulong
seconds: float
reason: Rust.Ai.Gen2.LivestockAnimal.FamiliarityReason

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 OnLivestockAnimalFamiliarityAdd(Rust.Ai.Gen2.LivestockAnimal livestockAnimal, ulong userId, float seconds, Rust.Ai.Gen2.LivestockAnimal.FamiliarityReason reason)
{
    Puts("OnLivestockAnimalFamiliarityAdd");

    // 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 Rust.Ai.Gen2.LivestockAnimal.AddFamiliarity(ulong, float, Rust.Ai.Gen2.LivestockAnimal.FamiliarityReason)

Passes: Rust.Ai.Gen2.LivestockAnimal livestockAnimal, ulong userId, float seconds, Rust.Ai.Gen2.LivestockAnimal.FamiliarityReason reason

WorksReturnBehavior: ExitWhenNonNullArgumentBehavior: AllAssembly-CSharp.dll

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

public void AddFamiliarity(ulong userId, float seconds, FamiliarityReason reason = FamiliarityReason.Handled)
{
	if (Interface.CallHook("OnLivestockAnimalFamiliarityAdd", this, userId, seconds, reason) != null)
	{
		return;
	}
	bool isLeadable = IsLeadable;
	CreditFamiliarity(userId, seconds);
	RefreshHusbandryClocks();
	if (!isLeadable && IsLeadable && (reason == FamiliarityReason.Handled || reason == FamiliarityReason.Purchased))
	{
// …

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.