User Interaction API

advanced scripting

World Map Globe Edition · Scripting Support (C#)

Class: All members on this page belong to WorldMapGlobe (namespace WPM). Access via WorldMapGlobe.instance.

Pointer & Input

bool mouseIsOver { get; }

True when the mouse cursor is over the globe.

IInputProxy input

Custom input proxy. Assign your own implementation to override default Unity input (useful for custom input systems or new Input System).

bool respectOtherUI { get; set; }

When enabled, prevents globe interaction if the pointer is over a UI element.

LayerMask blockingMask { get; set; }

Layer mask to determine which UI elements can block globe interaction.

bool allowHighlightWhileDragging { get; set; }

Allow entities to highlight during drag operations.

bool rectangleSelectionInProgress { get; }

True during a rectangle selection operation.

Highlight Control

bool enableCountryHighlight { get; set; }

Enable highlighting countries on hover.

bool highlightAllCountryRegions { get; set; }

Highlight all regions of a country (including exclaves).

bool enableProvinceHighlight { get; set; }

Enable highlighting provinces on hover.

bool enableCityHighlight { get; set; }

Enable highlighting cities on hover.

bool enableContinentHighlight { get; set; }

Enable highlighting continents on hover.

bool hexaGridHighlightEnabled { get; set; }

Enable highlighting hex grid cells on hover.

Current State

Country countryHighlighted { get; }

Currently highlighted country.

Province provinceHighlighted { get; }

Currently highlighted province.

City cityHighlighted { get; }

Currently highlighted city.

string continentHighlighted { get; }

Name of the highlighted continent.

Cell lastHighlightedCell { get; }

Last highlighted hex grid cell.

int countryLastClicked { get; }

Index of last clicked country.

int provinceLastClicked { get; }

Index of last clicked province.

int cityLastClicked { get; }

Index of last clicked city.

string continentLastClicked { get; }

Name of last clicked continent.

Sub-Components

WorldMapCalculator calc { get; }

Returns the Calculator component for distance/area computations.

WorldMapTicker ticker { get; }

Returns the Ticker component for scrolling text overlays.

WorldMapDecorator decorator { get; }

Returns the Decorator component for placing objects on countries/provinces.

WorldMapEditor editor { get; }

Returns the Editor component for runtime map editing.

Was this page helpful?