Class MapSettings

Namespace

WitShells.MapView

public class MapSettings : ScriptableObject

Inheritance

object

MapSettings

Fields

OnDragSettingsChanged

public static Action<bool> OnDragSettingsChanged

Field Value

Action<bool>

showLabels

public bool showLabels

Field Value

bool

useOnlineMap

public bool useOnlineMap

Field Value

bool

Properties

CanDragMarkers

public bool CanDragMarkers { get; }

Property Value

bool

CanSelectMarkers

public bool CanSelectMarkers { get; }

Property Value

bool

EnableGrid

public bool EnableGrid { get; }

Property Value

bool

EnableGridLabels

public bool EnableGridLabels { get; }

Property Value

bool

GridLabelColor

public Color GridLabelColor { get; }

Property Value

Color

GridLabelFontSize

public int GridLabelFontSize { get; }

Property Value

int

GridLabelOffsetIndex

public int GridLabelOffsetIndex { get; }

Property Value

int

GridLineColor

public Color GridLineColor { get; }

Property Value

Color

GridLineThickness

public float GridLineThickness { get; }

Property Value

float

GridSpacing

public float GridSpacing { get; }

Property Value

float

HorizontalGridLabelOffset

public Vector2 HorizontalGridLabelOffset { get; }

Property Value

Vector2

Instance

public static MapSettings Instance { get; }

Property Value

MapSettings

MapFile

public MapFile MapFile { get; }

Property Value

MapFile

PerfectSquareGrid

public bool PerfectSquareGrid { get; }

Property Value

bool

Regions

All saved offline map regions.

public IReadOnlyList<MapFile> Regions { get; }

Property Value

IReadOnlyList<MapFile>

TotalHorizontalGridLines

public int TotalHorizontalGridLines { get; }

Property Value

int

TotalVerticalGridLines

public int TotalVerticalGridLines { get; }

Property Value

int

VerticalGridLabelOffset

public Vector2 VerticalGridLabelOffset { get; }

Property Value

Vector2

ZoomLabelOffset

public bool ZoomLabelOffset { get; }

Property Value

bool

ZoomLabelOffsetMaxIndex

public int ZoomLabelOffsetMaxIndex { get; }

Property Value

int

ZoomLabelOffsetMinIndex

public int ZoomLabelOffsetMinIndex { get; }

Property Value

int

Methods

AddRegion(MapFile)

Adds a region to the catalog. Replaces an existing entry with the same name.

public void AddRegion(MapFile region)

Parameters

region MapFile

HasRegion(string)

Returns true if a region with the given name exists in the catalog.

public bool HasRegion(string name)

Parameters

name string

Returns

bool

RemoveRegion(string)

Removes the region with the given name from the catalog. Does nothing if not found.

public void RemoveRegion(string name)

Parameters

name string

SetCanDragMarkers(bool)

public void SetCanDragMarkers(bool canDrag)

Parameters

canDrag bool

SetCanSelectMarkers(bool)

public void SetCanSelectMarkers(bool canSelect)

Parameters

canSelect bool

SetCurrentMapFile(MapFile)

public void SetCurrentMapFile(MapFile newMapFile)

Parameters

newMapFile MapFile

SetEnableGrid(bool)

public void SetEnableGrid(bool value)

Parameters

value bool

SetEnableGridLabels(bool)

public void SetEnableGridLabels(bool value)

Parameters

value bool

SetGridLabelColor(Color)

public void SetGridLabelColor(Color value)

Parameters

value Color

SetGridLabelFontSize(int)

public void SetGridLabelFontSize(int value)

Parameters

value int

SetGridLabelOffsetIndex(int)

public void SetGridLabelOffsetIndex(int value)

Parameters

value int

SetGridLineColor(Color)

public void SetGridLineColor(Color value)

Parameters

value Color

SetGridLineThickness(float)

public void SetGridLineThickness(float value)

Parameters

value float

SetGridSpacing(float)

public void SetGridSpacing(float value)

Parameters

value float

SetHorizontalGridLabelOffset(Vector2)

public void SetHorizontalGridLabelOffset(Vector2 value)

Parameters

value Vector2

SetPerfectSquareGrid(bool)

public void SetPerfectSquareGrid(bool value)

Parameters

value bool

SetRegions(List<MapFile>)

public void SetRegions(List<MapFile> value)

Parameters

value List<MapFile>

SetShowLabels(bool)

public void SetShowLabels(bool value)

Parameters

value bool

SetTotalHorizontalGridLines(int)

public void SetTotalHorizontalGridLines(int value)

Parameters

value int

SetTotalVerticalGridLines(int)

public void SetTotalVerticalGridLines(int value)

Parameters

value int

SetUseOnlineMap(bool)

public void SetUseOnlineMap(bool value)

Parameters

value bool

SetVerticalGridLabelOffset(Vector2)

public void SetVerticalGridLabelOffset(Vector2 value)

Parameters

value Vector2

SetZoomLabelOffset(bool)

public void SetZoomLabelOffset(bool value)

Parameters

value bool

SetZoomLabelOffsetMaxIndex(int)

public void SetZoomLabelOffsetMaxIndex(int value)

Parameters

value int

SetZoomLabelOffsetMinIndex(int)

public void SetZoomLabelOffsetMinIndex(int value)

Parameters

value int

TryGetRegion(string, out MapFile)

Attempts to find a region by name. Returns false if not found.

public bool TryGetRegion(string name, out MapFile region)

Parameters

name string

region MapFile

Returns

bool