Table of Contents

Namespace DotTiled

Classes

BaseLayer

Base class for all layer types in a map. To check the type of a layer, use C# pattern matching, or some other mechanism to determine the type of the layer at runtime.

BoolProperty

Represents a boolean property.

Chunk

Represents part of a tile layer of a map that is infinite.

ClassProperty

Represents a class property.

Color

Represents a Tiled color.

ColorProperty

Represents a color property.

CustomClassDefinition

Represents a custom class definition in Tiled. Refer to the documentation of custom types to understand how they work.

CustomEnumDefinition

Represents a custom enum definition in Tiled. Refer to the documentation of custom types to understand how they work.

Data

Represents the data of a tile layer.

EllipseObject

An ellipse object in a map. The existing X, Y, Width, and Height properties are used to determine the size of the ellipse.

EnumProperty

Represents an enum property.

FileProperty

Represents a file property.

FloatProperty

Represents a float property.

Frame

A single frame of an animated tile.

Grid

Used to specify how tile overlays for terrain and collision information are rendered in isometric maps.

Group

Represents a group of layers, to form a hierarchy.

HasPropertiesBase

Interface for objects that have properties attached to them.

Image

Represents an image that is used by a tileset.

ImageLayer

Represents an image layer in a map.

IntProperty

Represents an integer property.

Map

Represents a Tiled map.

Object

Base class for objects in object layers.

ObjectLayer

Represents an object layer in a map. In Tiled documentation, it is often called an "object group".

ObjectProperty

Represents an object property.

Optional<T>

Represents a value that may or may not be present.

PointObject

A point object in a map. The existing X and Y properties are used to determine the position of the point.

PolygonObject

A polygon object in a map. The existing X and Y properties are used as the origin of the polygon.

PolylineObject

A polyline object in a map. The existing X and Y properties are used as the origin of the polyline.

RectangleObject

A rectangle object in a map. The existing X, Y, Width, and Height properties are used to determine the size of the rectangle.

StringProperty

Represents a string property.

Template

Represents a Tiled template. A template is a reusable object that can be placed in an DotTiled inside the Tiled editor.

TextObject

A text object in a map.

Tile

Represents a single tile in a tileset, when using a collection of images to represent the tileset. Tiled documentation for Tileset tiles

TileLayer

Represents a tile layer in a map.

TileObject

A tile object in a map.

TileOffset

Is used to specify an offset in pixels in tilesets, to be applied when drawing a tile from the related tileset.

Tileset

A tileset is a collection of tiles that can be used in a tile layer, or by tile objects.

Transformations

Represents which transformations can be applied to a tile in a tileset.

WangColor

Represents a Wang color in a Wang set.

WangTile

Represents a Wang tile in a Wang set.

Wangset

Defines a list of colors and any number of Wang tiles using these colors.

Interfaces

ICustomTypeDefinition

Base class for custom type definitions.

IHasProperties

Interface for objects that have properties attached to them.

IProperty

Interface for properties that can be attached to objects, tiles, tilesets, maps etc.

IProperty<T>

Interface for properties that can be attached to objects, tiles, tilesets, maps etc.

Enums

CustomClassUseAs

Represents the types of objects that can use a custom class. Uses the FlagsAttribute, for which there is plenty of documentation.

CustomEnumStorageType

Represents the storage type of a custom enum.

DataCompression

Specifies the compression algorithm used to compress the tile layer data.

DataEncoding

Specifies the encoding used to encode the tile layer data.

DrawOrder

Represents the order in which objects can be drawn.

FillMode

Determines how a tile is rendered in a tile set.

FlippingFlags

The flipping flags for a tile. These can be used to check how a tile is flipped or rotated. Uses the FlagsAttribute, for which there is plenty of documentation.

GridOrientation

Orientation of the grid for the tiles in this tileset.

ImageFormat

The format of an image.

MapOrientation

Map orientation enumeration. The map orientation determines the alignment of the tiles in the map.

ObjectAlignment

The alignment of tile objects.

PropertyType

Represents the type of a property.

RenderOrder

Render order enumeration. The order in which tiles on tile layers are rendered.

StaggerAxis

Stagger axis enumeration. For staggered and hexagonal maps, determines which axis (X or Y) is staggered.

StaggerIndex

Stagger index enumeration. For staggered and hexagonal maps, determines whether the "even" or "odd" indexes along the staggered axis are shifted.

TextHorizontalAlignment

The horizontal alignment of text.

TextVerticalAlignment

The vertical alignment of text.

TileRenderSize

The size to use when rendering tiles from a tileset on a tile layer.