OnHorseHitch

OxideCarbonAnimal

Called when horse hitch occurs.

object OnHorseHitch(HitchTrough.IHitchable hitchable, HitchTrough.HitchSpot spot)

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

Parameters

hitchable: HitchTrough.IHitchable
spot: HitchTrough.HitchSpot

Return value

objectThe returned value replaces the game result; null lets the game decide.

Example

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

private object OnHorseHitch(HitchTrough.IHitchable hitchable, HitchTrough.HitchSpot spot)
{
    Puts("OnHorseHitch");

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

    // to affect the game:
    // return false; // your value instead of the game result
}

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

Injection point

Rust.opj (Oxide)

bool HitchTrough.AttemptToHitch(HitchTrough.IHitchable, HitchTrough.HitchSpot)

Passes: HitchTrough.IHitchable hitchable, HitchTrough.HitchSpot spot

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustParamsAssembly-CSharp.dll

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

// …
	BaseEntity baseEntity = hitchable as BaseEntity;
	if (baseEntity != null)
	{
		spot = GetClosestSpot(baseEntity.transform.position);
	}
}
if (spot != null)
{
	object returnvar = Interface.CallHook("OnHorseHitch", hitchable, spot);
	if (returnvar is bool)
	{
		return (bool)returnvar;
	}
	spot.SetOccupiedBy(hitchable);
	hitchable.SetHitch(this, spot);
	return true;
}
// …

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.