OnBookmarkInput

OxideCarbonBookmark

Called when bookmark input occurs.

object OnBookmarkInput(ComputerStation computerStation, BasePlayer player, InputState inputState)

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

Parameters

computerStation: ComputerStation
player: BasePlayer
inputState: InputState

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 OnBookmarkInput(ComputerStation computerStation, BasePlayer player, InputState inputState)
{
    Puts("OnBookmarkInput");

    // 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.PlayerServerInput(InputState, BasePlayer)

Passes: ComputerStation computerStation, BasePlayer player, InputState inputState

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

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

// …
		IOEntity iOEntity = spawnedIo.Get(isServer);
		if ((iOEntity != null) & !iOEntity.IsPowered())
		{
			DismountAllPlayers();
		}
	}
	if (HasFlag(Flags.Reserved2) && currentlyControllingEnt.IsValid(serverside: true))
	{
		if (Interface.CallHook("OnBookmarkInput", this, player, inputState) != null)
		{
			return;
		}
		currentlyControllingEnt.Get(serverside: true).GetComponent<IRemoteControllable>().UserInput(inputState, new CameraViewerId(player.userID, 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.