OnBookmarkAdd

OxideCarbonBookmark

Called when a bookmark is added.

object OnBookmarkAdd(ComputerStation computerStation, BasePlayer local0, string local1)

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

Parameters

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

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

Passes: ComputerStation computerStation, BasePlayer local0, string local1

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

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

// …
		}
		if (controlBookmarks.Count >= 128)
		{
			player.ChatMessage("Too many bookmarks, delete some");
			return;
		}
		nextAddTime = Time.realtimeSinceStartup + 1f;
		string identifier = msg.read.String();
		if (Interface.CallHook("OnBookmarkAdd", this, player, identifier) != null)
		{
			return;
		}
		ForceAddBookmark(identifier);
		SendControlBookmarks(player);
	}
}

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.