Skip to main content
Version: 0.2.0

Interface IMarkerApi

Namespace: OblivionMp.Sdk.Api
Assembly: OblivionMp.Sdk.dll

Creates and manages local markers over player characters.

public interface IMarkerApi

Methods​

CreateMarker(ReadyMainCharacter, string, MarkerColor)​

Creates a marker over target showing text in color. Returns None if the target has no spawned pawn yet.

MarkerHandle CreateMarker(ReadyMainCharacter target, string text, MarkerColor color)

Parameters​

target ReadyMainCharacter

text string

color MarkerColor

Returns​

MarkerHandle

DestroyMarker(MarkerHandle)​

Destroys a marker. No-op for None or an already-destroyed handle.

void DestroyMarker(MarkerHandle handle)

Parameters​

handle MarkerHandle

SetMarkerOpacity(MarkerHandle, float)​

Sets a marker's opacity, from 0 (fully transparent) to 1 (fully opaque). No-op for None.

void SetMarkerOpacity(MarkerHandle handle, float opacity)

Parameters​

handle MarkerHandle

opacity float

SetMarkerText(MarkerHandle, string, MarkerColor)​

Updates the text and color of an existing marker. No-op for None.

void SetMarkerText(MarkerHandle handle, string text, MarkerColor color)

Parameters​

handle MarkerHandle

text string

color MarkerColor

SetMarkerVisible(MarkerHandle, bool)​

Shows or hides a marker without destroying it. No-op for None.

void SetMarkerVisible(MarkerHandle handle, bool visible)

Parameters​

handle MarkerHandle

visible bool

  • Methods
    • CreateMarker(ReadyMainCharacter, string, MarkerColor)
    • DestroyMarker(MarkerHandle)
    • SetMarkerOpacity(MarkerHandle, float)
    • SetMarkerText(MarkerHandle, string, MarkerColor)
    • SetMarkerVisible(MarkerHandle, bool)