OnBookmarkControlEnd

OxideCarbonBookmark

Called when a bookmark control ends.

object OnBookmarkControlEnd(ComputerStation computerStation, BasePlayer ply, BaseEntity local0)

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

Parameters

computerStation: ComputerStation
ply: BasePlayer
local0: BaseEntity

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 OnBookmarkControlEnd(ComputerStation computerStation, BasePlayer ply, BaseEntity local0)
{
    Puts("OnBookmarkControlEnd");

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

Passes: ComputerStation computerStation, BasePlayer ply, BaseEntity local0

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

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

public void StopControl(BasePlayer ply)
{
	BaseEntity baseEntity = currentlyControllingEnt.Get(serverside: true);
	if ((bool)baseEntity)
	{
		if (Interface.CallHook("OnBookmarkControlEnd", this, ply, baseEntity) != null)
		{
			return;
		}
		baseEntity.GetComponent<IRemoteControllable>().StopControl(new CameraViewerId(currentPlayerID, 0L));
	}
	if ((bool)ply)
	{
		ply.net.SwitchSecondaryGroup(null);
// …

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.