Class MapFilters

Namespace

FishMMO.Client

Assembly

FishMMO.Client.dll

Which marker categories the player currently wants to see, remembered between sessions.

public static class MapFilters

Inheritance

object

MapFilters

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

State lives in ClientSettings rather than on the panel, because the minimap will want the same switches eventually and because a filter the player has to set again on every login is worse than no filter at all.

The player's own character is never filterable. A map that can hide where you are is a map with a way to break itself, and no player has ever wanted that.

Fields

Categories

Every category, in the order the legend lists them.

public static readonly MapFilterCategory[] Categories

Field Value

MapFilterCategory[]

FilterMaskKey

Configuration key holding the enabled categories as a bit field.

public const string FilterMaskKey = "Map.Filters"

Field Value

string

Methods

Categorize(MapMarkerType)

Which category a marker type belongs to.

public static MapFilterCategory Categorize(MapMarkerType type)

Parameters

type MapMarkerType

The marker type.

Returns

MapFilterCategory

Its category.

IsEnabled(MapFilterCategory)

Whether a category is currently shown.

public static bool IsEnabled(MapFilterCategory category)

Parameters

category MapFilterCategory

The category.

Returns

bool

True when its markers should be drawn.

IsEnabled(MapMarkerType)

Whether a marker type is currently shown.

public static bool IsEnabled(MapMarkerType type)

Parameters

type MapMarkerType

The marker type.

Returns

bool

True when the marker should be drawn.

Label(MapFilterCategory)

The player-facing name of a category.

public static string Label(MapFilterCategory category)

Parameters

category MapFilterCategory

The category.

Returns

string

Its label.

SetEnabled(MapFilterCategory, bool)

Shows or hides a category.

public static void SetEnabled(MapFilterCategory category, bool enabled)

Parameters

category MapFilterCategory

The category.

enabled bool

Whether its markers should be drawn.