TilePlus Toolkit

TilePlus Toolkit (TPT) is a unique way to work with Unity Tilemaps. It’s a Unity extension that ...

Upgrading If you're upgrading from Version 4 or earlier and you've been writing custom code using...

If you’re not into coding and want to play with some feature demos, head over to the TilePlus Ext...

New Tile Class The key component of TPT is a new Tile base class cleverly dubbed “TilePlusBase” (...

Overview The TilePlus Toolkit base runtime system, generically called "TpLib," is divided into tw...

TpLib itself is a large class divided into eight partial classes: TpLib TpLibData TpLibDataAcces...

The Editor Library comprises, well, a whole lot of stuff! Unity menu items The custom Selection ...

When using the Unity Tilemap Editor (UTE) you can use the Tile+Brush instead of the default GridB...

In an earlier epoch I designed embedded system hardware, software, and development tools in two d...

A Key Feature None of the TpLib TMDB and query functions, and none of the Event, Messaging, Persi...

The TilePlusBase class section is always handled with a customized GUI when viewing any TilePlus ...

Selection Inspector When displaying a normal Unity tile, the Selection Inspector will look someth...

Here’s an example of a Selection Inspector when displaying a TilePlus tile. This is used in Tile+...

The Basic Info section displays read-only information from the tile. This area changes depending ...

The Selection Inspector shows this toolbar: Focus: Focus scene view on selected tile. Inspecto...

This is the Brush Inspector seen when using the Tile+Brush with the Unity Tile Editor. It looks ...

These are all project-level asssets. TpTileBundle: The asset created when you create a prefab fr...

TpAnimatedTile TpAnimatedTile is a simple animated tile and if you want to learn about the code, ...

TpBundleTile TpBundleTile loads a TileBundle to the Tile's parent Tilemap. TileBundle: a referen...

TweenerFlex This is the best tile to use when experimenting with tweens. When viewed in a TilePlu...

AnimZoneLoader This class is a subclass of TpFlexAnimated tile and inherits its fields and editor...

See the UI chapter.

AnimatorAction Animator Actions are project-level scriptable object plugins. They're only used wi...

TPP_PoolHost Add to a scene to use this as the parent of spawned prefabs. TpTriggerZoneSprites A ...

These are components that can be added Tilemap’s GameObject to load TileBundle or TileFab archive...

This component should be attached to any prefab that you use with the SpawningUtil pooling system...

Unity UI can invoke methods in monobehaviour targets using Unity events. That's not useful if yo...

Tilemap Parallax Add it to a Tilemap, provide a follow target, and this component offsets the Til...

Overview In the TilePlus system, Runtime-only Scriptable Objects are called Services or SRS, and ...

Intro TpTileTweener is a TPT service that can be used for tweening TilePlus tile sprites. The Twe...

Introduction The TilePlus system uses pooling as much as possible and reasonable. Most of this ac...

Please see Messages If you're going to use the Messaging Service you need to know about Events. T...

Introduction The TilePositionDb Service monitors Tilemap callbacks to update a small internal dat...

TilePlus Messaging and Events TpLib has general-purpose messaging and Event functionality. Messag...

Events System Superficially, the Events system implemented by TpEvents seems very simple. A tile ...

So that's Events. Messages are an entirely different animal. Events is a Static class. Messag...

Zone Actions are similar to Event Actions but they're not automatically invoked in the same way a...

Various Utilities PerkinsStringUtils This small library has one function: Word Wrapping for the U...

The Tools/TilePlus/System Info menu command opens UIElements inspector that has a multitude of in...

The Services Inspector is a UIElements-based window that can be opened with the Tools/TilePlus/Se...

The Tween monitor displays information about all running tweens. It's handy to use when creating ...

The menu command: Tools/TilePlus/Utilities/Dump PositionDB doesn't open a window. Instead, it dum...

You probably work with Tilemaps that are part of a scene. This is the easiest way to use TilePlus...

It's a bad solution When you create a prefab by dragging a Grid with child Tilemaps to the Projec...

To make a compatible prefab: Use the Grid Selection mode of TilePlus Painter OR Select a Grid ...

As mentioned before, TpTileBundle (Bundle) assets are used to archive all or a section of a Tilem...

Other Uses for Bundled Tilemaps When using Tile+Painter, Bundle assets and TileFabs appear in the...

A TileFab can encompass all the tiles and Prefabs contained within a Tilemap hierarchy (Grid with...

Review Bundle: an archive of all the tiles and Prefabs for a single Tilemap. TileFab: references ...

TileFabLib.LoadTileFab loads the Bundles referenced by a TileFab asset. The TileFab asset has ref...

One might recall from the User Guide that you can create TileFabs and Bundles using a Grid Select...

TpZoneManager is a chunk management subsystem. Your code interacts with instances of the TpZoneMa...

When you initialize a ZM with a chunk size and world origin you’re defining a higher-dimension or...

The GetLocator methods allow you to also pass in a Vector2Int dimensions parameter. This lets you...

At an even higher level, the TpZoneLayout MonoBehaviour component leverages a ZM to implement a b...

TilePlus Toolkit’s Layout system was changed in Versions 4 and 5. It’s more memory efficient and ...

Name Class Type Use TileFabLib Static Loads TileFabs, supervises ZoneManager instances. ...

Now, how do you create a TileFab for use with this system? You create a TScene in a Unity scene t...

Now that you have a TSceneList asset, let's edit it. Examine the asset in an inspector and click ...

This system is flexible, but it is easy to make mistakes. If you have the chunk size set too larg...

During your Unity scene initialization you can load the first TScene by calling TpChunkedSceneMan...

This block diagram illustrates the main parts of the chunking system. The lowest-level APIs are ...

Each TSceneList asset comprises information about one or more TScenes (Tile Scenes). These are sh...

You may have noticed in TSceneList that each TScene can have multiple TSceneSpecs. What’s that fo...

This is a really useful feature. You might have a Tilemap Group comprising a Grid with, say, 8 ch...

Zones A Zone is a square area of a Tilemap which is internally represented by a RectInt. The X an...

Selectors are used by the layout system to determine what and how to load. Each Selector has a re...

You use one of the SetScene overloads of ChunkedSceneManager to change TScenes. The very last thi...

Save Files There are two different types of save files: CdemoSaveFile.txt: contains the GUID of ...

The TilePositionDb is a Scriptable Runtime Service: it’s an optional feature that you can use to ...

This is the main interface for TilePlus tiles. Almost all of the interface is implemented in Tile...

ITpMessaging is used to implement targets for the Messaging Service. It's pretty simple: /// <sum...

This interface specifies endpoints for save and restore data. It's something optional and a bit l...

ITSceneInitializer Scene Initializers are used as a way to move scene initialization code into Sc...

These are mostly for internal use. IActionPlugin Used with ZoneActions and EventActions to provid...

If you’ve done any Unity coding then you’re probably familiar with Attributes by now, such as tho...

Common Parameters These parameters apply to all Attributes except TptShowAsLabelBrushInspector. ...

The [TppShowAsLabel…] attributes allow you to display a property. This can be useful in many ways...

Introduction Look at any Unity or Reddit forum and you'll see endless posting about how to go abo...

In most cases, the class that you want to subclass is TilePlusBase. But you might want to extend ...

Why so many properties? Fewer serialized fields for things that are just basically boolean switch...

Simulate can be implemented to use the Editor update event to do something. In TpAnimatedTile and...

Namespaces The GUI formatter for the Brush and Selection inspectors displays information in class...

No, it's not a replacement for Unity's native UI systems. There are enough of those already! It's...

UiButton This is the simplest UI element, implementing a momentary button. Subclass of TpSlideSh...

public interface ITpUiControl { ...

If you want to load the same TileFab multiple times programmatically you need to set the newGuids...

When using ZoneManager and ZoneLayout, you need to ensure that the referenced TileFabs are correc...

Code Changes Changing code in subclasses may result in missing references in already-placed clone...

The static library TpLib.cs has several Dictionaries that keep track of all TPT tiles. The initia...

TilePlus lets you treat a Tile script much like a script attached to a GameObject: but Tiles are ...

For performance reasons you might want to temporarily inhibit TpLib from responding to certain Ti...