### IHasProperties.TryGetProperty(string name, out T property) Method Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.IHasProperties Attempts to get a property by name and type, returning a boolean indicating success and the property via an `out` parameter if found. ```APIDOC Method: TryGetProperty(string name, out T property) Description: Tries to get a property of the specified type with the specified name. Signature: bool TryGetProperty(string name, out T property) where T : IProperty Parameters: name (string): The name of the property to get. property (T): The property with the specified name, if found. Returns: bool: True if a property with the specified name was found; otherwise, false. Type Parameters: T: The type of the property to get. ``` -------------------------------- ### C# Property: Transformations Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Tileset Describes optional transformations that can be applied to tiles within the tileset. These transformations can be used, for example, to extend a Wang set by modifying existing tiles. ```C# public Optional Transformations { get; set; } ``` ```APIDOC Transformations: Optional Used to describe which transformations can be applied to the tiles (e.g. to extend a Wang set by transforming existing tiles). ``` -------------------------------- ### C# Property: CustomEnumDefinition.ID Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.CustomEnumDefinition Gets or sets the unique identifier for the custom type. ```C# public uint ID { get; set; } ``` -------------------------------- ### API Documentation for DotTiled.IProperty Interface Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.IProperty-1 Comprehensive API documentation for the IProperty interface, including its namespace, assembly, description, type parameters, inherited members, and the 'Value' property. ```APIDOC IProperty Interface: Namespace: DotTiled Assembly: DotTiled.dll Description: Interface for properties that can be attached to objects, tiles, tilesets, maps etc. Type Parameters: T: The type of the property value. Inherited Members: - IProperty.Name - IProperty.Type - IProperty.Clone() Properties: Value: Description: The value of the property. Type: T Accessors: get, set ``` -------------------------------- ### API Documentation for DotTiled.IProperty Interface Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.IProperty Comprehensive API documentation for the `IProperty` interface, detailing its namespace, assembly, purpose, properties (Name, Type), and the `Clone()` method, including their types, descriptions, and return values. ```APIDOC Interface: IProperty Namespace: DotTiled Assembly: DotTiled.dll Description: Interface for properties that can be attached to objects, tiles, tilesets, maps etc. Properties: Name: Description: The name of the property. Signature: string Name { get; set; } Property Value: string Type: Description: The type of the property. Signature: PropertyType Type { get; } Property Value: PropertyType Methods: Clone(): Description: Clones the property, only used for copying properties when performing overriding with templates. Signature: IProperty Clone() Returns: IProperty: An identical, but non-reference-equal, instance of the same property. ``` -------------------------------- ### C# Property: CustomEnumDefinition.Name Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.CustomEnumDefinition Gets or sets the name of the custom type. This property is required. ```C# public required string Name { get; set; } ``` -------------------------------- ### API Documentation for DotTiled.HasPropertiesBase Class Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.HasPropertiesBase Detailed API reference for the `HasPropertiesBase` class, including its structure, inheritance, implemented interfaces, derived types, and a comprehensive list of its methods with their signatures, parameters, return types, and exceptions. ```APIDOC Class: HasPropertiesBase Namespace: DotTiled Assembly: DotTiled.dll Description: Interface for objects that have properties attached to them. Signature: public abstract class HasPropertiesBase : IHasProperties Inheritance: - object - HasPropertiesBase Implements: - IHasProperties Derived By: - BaseLayer - ClassProperty - CustomClassDefinition - Map - Object - Tile - Tileset - WangColor - Wangset Inherited Members (from object): - Equals(object) - Equals(object, object) - GetHashCode() - GetType() - MemberwiseClone() - ReferenceEquals(object, object) - ToString() Methods: GetProperties(): Description: The properties attached to the object. Signature: public abstract IList GetProperties() Returns: IList GetProperty(string name): Description: Gets a property of the specified type with the specified name. Signature: public T GetProperty(string name) where T : IProperty Parameters: name (string): The name of the property to get. Returns: T (The property with the specified name.) Type Parameters: T: The type of the property to get. Exceptions: - KeyNotFoundException: Thrown when a property with the specified name is not found. - InvalidCastException: Thrown when a property with the specified name is not of the specified type. MapPropertiesTo(): Description: Maps all properties in this object to a new instance of the specified type using reflection. Signature: public T MapPropertiesTo() where T : new() Returns: T Type Parameters: T MapPropertiesTo(Func initializer): Description: Maps all properties in this object to a new instance of the specified type using reflection. Signature: public T MapPropertiesTo(Func initializer) Parameters: initializer (Func) Returns: T Type Parameters: T TryGetProperty(string name, out T property): Description: Tries to get a property of the specified type with the specified name. Signature: public bool TryGetProperty(string name, out T property) where T : IProperty Parameters: name (string): The name of the property to get. property (T): The property with the specified name, if found. Returns: bool (True if a property with the specified name was found; otherwise, false.) Type Parameters: T: The type of the property to get. ``` -------------------------------- ### C# Property: CustomEnumDefinition.Values Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.CustomEnumDefinition Gets or sets the list of string values defined for the custom enum. ```C# public List Values { get; set; } ``` -------------------------------- ### C# Property: CustomEnumDefinition.StorageType Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.CustomEnumDefinition Gets or sets the storage type for the custom enum, defining how its values are stored. ```C# public CustomEnumStorageType StorageType { get; set; } ``` -------------------------------- ### DotTiled.Tileset Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Tileset Comprehensive API documentation for the `DotTiled.Tileset` class, detailing its namespace, assembly, inheritance hierarchy, implemented interfaces, inherited members, and all public properties with their descriptions and types. ```APIDOC Class: Tileset Namespace: DotTiled Assembly: DotTiled.dll Description: A tileset is a collection of tiles that can be used in a tile layer, or by tile objects. Inheritance: - object - HasPropertiesBase - Tileset Implements: - IHasProperties Inherited Members: - HasPropertiesBase.GetProperty(string) - HasPropertiesBase.TryGetProperty(string, out T) - HasPropertiesBase.MapPropertiesTo() - HasPropertiesBase.MapPropertiesTo(Func) - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() Properties: - Name: Class Description: The class of this tileset. Type: string Code: public string Class { get; set; } - Name: Columns Description: The number of tile columns in the tileset. Type: uint Code: public required uint Columns { get; set; } - Name: FillMode Description: The fill mode to use when rendering tiles from this tileset. Type: FillMode Code: public FillMode FillMode { get; set; } - Name: FirstGID Description: The first global tile ID of this tileset (this global ID maps to the first tile in this tileset). Type: Optional Code: public Optional FirstGID { get; set; } - Name: Grid Description: Ths is only used in case of isometric orientation, and determines how tile overlays for terrain and collision information are rendered. Type: Optional Code: public Optional Grid { get; set; } - Name: Image Description: If the tileset is based on a single image, which is cut into tiles based on the given attributes of the tileset, then this is that image. Type: Optional Code: public Optional Image { get; set; } - Name: Margin Description: The margin around the tiles in this tileset (applies to the tileset image). Irrelevant for image collection tilesets. Type: uint Code: public uint Margin { get; set; } - Name: Name Description: The name of this tileset. Type: string Code: public required string Name { get; set; } - Name: ObjectAlignment Description: Controls the aligntment for tile objects. Type: ObjectAlignment Code: public ObjectAlignment ObjectAlignment { get; set; } - Name: Properties Description: Tileset properties. Type: List Code: public List Properties { get; set; } - Name: RenderSize Description: The size to use when rendering tiles from thie tileset on a tile layer. When set to Grid, the tile is drawn at the tile grid size of the map. Type: TileRenderSize Code: public TileRenderSize RenderSize { get; set; } - Name: Source Description: If this tileset is stored in an external TSX (Tile Set XML) file, this attribute refers to that file. Type: Optional Code: public Optional Source { get; set; } - Name: Spacing Description: The spacing in pixels between the tiles in this tileset (applies to the tileset image). Irrelevant for image collection tilesets. Type: uint Code: public uint Spacing { get; set; } ``` -------------------------------- ### DotTiled.Grid Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Grid Comprehensive API documentation for the `DotTiled.Grid` class, detailing its purpose, inheritance, and properties like `Height`, `Orientation`, and `Width`. ```APIDOC Class: Grid Namespace: DotTiled Assembly: DotTiled.dll Description: Used to specify how tile overlays for terrain and collision information are rendered in isometric maps. Definition: public class Grid Inheritance: object Grid Inherited Members (from object): Equals(object) Equals(object, object) GetHashCode() GetType() MemberwiseClone() ReferenceEquals(object, object) ToString() Properties: Height: Description: Height of a grid cell. Definition: public required uint Height { get; set; } Property Value Type: uint Orientation: Description: Orientation of the grid for the tiles in this tileset. Definition: public GridOrientation Orientation { get; set; } Property Value Type: GridOrientation Width: Description: Width of a grid cell. Definition: public required uint Width { get; set; } Property Value Type: uint ``` -------------------------------- ### C# Property: CustomEnumDefinition.ValueAsFlags Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.CustomEnumDefinition Gets or sets a boolean indicating whether the enum values should be interpreted as bit flags. ```C# public bool ValueAsFlags { get; set; } ``` -------------------------------- ### API Documentation for DotTiled.RectangleObject Class Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.RectangleObject Comprehensive API documentation for the `RectangleObject` class, including its namespace, assembly, detailed description, inheritance hierarchy, implemented interfaces, and a list of all inherited properties and methods. ```APIDOC Class: RectangleObject Namespace: DotTiled Assembly: DotTiled.dll Description: A rectangle object in a map. The existing X, Y, Width, and Height properties are used to determine the size of the rectangle. Inheritance: - object - HasPropertiesBase - Object - RectangleObject Implements: - IHasProperties Inherited Members: - Object.ID - Object.Name - Object.Type - Object.X - Object.Y - Object.Width - Object.Height - Object.Rotation - Object.Visible - Object.Template - Object.Properties - Object.GetProperties() - HasPropertiesBase.GetProperty(string) - HasPropertiesBase.TryGetProperty(string, out T) - HasPropertiesBase.MapPropertiesTo() - HasPropertiesBase.MapPropertiesTo(Func) - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() ``` -------------------------------- ### IHasProperties.GetProperty(string name) Method Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.IHasProperties Gets a specific property by its name and type. Throws an exception if the property is not found or is not of the specified type. ```APIDOC Method: GetProperty(string name) Description: Gets a property of the specified type with the specified name. Signature: T GetProperty(string name) where T : IProperty Parameters: name (string): The name of the property to get. Returns: T: The property with the specified name. Type Parameters: T: The type of the property to get. ``` -------------------------------- ### C# Property: Name for ICustomTypeDefinition Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.ICustomTypeDefinition Gets or sets the human-readable name for a custom type. This property is of type `string` and provides a descriptive label for the custom type. ```C# string Name { get; set; } ``` -------------------------------- ### APIDOC: DotTiled.ObjectProperty Class Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.ObjectProperty Detailed API documentation for the `ObjectProperty` class, including its namespace, assembly, description, inheritance hierarchy, implemented interfaces, inherited members, and specific properties and methods. ```APIDOC Class ObjectProperty Namespace: DotTiled Assembly: DotTiled.dll Description: Represents an object property. Definition: public class ObjectProperty : IProperty, IProperty Inheritance: - object - ObjectProperty Implements: - IProperty - IProperty Inherited Members: - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() Properties: Name: Description: The name of the property. Definition: public required string Name { get; set; } Type: string Type: Description: The type of the property. Definition: public PropertyType Type { get; } Type: PropertyType Value: Description: The object identifier referenced by the property. Definition: public required uint Value { get; set; } Type: uint Methods: Clone(): Description: Clones the property, only used for copying properties when performing overriding with templates. Definition: public IProperty Clone() Returns: Type: IProperty Description: An identical, but non-reference-equal, instance of the same property. ``` -------------------------------- ### DotTiled.TileLayer Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.TileLayer Comprehensive API documentation for the `DotTiled.TileLayer` class, detailing its namespace, assembly, inheritance hierarchy, implemented interfaces, inherited members, and public properties with their types and descriptions. ```APIDOC Class: TileLayer Namespace: DotTiled Assembly: DotTiled.dll Description: Represents a tile layer in a map. Definition: public class TileLayer : BaseLayer, IHasProperties Inheritance: - object - HasPropertiesBase - BaseLayer - TileLayer Implements: - IHasProperties Inherited Members: - BaseLayer.ID - BaseLayer.Name - BaseLayer.Class - BaseLayer.Opacity - BaseLayer.Visible - BaseLayer.TintColor - BaseLayer.OffsetX - BaseLayer.OffsetY - BaseLayer.ParallaxX - BaseLayer.ParallaxY - BaseLayer.Properties - BaseLayer.GetProperties() - HasPropertiesBase.GetProperty(string) - HasPropertiesBase.TryGetProperty(string, out T) - HasPropertiesBase.MapPropertiesTo() - HasPropertiesBase.MapPropertiesTo(Func) - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() Properties: - Name: Data Description: The tile layer data. Type: Optional Definition: public Optional Data { get; set; } - Name: Height Description: The height of the layer in tiles. Always the same as the map height for fixed-size maps. Type: uint Definition: public required uint Height { get; set; } - Name: Width Description: The width of the layer in tiles. Always the same as the map width for fixed-size maps. Type: uint Definition: public required uint Width { get; set; } - Name: X Description: The X coordinate of the layer in tiles. Type: uint Definition: public uint X { get; set; } - Name: Y Description: The Y coordinate of the layer in tiles. Type: uint Definition: public uint Y { get; set; } ``` -------------------------------- ### C# Property: ID for ICustomTypeDefinition Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.ICustomTypeDefinition Gets or sets the unique identifier for a custom type. This property is of type `uint` and is essential for uniquely identifying each custom type instance. ```C# uint ID { get; set; } ``` -------------------------------- ### DotTiled.Template Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Template Detailed API reference for the `DotTiled.Template` class, including its namespace, assembly, inheritance hierarchy, inherited members, and property descriptions with their types. ```APIDOC Class: Template Namespace: DotTiled Assembly: DotTiled.dll Description: Represents a Tiled template. A template is a reusable object that can be placed in an DotTiled inside the Tiled editor. Inheritance: - object - Template Inherited Members: - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() Properties: - Name: Object Description: The object that this template represents. Type: Object Access: public required - Name: Tileset Description: If the template represents a tile object, this property will contain the tileset that the tile belongs to. Type: Optional Access: public ``` -------------------------------- ### Transformations.HFlip Property Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Transformations Gets or sets a boolean value indicating whether a tile can be horizontally flipped. This property controls the horizontal mirroring transformation, allowing for visual variations of the tile. ```APIDOC Property: HFlip Type: bool Code: public bool HFlip { get; set; } ``` -------------------------------- ### DotTiled.StringProperty Clone Method Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.StringProperty Describes the `Clone()` method of the `StringProperty` class, its purpose for copying properties, C# definition, and return type with description. ```APIDOC Methods: Clone(): Description: Clones the property, only used for copying properties when performing overriding with templates. Definition: public IProperty Clone() Returns: Type: IProperty Description: An identical, but non-reference-equal, instance of the same property. ``` -------------------------------- ### Transformations.Rotate Property Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Transformations Gets or sets a boolean value indicating whether a tile can be rotated in 90-degree increments. This property enables rotational transformations for the tile, providing options for different orientations. ```APIDOC Property: Rotate Type: bool Code: public bool Rotate { get; set; } ``` -------------------------------- ### DotTiled.ObjectLayer Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.ObjectLayer Comprehensive API documentation for the `DotTiled.ObjectLayer` class, detailing its definition, inheritance hierarchy, implemented interfaces, inherited members, and public properties with their types and descriptions. ```APIDOC Class: ObjectLayer Namespace: DotTiled Assembly: DotTiled.dll Definition: public class ObjectLayer : BaseLayer, IHasProperties Inheritance: - System.Object - DotTiled.HasPropertiesBase - DotTiled.BaseLayer - DotTiled.ObjectLayer Implements: - DotTiled.IHasProperties Inherited Members: - DotTiled.BaseLayer.ID - DotTiled.BaseLayer.Name - DotTiled.BaseLayer.Class - DotTiled.BaseLayer.Opacity - DotTiled.BaseLayer.Visible - DotTiled.BaseLayer.TintColor - DotTiled.BaseLayer.OffsetX - DotTiled.BaseLayer.OffsetY - DotTiled.BaseLayer.ParallaxX - DotTiled.BaseLayer.ParallaxY - DotTiled.BaseLayer.Properties - DotTiled.BaseLayer.GetProperties() - DotTiled.HasPropertiesBase.GetProperty(string) - DotTiled.HasPropertiesBase.TryGetProperty(string, out T) - DotTiled.HasPropertiesBase.MapPropertiesTo() - DotTiled.HasPropertiesBase.MapPropertiesTo(System.Func) - System.Object.Equals(object) - System.Object.Equals(object, object) - System.Object.GetHashCode() - System.Object.GetType() - System.Object.MemberwiseClone() - System.Object.ReferenceEquals(object, object) - System.Object.ToString() Properties: Color: Description: A color that is multiplied with any tile objects drawn by this layer. Type: DotTiled.Optional Signature: public Optional Color { get; set; } DrawOrder: Description: Whether the objects are drawn according to the order of appearance (Index) or sorted by their Y coordinate (TopDown). Type: DotTiled.DrawOrder Signature: public DrawOrder DrawOrder { get; set; } Height: Description: The height of the object layer in tiles. Meaningless. Type: System.UInt32 Signature: public uint Height { get; set; } Objects: Description: The objects in the object layer. Type: System.Collections.Generic.List Signature: public required List Objects { get; set; } Width: Description: The width of the object layer in tiles. Meaningless. Type: System.UInt32 Signature: public uint Width { get; set; } X: Description: The X coordinate of the object layer in tiles. Type: System.UInt32 Signature: public uint X { get; set; } Y: Description: The Y coordinate of the object layer in tiles. Type: System.UInt32 Signature: public uint Y { get; set; } ``` -------------------------------- ### C# TileObject.GID Property Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.TileObject Describes the `GID` property of the `TileObject` class, which is an unsigned integer reference to a tile. This property allows getting and setting the global ID of the tile. ```APIDOC Property: GID Description: A reference to a tile. Definition: public uint GID { get; set; } Property Value: uint ``` -------------------------------- ### DotTiled.PolygonObject Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.PolygonObject Comprehensive API documentation for the PolygonObject class, including its namespace, assembly, description, inheritance hierarchy, implemented interfaces, inherited members, and specific properties. ```APIDOC Class: PolygonObject Namespace: DotTiled Assembly: DotTiled.dll Description: A polygon object in a map. The existing X and Y properties are used as the origin of the polygon. Inheritance: - object - HasPropertiesBase - Object - PolygonObject Implements: - IHasProperties Inherited Members: - Object.ID - Object.Name - Object.Type - Object.X - Object.Y - Object.Width - Object.Height - Object.Rotation - Object.Visible - Object.Template - Object.Properties - Object.GetProperties() - HasPropertiesBase.GetProperty(string) - HasPropertiesBase.TryGetProperty(string, out T) - HasPropertiesBase.MapPropertiesTo() - HasPropertiesBase.MapPropertiesTo(Func) - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() Properties: Points: Description: The points that make up the polygon. X and Y are used as the origin of the polygon. Signature: public required List Points { get; set; } Value Type: List ``` -------------------------------- ### DotTiled.EllipseObject Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.EllipseObject Comprehensive API documentation for the `EllipseObject` class within the `DotTiled` namespace. This includes its namespace, assembly, a detailed description, inheritance hierarchy, implemented interfaces, and a list of all inherited members from base classes like `Object`, `HasPropertiesBase`, and `System.Object`. ```APIDOC Class: EllipseObject Namespace: DotTiled Assembly: DotTiled.dll Description: An ellipse object in a map. The existing X, Y, Width, and Height properties are used to determine the size of the ellipse. Definition: public class EllipseObject : Object, IHasProperties Inheritance: - object - HasPropertiesBase - Object - EllipseObject Implements: - IHasProperties Inherited Members: From Object: - ID - Name - Type - X - Y - Width - Height - Rotation - Visible - Template - Properties - GetProperties() From HasPropertiesBase: - GetProperty(string) - TryGetProperty(string, out T) - MapPropertiesTo() - MapPropertiesTo(Func) From System.Object: - Equals(object) - Equals(object, object) - GetHashCode() - GetType() - MemberwiseClone() - ReferenceEquals(object, object) - ToString() ``` -------------------------------- ### DotTiled Map Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Map Detailed API documentation for the `Map` class, including its structure, inheritance, implemented interfaces, and all its public properties with their types and descriptions. ```APIDOC Class: Map Namespace: DotTiled Assembly: DotTiled.dll Description: Represents a Tiled map. Definition: public class Map : HasPropertiesBase, IHasProperties Inheritance: - object - HasPropertiesBase Implements: - IHasProperties Inherited Members (from HasPropertiesBase): - GetProperty(string) - TryGetProperty(string, out T) - MapPropertiesTo() - MapPropertiesTo(Func) Inherited Members (from object): - Equals(object) - Equals(object, object) - GetHashCode() - GetType() - MemberwiseClone() - ReferenceEquals(object, object) - ToString() Properties: - Name: BackgroundColor Description: The background color of the map. Type: Color Definition: public Color BackgroundColor { get; set; } - Name: Class Description: The class of this map. Type: string Definition: public string Class { get; set; } - Name: CompressionLevel Description: The compression level to use for tile layer data (defaults to -1, which means to use the algorithm default). Typically only useful for parsing, but may be interesting for certain use cases. Type: int Definition: public int CompressionLevel { get; set; } - Name: Height Description: The height of the map in tiles. Type: uint Definition: public required uint Height { get; set; } - Name: HexSideLength Description: Only for hexagonal maps. Determines the width or height (depending on the staggered axis) of the tile's edge, in pixels. Type: Optional Definition: public Optional HexSideLength { get; set; } - Name: Infinite Description: Whether this map is infinite. An infinite map has no fixed size and can grow in all directions. Its layer data is stored in chunks. Type: bool Definition: public bool Infinite { get; set; } - Name: Layers Description: Hierarchical list of layers. Group is a layer type which can contain sub-layers to create a hierarchy. Type: List Definition: public List Layers { get; set; } - Name: NextLayerID Description: Stores the next available ID for new layers. This number is used to prevent reuse of the same ID after layers have been removed. Type: uint Definition: public required uint NextLayerID { get; set; } - Name: NextObjectID Description: Stores the next available ID for new objects. This number is used to prevent reuse of the same ID after objects have been removed. Type: uint Definition: public required uint NextObjectID { get; set; } - Name: Orientation Description: Map orientation. Type: MapOrientation Definition: public required MapOrientation Orientation { get; set; } - Name: ParallaxOriginX Description: X coordinate of the parallax origin in pixels. Type: float Definition: public float ParallaxOriginX { get; set; } - Name: ParallaxOriginY Description: Y coordinate of the parallax origin in pixels. Type: float Definition: public float ParallaxOriginY { get; set; } - Name: Properties Description: Map properties. Type: List Definition: public List Properties { get; set; } ``` -------------------------------- ### Transformations.VFlip Property Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Transformations Gets or sets a boolean value indicating whether a tile can be vertically flipped. This property controls the vertical mirroring transformation, offering another way to create visual variations. ```APIDOC Property: VFlip Type: bool Code: public bool VFlip { get; set; } ``` -------------------------------- ### DotTiled.FileProperty Class API Documentation Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.FileProperty Comprehensive API documentation for the `FileProperty` class, detailing its structure, properties, and methods. This class represents a file property and implements `IProperty` and `IProperty`. ```APIDOC Class: FileProperty Namespace: DotTiled Assembly: DotTiled.dll Description: Represents a file property. Definition: public class FileProperty : IProperty, IProperty Inheritance: - object - FileProperty Implements: - IProperty - IProperty Inherited Members: - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() Properties: Name: Description: The name of the property. Definition: public required string Name { get; set; } Type: string Type: Description: The type of the property. Definition: public PropertyType Type { get; } Type: PropertyType Value: Description: The value of the property. Definition: public required string Value { get; set; } Type: string Methods: Clone(): Description: Clones the property, only used for copying properties when performing overriding with templates. Definition: public IProperty Clone() Returns: Type: IProperty Description: An identical, but non-reference-equal, instance of the same property. ``` -------------------------------- ### C# TileObject.FlippingFlags Property Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.TileObject Describes the `FlippingFlags` property of the `TileObject` class, which indicates the flipping flags for the tile. This property allows getting and setting the tile's flipping state. ```APIDOC Property: FlippingFlags Description: The flipping flags for the tile. Definition: public FlippingFlags FlippingFlags { get; set; } Property Value: FlippingFlags ``` -------------------------------- ### API Documentation for DotTiled.FillMode Enum Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.FillMode Detailed API documentation for the `FillMode` enumeration, including its namespace, assembly, overall description, and a breakdown of its fields with their respective purposes. ```APIDOC Enum: FillMode Namespace: DotTiled Assembly: DotTiled.dll Description: Determines how a tile is rendered in a tile set. Fields: Stretch (int = 0) Description: The tile is stretched to fill the tile size, possibly distorting the tile. PreserveAspectFit (int = 1) Description: The tile's aspect ratio is preserved, and it is scaled to fit within the tile size. ``` -------------------------------- ### Transformations.PreferUntransformed Property Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Transformations Gets or sets a boolean value that determines if untransformed tiles are preferred over transformed ones. When true, original tiles are prioritized; otherwise, transformed variations are used to increase diversity in the tileset. ```APIDOC Property: PreferUntransformed Type: bool Code: public bool PreferUntransformed { get; set; } ``` -------------------------------- ### DotTiled.ImageLayer Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.ImageLayer Detailed API specification for the `ImageLayer` class, including its definition, inheritance, implemented interfaces, inherited members, and public properties. ```C# public class ImageLayer : BaseLayer, IHasProperties ``` ```APIDOC Class: ImageLayer Namespace: DotTiled Assembly: DotTiled.dll Description: Represents an image layer in a map. Inheritance: - object - HasPropertiesBase - BaseLayer Implements: - IHasProperties Inherited Members: - BaseLayer.ID - BaseLayer.Name - BaseLayer.Class - BaseLayer.Opacity - BaseLayer.Visible - BaseLayer.TintColor - BaseLayer.OffsetX - BaseLayer.OffsetY - BaseLayer.ParallaxX - BaseLayer.ParallaxY - BaseLayer.Properties - BaseLayer.GetProperties() - HasPropertiesBase.GetProperty(string) - HasPropertiesBase.TryGetProperty(string, out T) - HasPropertiesBase.MapPropertiesTo() - HasPropertiesBase.MapPropertiesTo(Func) - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() Properties: Image: Description: The image to be drawn by this image layer. Type: Optional Accessors: get, set RepeatX: Description: Whether the image drawn by this layer is repeated along the X axis. Type: Optional Accessors: get, set RepeatY: Description: Whether the image drawn by this layer is repeated along the Y axis. Type: Optional Accessors: get, set X: Description: The X position of the image layer in pixels. Type: uint Accessors: get, set Y: Description: The Y position of the image layer in pixels. Type: Optional Accessors: get, set ``` -------------------------------- ### APIDOC: DotTiled.ColorProperty Class Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.ColorProperty Comprehensive API documentation for the ColorProperty class, including its definition, inheritance, implemented interfaces, properties, and methods. ```APIDOC Class: ColorProperty Namespace: DotTiled Assembly: DotTiled.dll Description: Represents a color property. Definition: public class ColorProperty : IProperty>, IProperty Inheritance: - object - ColorProperty Implements: - IProperty> - IProperty Inherited Members (from object): - Equals(object) - Equals(object, object) - GetHashCode() - GetType() - MemberwiseClone() - ReferenceEquals(object, object) - ToString() Properties: - Name: Description: The name of the property. Type: required string Code: public required string Name { get; set; } - Type: Description: The type of the property. Type: PropertyType Code: public PropertyType Type { get; } - Value: Description: The color value of the property. Type: required Optional Code: public required Optional Value { get; set; } Methods: - Clone(): Description: Clones the property, only used for copying properties when performing overriding with templates. Returns: IProperty (An identical, but non-reference-equal, instance of the same property.) Code: public IProperty Clone() ``` -------------------------------- ### DotTiled.Image Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.Image Detailed API documentation for the `DotTiled.Image` class, representing an image used by a tileset, including its definition, inheritance, and properties with their types and descriptions. ```APIDOC Class: Image Namespace: DotTiled Assembly: DotTiled.dll Description: Represents an image that is used by a tileset. Definition: public class Image Inherits: object Properties: Format: Description: The format of the image. Type: Optional Accessors: get, set Height: Description: The image height in pixels, used for tile index correction when the image changes. Type: Optional Accessors: get, set Source: Description: The reference to the image file. Type: Optional Accessors: get, set TransparentColor: Description: Defines a specific color that is treated as transparent. Type: Optional Accessors: get, set Width: Description: The image width in pixels, used for tile index correction when the image changes. Type: Optional Accessors: get, set ``` -------------------------------- ### API Documentation for TextVerticalAlignment Enum Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.TextVerticalAlignment Detailed API documentation for the `TextVerticalAlignment` enum, including its namespace, assembly, and a description of each field with its corresponding integer value and purpose. ```APIDOC Enum: TextVerticalAlignment Namespace: DotTiled Assembly: DotTiled.dll Description: The vertical alignment of text. Fields: - Top = 0: The text is aligned to the top. - Center = 1: The text is aligned to the center. - Bottom = 2: The text is aligned to the bottom. ``` -------------------------------- ### DotTiled.FloatProperty Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.FloatProperty Comprehensive API documentation for the `FloatProperty` class, detailing its structure, properties, and methods within the `DotTiled` namespace. ```APIDOC Class: FloatProperty Namespace: DotTiled Assembly: DotTiled.dll Description: Represents a float property. Signature: public class FloatProperty : IProperty, IProperty Inheritance: object -> FloatProperty Implements: IProperty, IProperty Properties: Name: Description: The name of the property. Signature: public required string Name { get; set; } Type: string Type: Description: The type of the property. Signature: public PropertyType Type { get; } Type: PropertyType Value: Description: The float value of the property. Signature: public required float Value { get; set; } Type: float Methods: Clone(): Description: Clones the property, only used for copying properties when performing overriding with templates. Signature: public IProperty Clone() Returns: Type: IProperty Description: An identical, but non-reference-equal, instance of the same property. ``` -------------------------------- ### DotTiled.TileOffset Class API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.TileOffset Comprehensive API documentation for the DotTiled.TileOffset class, including its definition, inheritance, and purpose. ```C# public class TileOffset ``` ```APIDOC Class: TileOffset Namespace: DotTiled Assembly: DotTiled.dll Description: Is used to specify an offset in pixels in tilesets, to be applied when drawing a tile from the related tileset. Inheritance: - object - TileOffset Inherited Members: - object.Equals(object) - object.Equals(object, object) - object.GetHashCode() - object.GetType() - object.MemberwiseClone() - object.ReferenceEquals(object, object) - object.ToString() ``` -------------------------------- ### DotTiled API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled Comprehensive API documentation for the DotTiled library, outlining its main classes, interfaces, and enumerations. This includes definitions for core components like Tilesets, Transformations, Wang sets, and various data handling and rendering enums. ```APIDOC Classes: Tileset: 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: 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. 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. 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. ``` -------------------------------- ### APIDOC: DotTiled.DataCompression Enum Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.DataCompression Detailed API documentation for the DotTiled.DataCompression enum, including its namespace, assembly, overall purpose, and a comprehensive list of its fields with their corresponding values and descriptions. ```APIDOC Enum DataCompression Namespace: DotTiled Assembly: DotTiled.dll Description: Specifies the compression algorithm used to compress the tile layer data. Fields: GZip = 0: GZip compression. ZLib = 1: ZLib compression. ZStd = 2: ZStandard compression. Currently not supported by DotTiled and will throw an exception if encountered. ``` -------------------------------- ### C# Method: Clone() Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.ColorProperty Defines the Clone() method of ColorProperty, which returns an IProperty instance, used for copying properties. ```C# public IProperty Clone() ``` -------------------------------- ### DotTiled.RenderOrder Enum API Reference Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.RenderOrder Comprehensive API documentation for the DotTiled.RenderOrder enumeration, including its namespace, assembly, and detailed descriptions of each field and its associated value. ```APIDOC Enum: RenderOrder Namespace: DotTiled Assembly: DotTiled.dll Fields: RightDown = 0 Description: Right-down render order. Starts at top-left and proceeds right then down. RightUp = 1 Description: Right-up render order. Starts at bottom-left and proceeds right then up. LeftDown = 2 Description: Left-down render order. Starts at top-right and proceeds left then down. LeftUp = 3 Description: Left-up render order. Starts at bottom-right and proceeds left then up. ``` -------------------------------- ### DotTiled.StringProperty Class Definition Source: https://dcronqvist.github.io/DotTiled/api/DotTiled.html/DotTiled.StringProperty Defines the `StringProperty` class, its namespace, assembly, inheritance hierarchy, and implemented interfaces. ```APIDOC Class: StringProperty Namespace: DotTiled Assembly: DotTiled.dll Description: Represents a string property. Definition: public class StringProperty : IProperty, IProperty Inheritance: - object - StringProperty Implements: - IProperty - IProperty ```