Skip to content
ChartForgeX

API Reference

Class

ChartTileMapDefinition

Edit on GitHub
Namespace ChartForgeX.Core
Assembly ChartForgeX
Source ChartTileMapDefinition.cs:46
Modifiers sealed

Describes reusable tile-map geometry.

Inheritance

  • Object
  • ChartTileMapDefinition

Usage

Explore 7 API references to this type

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by 3

Accepted by parameters 4

Constructors

public ChartTileMapDefinition(String id, String name, IEnumerable<ChartTileMapRegion> regions) #
ChartTileMapDefinition.cs:46

Initializes a new instance of the ChartTileMapDefinition class.

Parameters

id System.String requiredposition: 0
The stable map identifier.
name System.String requiredposition: 1
The display name.
regions System.Collections.Generic.IEnumerable<ChartForgeX.Core.ChartTileMapRegion> requiredposition: 2
The tile regions.

Methods

public Boolean TryResolveRegion(String region, out String code) #
ChartTileMapDefinition.cs:80
Returns: Boolean

Resolves a caller-provided region code or alias to the canonical region code.

Parameters

region System.String requiredposition: 0
The code, name, or alias to resolve.
code System.String requiredposition: 1
The canonical region code.

Returns

true when the region can be resolved; otherwise false.

Properties

public String Id { get; } #
ChartTileMapDefinition.cs:18

Gets the stable map identifier.

public String Name { get; } #
ChartTileMapDefinition.cs:23

Gets the display name of the tile map.

public Int32 ColumnCount { get; } #
ChartTileMapDefinition.cs:28

Gets the number of occupied tile columns.

public Int32 RowCount { get; } #
ChartTileMapDefinition.cs:33

Gets the number of occupied tile rows.

public IReadOnlyList<ChartTileMapRegion> Regions { get; } #
ChartTileMapDefinition.cs:38

Gets the drawable regions.