OnQueueCycle

OxideCarbonQueue

Called when queue cycle occurs.

object OnQueueCycle(int availableSlots)

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

Parameters

availableSlots: int

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 OnQueueCycle(int availableSlots)
{
    Puts("OnQueueCycle");

    // 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 ConnectionQueue.Cycle(int)

Passes: int availableSlots

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: JustParamsAssembly-CSharp.dll

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

public void Cycle(int availableSlots)
{
	if (Interface.CallHook("OnQueueCycle", availableSlots) != null)
	{
		return;
	}
	if (Time.realtimeSinceStartup > nextCleanupReservedSlots)
	{
		nextCleanupReservedSlots = Time.realtimeSinceStartup + 1f;
		CleanupExpiredReservedSlots();
	}
// …

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.