CanTrainCarCouple

OxideCarbonVehicle

Called to determine whether to train car couple.

Return true to allow the action and false to block it.

object CanTrainCarCouple(TrainCar owner, TrainCar owner1)

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

Parameters

owner: TrainCar
owner1: TrainCar

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 CanTrainCarCouple(TrainCar owner, TrainCar owner1)
{
    Puts("CanTrainCarCouple");

    // 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 TrainCoupling.TryCouple(TrainCoupling, bool)

Passes: TrainCar owner, TrainCar owner1

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

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

// …
if (CoupledTo == theirCoupling)
{
	return true;
}
if (IsCoupled)
{
	return false;
}
object returnvar = Interface.CallHook("CanTrainCarCouple", this.owner, theirCoupling.owner);
if (returnvar is bool)
{
	return (bool)returnvar;
}
if (reflect && !theirCoupling.TryCouple(this, reflect: false))
{
	return 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.