OnMapMarkersClear

OxideCarbonPlayer

Called when map markers clear occurs.

object OnMapMarkersClear(BasePlayer basePlayer, List<ProtoBuf.MapNote> pointsOfInterest)

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

Parameters

basePlayer: BasePlayer
pointsOfInterest: List<ProtoBuf.MapNote>

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 OnMapMarkersClear(BasePlayer basePlayer, List<ProtoBuf.MapNote> pointsOfInterest)
{
    Puts("OnMapMarkersClear");

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

Passes: BasePlayer basePlayer, List<ProtoBuf.MapNote> pointsOfInterest

WorksReturnBehavior: ExitWhenValidTypeArgumentBehavior: UseArgumentString (this, this.State.pointsOfInterest)Assembly-CSharp.dll

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

[RPC_Server]
[RPC_Server.FromOwner]
[RPC_Server.CallsPerSecond(1uL)]
public void Server_ClearMapMarkers(RPCMessage msg)
{
	if (Interface.CallHook("OnMapMarkersClear", this, this.State.pointsOfInterest) != null)
	{
		return;
	}
	ServerCurrentDeathNote?.Dispose();
	ServerCurrentDeathNote = null;
	if (State.pointsOfInterest != null)
	{
		foreach (MapNote item in State.pointsOfInterest)
// …

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.