Protocols

Any TiledKit object that can have user defined properties, that supports writing of properties

Ensures a Tiled “float” can be converted into an Engine specific property value

Ensures a Tiled “color” can be converted into an Engine specific property value

Enables the implementer to provide the information required to automatically translate a tiled property and apply it to the game specific engine.

An object that can create new instances that are deep copies of itself

The entry point for any game engine specialization. See Game Engine Specialization

A concrete object that the implementor of will be able to be directly bridged to a TiledKit map with a high level of automation

Captures an object that is important for a given game engine (and will be involved in automated maping etc). In general only game engine types that map directly to Tiled entities will need to support this

Container that can contain sprites and tiles

Container that can contain objects

Layer containers can contain other elements or layers.

Producers are responsible for creating and post-processing Engine specific objects representing Tiled objects. Engine implementors must provide basic similar funcitonality but those can be the most generic realizations of Tiled objects, with specific producers created to perform more specialized work, stopping Engines from becoming overly complex in a single type.

By implementing this protocol (required for Engine.TextureType loading behaviour except the actual loading of the texture data will be provided

Undocumented

A Factory responsible for creating an Engine Map

Tile factories create the sprites that will be rendered for tiles

Tile factories create the sprites that will be rendered for tiles

This type should not be implemented outside of TiledKit and is used solely pass information about the current project to the Engines load texture implementation. Outside of TiledKit you should use the automatically provided Engine.load(textureFrom url:URL, project: Project) method

A specialized form of a PostProcessor that applies to Tiles. It is called after the first factory has created the specialized sprite for the tile

A specialized form of a PostProcessor that applies to Maps. It is called after all Layers and Objects have been made and processed

A specialized form of a PostProcessor that applies to Tiles. It is called after the first factory has created the specialized sprite for the tile

A specialized form of a PostProcessor that applies to Tiles. It is called after the first factory has created the specialized sprite for the tile

Implemented by any object that can contain Layers (such as a Map)

A LayerFilter is used when querying LayerContainers to select one or more matching Layers and are responsible for determining if any given Layer meets a set of criteria

All Layer types, or types that represent specialisations of Layer implement this common set of properties.

An ObjectFilter is used when querying LayerContainers to select one or more matching Objectss and are responsible for determining if any given Object meets a set of criteria

Undocumented

Implemented by any type that wants to be loaded (and cached, and instanced) through the TiledKit Project system. This makes it very easy to extend to a specific game engine.

You can extend the range of resources and even the way resources are loaded by implementing your own ResourceLoader.

Any TiledKit object that can have user defined properties, that supports writing of properties