OnBookmarkDelete

OxideCarbonBookmark

Called when a bookmark is deleted.

object OnBookmarkDelete(ComputerStation computerStation, BasePlayer mountedPlayer, string identifier)

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

Parameters

computerStation: ComputerStation
mountedPlayer: BasePlayer
identifier: 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 OnBookmarkDelete(ComputerStation computerStation, BasePlayer mountedPlayer, string identifier)
{
    Puts("OnBookmarkDelete");

    // 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.RemoveBookmark(string, BasePlayer)

Passes: ComputerStation computerStation, BasePlayer mountedPlayer, string identifier

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

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

private void RemoveBookmark(string identifier, BasePlayer mountedPlayer = null)
{
	if (!IsValidIdentifier(identifier) || !controlBookmarks.Contains(identifier))
	{
		return;
	}
	if (Interface.CallHook("OnBookmarkDelete", this, mountedPlayer, identifier) != null)
	{
		return;
	}
	controlBookmarks.Remove(identifier);
	if (mountedPlayer != null)
	{
		SendControlBookmarks(mountedPlayer);
		BaseEntity baseEntity = currentlyControllingEnt.Get(serverside: true);
// …

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.