RustTip

OnBookmarksSendControl

OxideCarbonBookmark

Called when bookmarks send control occurs.

object OnBookmarksSendControl(ComputerStation computerStation, BasePlayer player, string local0)
Works — the game method in this build is the one the hook was written for.

Parameters

computerStation
ComputerStation
player
BasePlayer
local0
string

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 OnBookmarksSendControl(ComputerStation computerStation, BasePlayer player, string local0)
{
    Puts("OnBookmarksSendControl");

    // 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 ComputerStation.SendControlBookmarks(BasePlayer)

Passes: ComputerStation computerStation, BasePlayer player, string local0

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

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

public void SendControlBookmarks(BasePlayer player)
{
	if (!(player == null))
	{
		string arg = GenerateControlBookmarkString();
		if (Interface.CallHook("OnBookmarksSendControl", this, player, arg) != null)
		{
			return;
		}
		ClientRPC(RpcTarget.Player("ReceiveBookmarks", player), arg);
	}
}

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.