OnSpinWheel

OxideCarbonPlayer

Called when spin wheel occurs.

object OnSpinWheel(BasePlayer player, SpinnerWheel spinnerWheel)

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

Parameters

player: BasePlayer
spinnerWheel: SpinnerWheel

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 OnSpinWheel(BasePlayer player, SpinnerWheel spinnerWheel)
{
    Puts("OnSpinWheel");

    // 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 SpinnerWheel.RPC_Spin(BaseEntity.RPCMessage)

Passes: BasePlayer player, SpinnerWheel spinnerWheel

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

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

[RPC_Server]
[RPC_Server.MaxDistance(3f)]
private void RPC_Spin(RPCMessage rpc)
{
	if (rpc.player.CanInteract() && AllowPlayerSpins() && (AnyoneSpin() || rpc.player.CanBuild()) && !(velocity > 15f))
	{
		if (Interface.CallHook("OnSpinWheel", rpc.player, this) != null)
		{
			return;
		}
		velocity += Random.Range(4f, 7f);
		ToggleChildEntityColliders(state: 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.