OnBookmarkControl

OxideCarbonBookmark

Called when bookmark control occurs.

object OnBookmarkControl(ComputerStation computerStation, BasePlayer local0, string local1, IRemoteControllable local2)

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

Parameters

computerStation: ComputerStation
local0: BasePlayer
local1: string
local2: IRemoteControllable

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 OnBookmarkControl(ComputerStation computerStation, BasePlayer local0, string local1, IRemoteControllable local2)
{
    Puts("OnBookmarkControl");

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

Passes: ComputerStation computerStation, BasePlayer local0, string local1, IRemoteControllable local2

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

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

// …
}
BaseEntity ent = remoteControllable.GetEnt();
if (ent == null)
{
	Debug.LogWarning("RC identifier " + text + " was found but has a null or destroyed entity, this should never happen");
}
else if (remoteControllable.CanControl(player.userID) && !(Vector3.Distance(transform.position, ent.transform.position) >= remoteControllable.MaxRange))
{
	if (Interface.CallHook("OnBookmarkControl", this, player, text, remoteControllable) != null)
	{
		return;
	}
	BaseEntity baseEntity = currentlyControllingEnt.Get(serverside: true);
	if ((bool)baseEntity)
	{
		baseEntity.GetComponent<IRemoteControllable>()?.StopControl(new CameraViewerId(currentPlayerID, 0L));
	}
// …

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.