OnTrainCarUncouple

OxideCarbonVehicle

Called when train car uncouple occurs.

object OnTrainCarUncouple(TrainCar trainCar, BasePlayer player)

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

Parameters

trainCar: TrainCar
player: BasePlayer

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 OnTrainCarUncouple(TrainCar trainCar, BasePlayer player)
{
    Puts("OnTrainCarUncouple");

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

Passes: TrainCar trainCar, BasePlayer player

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

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

[RPC_Server]
public void RPC_WantsUncouple(RPCMessage msg)
{
	BasePlayer player = msg.player;
	if (!(player == null) && !(Vector3.SqrMagnitude(transform.position - player.transform.position) > 200f))
	{
		if (Interface.CallHook("OnTrainCarUncouple", this, msg.player) != null)
		{
			return;
		}
		bool front = msg.read.Bit();
		coupling.Uncouple(front);
	}
}

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.