OnPlayerBoatCollide

OxideCarbonNaval

object OnPlayerBoatCollide(PlayerBoat playerBoat, BaseEntity local0, Collision collision)

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

Parameters

playerBoat: PlayerBoat
local0: BaseEntity
collision: Collision

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 OnPlayerBoatCollide(PlayerBoat playerBoat, BaseEntity local0, Collision collision)
{
    Puts("OnPlayerBoatCollide");

    // 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 PlayerBoat.ProcessCollision(Collision)

Passes: PlayerBoat playerBoat, BaseEntity local0, Collision collision

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

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

private void ProcessCollision(Collision collision)
{
	if (!isClient && collision != null && !(collision.gameObject == null) && !(collision.gameObject == null))
	{
		BaseEntity baseEntity = collision.gameObject.ToBaseEntity();
		if (Interface.CallHook("OnPlayerBoatCollide", this, baseEntity, collision) != null)
		{
			return;
		}
		if (baseEntity != null && !baseEntity.isClient && baseEntity is IDestroyableOnPlayerBoatCollision destroyableOnPlayerBoatCollision && destroyableOnPlayerBoatCollision.ShouldBeDestroyedBy(this))
		{
			baseEntity.Kill(DestroyMode.Gib);
		}
	}
// …

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.