Class MapRendererRegistry

Namespace

Map.Rendering

Assembly

MapAssembly.dll

ENGINE: Central registry for pluggable map rendering implementations.

ENGINE provides default renderers (DistanceField, PixelPerfect, MeshGeometry). GAME can register custom implementations during initialization.

Usage:

1. ENGINE registers defaults automatically on initialization
2. GAME registers custom renderers before map initialization: MapRendererRegistry.Instance.RegisterBorderRenderer(new MyCustomBorderRenderer());
3. VisualStyleConfiguration references renderers by string ID

Pattern follows IMapModeHandler registration approach.

public class MapRendererRegistry : MonoBehaviour

Inheritance

object

Object

Component

Behaviour

MonoBehaviour

MapRendererRegistry

Properties

Instance

public static MapRendererRegistry Instance { get; }

Property Value

MapRendererRegistry

IsInitialized

public bool IsInitialized { get; }

Property Value

bool

Methods

GetAvailableBorderRenderers()

Get all available border renderer IDs.

public IEnumerable<string> GetAvailableBorderRenderers()

Returns

IEnumerable<string>

GetAvailableFogOfWarRenderers()

Get all available fog of war renderer IDs.

public IEnumerable<string> GetAvailableFogOfWarRenderers()

Returns

IEnumerable<string>

GetAvailableHighlightRenderers()

Get all available highlight renderer IDs.

public IEnumerable<string> GetAvailableHighlightRenderers()

Returns

IEnumerable<string>

GetAvailableMapModeColorizers()

Get all available map mode colorizer IDs.

public IEnumerable<string> GetAvailableMapModeColorizers()

Returns

IEnumerable<string>

GetAvailableShaderCompositors()

Get all available shader compositor IDs.

public IEnumerable<string> GetAvailableShaderCompositors()

Returns

IEnumerable<string>

GetAvailableTerrainRenderers()

Get all available terrain renderer IDs.

public IEnumerable<string> GetAvailableTerrainRenderers()

Returns

IEnumerable<string>

GetBorderRenderer(string)

Get a border renderer by ID. Returns null if not found.

public IBorderRenderer GetBorderRenderer(string rendererId)

Parameters

rendererId string

Returns

IBorderRenderer

GetDefaultBorderRenderer()

Get the default border renderer.

public IBorderRenderer GetDefaultBorderRenderer()

Returns

IBorderRenderer

GetDefaultFogOfWarRenderer()

Get the default fog of war renderer.

public IFogOfWarRenderer GetDefaultFogOfWarRenderer()

Returns

IFogOfWarRenderer

GetDefaultHighlightRenderer()

Get the default highlight renderer.

public IHighlightRenderer GetDefaultHighlightRenderer()

Returns

IHighlightRenderer

GetDefaultMapModeColorizer()

Get the default map mode colorizer.

public IMapModeColorizer GetDefaultMapModeColorizer()

Returns

IMapModeColorizer

GetDefaultShaderCompositor()

Get the default shader compositor.

public IShaderCompositor GetDefaultShaderCompositor()

Returns

IShaderCompositor

GetDefaultTerrainRenderer()

Get the default terrain renderer.

public ITerrainRenderer GetDefaultTerrainRenderer()

Returns

ITerrainRenderer

GetFogOfWarRenderer(string)

Get a fog of war renderer by ID. Returns null if not found.

public IFogOfWarRenderer GetFogOfWarRenderer(string rendererId)

Parameters

rendererId string

Returns

IFogOfWarRenderer

GetHighlightRenderer(string)

Get a highlight renderer by ID. Returns null if not found.

public IHighlightRenderer GetHighlightRenderer(string rendererId)

Parameters

rendererId string

Returns

IHighlightRenderer

GetMapModeColorizer(string)

Get a map mode colorizer by ID. Returns null if not found.

public IMapModeColorizer GetMapModeColorizer(string colorizerId)

Parameters

colorizerId string

Returns

IMapModeColorizer

GetShaderCompositor(string)

Get a shader compositor by ID. Returns null if not found.

public IShaderCompositor GetShaderCompositor(string compositorId)

Parameters

compositorId string

Returns

IShaderCompositor

GetTerrainRenderer(string)

Get a terrain renderer by ID. Returns null if not found.

public ITerrainRenderer GetTerrainRenderer(string rendererId)

Parameters

rendererId string

Returns

ITerrainRenderer

HasBorderRenderer(string)

Check if a border renderer is registered.

public bool HasBorderRenderer(string rendererId)

Parameters

rendererId string

Returns

bool

HasFogOfWarRenderer(string)

Check if a fog of war renderer is registered.

public bool HasFogOfWarRenderer(string rendererId)

Parameters

rendererId string

Returns

bool

HasHighlightRenderer(string)

Check if a highlight renderer is registered.

public bool HasHighlightRenderer(string rendererId)

Parameters

rendererId string

Returns

bool

HasMapModeColorizer(string)

Check if a map mode colorizer is registered.

public bool HasMapModeColorizer(string colorizerId)

Parameters

colorizerId string

Returns

bool

HasShaderCompositor(string)

Check if a shader compositor is registered.

public bool HasShaderCompositor(string compositorId)

Parameters

compositorId string

Returns

bool

HasTerrainRenderer(string)

Check if a terrain renderer is registered.

public bool HasTerrainRenderer(string rendererId)

Parameters

rendererId string

Returns

bool

Initialize()

Initialize the registry. Called by MapInitializer after ENGINE default renderers are created.

public void Initialize()

MapBorderModeToRendererId(BorderRenderingMode)

Map legacy BorderRenderingMode enum to renderer ID. Provides backwards compatibility with existing configurations.

public static string MapBorderModeToRendererId(BorderRenderingMode mode)

Parameters

mode BorderRenderingMode

Returns

string

RegisterBorderRenderer(IBorderRenderer)

Register a border renderer implementation. ENGINE registers defaults; GAME can register customs.

public void RegisterBorderRenderer(IBorderRenderer renderer)

Parameters

renderer IBorderRenderer

RegisterFogOfWarRenderer(IFogOfWarRenderer)

Register a fog of war renderer implementation. ENGINE registers defaults; GAME can register customs.

public void RegisterFogOfWarRenderer(IFogOfWarRenderer renderer)

Parameters

renderer IFogOfWarRenderer

RegisterHighlightRenderer(IHighlightRenderer)

Register a highlight renderer implementation. ENGINE registers defaults; GAME can register customs.

public void RegisterHighlightRenderer(IHighlightRenderer renderer)

Parameters

renderer IHighlightRenderer

RegisterMapModeColorizer(IMapModeColorizer)

Register a map mode colorizer implementation. ENGINE registers defaults; GAME can register customs.

public void RegisterMapModeColorizer(IMapModeColorizer colorizer)

Parameters

colorizer IMapModeColorizer

RegisterShaderCompositor(IShaderCompositor)

Register a shader compositor implementation. ENGINE registers defaults; GAME can register customs.

public void RegisterShaderCompositor(IShaderCompositor compositor)

Parameters

compositor IShaderCompositor

RegisterTerrainRenderer(ITerrainRenderer)

Register a terrain renderer implementation. ENGINE registers defaults; GAME can register customs.

public void RegisterTerrainRenderer(ITerrainRenderer renderer)

Parameters

renderer ITerrainRenderer

SetDefaultBorderRenderer(string)

Set which renderer ID is the default.

public void SetDefaultBorderRenderer(string rendererId)

Parameters

rendererId string

SetDefaultFogOfWarRenderer(string)

Set which fog of war renderer ID is the default.

public void SetDefaultFogOfWarRenderer(string rendererId)

Parameters

rendererId string

SetDefaultHighlightRenderer(string)

Set which highlight renderer ID is the default.

public void SetDefaultHighlightRenderer(string rendererId)

Parameters

rendererId string

SetDefaultMapModeColorizer(string)

Set which colorizer ID is the default.

public void SetDefaultMapModeColorizer(string colorizerId)

Parameters

colorizerId string

SetDefaultShaderCompositor(string)

Set which compositor ID is the default.

public void SetDefaultShaderCompositor(string compositorId)

Parameters

compositorId string

SetDefaultTerrainRenderer(string)

Set which terrain renderer ID is the default.

public void SetDefaultTerrainRenderer(string rendererId)

Parameters

rendererId string

UnregisterBorderRenderer(string)

Unregister a border renderer.

public bool UnregisterBorderRenderer(string rendererId)

Parameters

rendererId string

Returns

bool

UnregisterFogOfWarRenderer(string)

Unregister a fog of war renderer.

public bool UnregisterFogOfWarRenderer(string rendererId)

Parameters

rendererId string

Returns

bool

UnregisterHighlightRenderer(string)

Unregister a highlight renderer.

public bool UnregisterHighlightRenderer(string rendererId)

Parameters

rendererId string

Returns

bool

UnregisterMapModeColorizer(string)

Unregister a map mode colorizer.

public bool UnregisterMapModeColorizer(string colorizerId)

Parameters

colorizerId string

Returns

bool

UnregisterShaderCompositor(string)

Unregister a shader compositor.

public bool UnregisterShaderCompositor(string compositorId)

Parameters

compositorId string

Returns

bool

UnregisterTerrainRenderer(string)

Unregister a terrain renderer.

public bool UnregisterTerrainRenderer(string rendererId)

Parameters

rendererId string

Returns

bool