Class DebugMapModeHandler

Namespace

Map.MapModes

Assembly

MapAssembly.dll

Generic handler for debug visualization modes These modes don't need texture updates - they just set shader mode for visualization

public class DebugMapModeHandler : BaseMapModeHandler, IMapModeHandler

Inheritance

object

BaseMapModeHandler

DebugMapModeHandler

Implements

IMapModeHandler

Inherited Members

BaseMapModeHandler.RequiresFrequentUpdates

BaseMapModeHandler.DisableAllMapModeKeywords(Material)

BaseMapModeHandler.EnableMapModeKeyword(Material, string)

BaseMapModeHandler.SetShaderMode(Material, int)

BaseMapModeHandler.LogActivation(string)

BaseMapModeHandler.LogDeactivation(string)

Constructors

DebugMapModeHandler(MapMode, string)

public DebugMapModeHandler(MapMode debugMode, string displayName)

Parameters

debugMode MapMode

displayName string

Properties

Mode

Map mode type this handler manages

public override MapMode Mode { get; }

Property Value

MapMode

Name

Display name for UI

public override string Name { get; }

Property Value

string

ShaderModeID

Shader mode ID for the GPU

public override int ShaderModeID { get; }

Property Value

int

Methods

GetProvinceTooltip(ushort, ProvinceQueries, CountryQueries)

Get tooltip text for a specific province in this map mode

public override string GetProvinceTooltip(ushort provinceId, ProvinceQueries provinceQueries, CountryQueries countryQueries)

Parameters

provinceId ushort

provinceQueries ProvinceQueries

countryQueries CountryQueries

Returns

string

GetUpdateFrequency()

Get update frequency for this map mode's textures

public override UpdateFrequency GetUpdateFrequency()

Returns

UpdateFrequency

OnActivate(Material, MapModeDataTextures)

Called when this map mode becomes active Set up shader properties, enable keywords, etc.

public override void OnActivate(Material mapMaterial, MapModeDataTextures dataTextures)

Parameters

mapMaterial Material

dataTextures MapModeDataTextures

OnDeactivate(Material)

Called when this map mode becomes inactive Clean up, disable keywords, etc.

public override void OnDeactivate(Material mapMaterial)

Parameters

mapMaterial Material

UpdateTextures(MapModeDataTextures, ProvinceQueries, CountryQueries, ProvinceMapping, object)

Update the mode-specific data textures from Core simulation data Only called when data has changed or mode requires frequent updates

public override void UpdateTextures(MapModeDataTextures dataTextures, ProvinceQueries provinceQueries, CountryQueries countryQueries, ProvinceMapping provinceMapping, object gameProvinceSystem = null)

Parameters

dataTextures MapModeDataTextures

provinceQueries ProvinceQueries

countryQueries CountryQueries

provinceMapping ProvinceMapping

gameProvinceSystem object

Optional game-specific province system - engine passes through without knowing type