Structures

The following structures are available globally.

  • Captures colors in a platform independent way for subsequent specialization.

    See more

    Declaration

    Swift

    public struct Color : Equatable
  • The Point generic captures a single in space.

    See more

    Declaration

    Swift

    public struct Point<N> : Equatable, CustomStringConvertible where N : Numeric
  • A generic type that stores a 2D dimenion (with width and height)

    See more

    Declaration

    Swift

    public struct Dimension<N> : Equatable, CustomStringConvertible where N : Numeric
  • A generic type that captrues a rectangular region in 2D space with an origin and size

    See more

    Declaration

    Swift

    public struct Rectangle<N> : Equatable, CustomStringConvertible where N : Numeric
  • Enables the definition or identification of the type of any of the core Tiled objects such as maps, layers, etc.

    See more

    Declaration

    Swift

    public struct TiledType : OptionSet, CustomStringConvertible
  • Object types represent pre-defined sets of objects that can be applied to Tiled objects. ObjectTypes captures these definitions and enables both reading and writing of the file of definitions. That can be useful for programmatically creating the object types for use in Tiled.

    See more

    Declaration

    Swift

    public struct ObjectTypes : Loadable
  • An ObjectType captures a set of properties and their default values that can be applied to any Tiled object

    See more

    Declaration

    Swift

    public struct ObjectType
  • Undocumented

    See more

    Declaration

    Swift

    public struct BridgablePropertyProcessor<TargetType> : TiledKit.MapPostProcessor, TiledKit.LayerPostProcessor, TiledKit.ObjectPostProcessor where TargetType : EngineObject
  • Captures a resolved reference to an image, including its dimensions

    See more

    Declaration

    Swift

    public struct ImageReference
  • A Group represents the collection of Layers a Tiled Group Layer contains (a Layer.Kind of .group)

    See more

    Declaration

    Swift

    public struct Group : LayerContainer
  • Undocumented

    See more

    Declaration

    Swift

    public struct GroupLayer : LayerProtocol, LayerContainer
  • Undocumented

    See more

    Declaration

    Swift

    public struct ImageLayer : LayerProtocol
  • Provides an immutable view of a Layer that is an object layer

    See more

    Declaration

    Swift

    public struct ObjectLayer : LayerProtocol
  • Undocumented

    See more

    Declaration

    Swift

    public struct TileLayer : LayerProtocol
  • Layers capture the contents of a Map can be one of four kinds

    • Tile A grid of Tiles
    • __ Object__ A collection of Objects
    • Group A collection of Layers enabling hierarchy within the Map
    • Image An image not in a TileSet

    Every layer has a set of common attributes (such as an offest) and can capture user specified properites too.

    See more

    Declaration

    Swift

    public struct Layer : LayerProtocol, MutablePropertied
  • Captures if and how a Tile should be rendered

    See more

    Declaration

    Swift

    public struct TileFlip : OptionSet
  • Represents the reference to a specific Tile in a tile Layer for a given Map. It captures not only an identifier uniquely identifying the Tile (and the TileSet it is in) but also if the Tile should be flipped (see TileFlip)

    See more

    Declaration

    Swift

    public struct TileGID : ExpressibleByIntegerLiteral, Equatable
  • Represents a two dimensional grid of tiles (such as that in a tile Layer

    See more

    Declaration

    Swift

    public struct TileGrid
  • Map

    Represents a Tiled map which can be loaded from a Tiled tmx file (other Tiled formats can be supported in the future, such as JSON). It contains the root collection of Layers as well as carrying the references to the TileSets used by the Map

    See more

    Declaration

    Swift

    public struct Map : LayerContainer, Loadable, MutablePropertied
  • Represents a Tiled object (which are contained inside Object Layers). All objects share some common attributes (e.g. their position inside their containing Layer).

    See more

    Declaration

    Swift

    public struct Object : Equatable, ObjectProtocol, MutablePropertied
  • Represents the formating and style of text Objects.

    See more

    Declaration

    Swift

    public struct TextStyle : Equatable
  • Frames are attached to Tiles and reference another Tile within the same Tile Set as well as the duration it that Tile should be displayed when shown as part of an animation

    See more

    Declaration

    Swift

    public struct Frame : Equatable
  • TileSets are referenced by Maps, and all tile Layers reference a specific Tile and TileSet by using a TileGID. The TileSetReference type captures both the first TileGID of a TileSet referenced by a Map, as well as the TileSet itself.

    See more

    Declaration

    Swift

    public struct TileSetReference