None = 0
No flags are set for the Tile. This is the default for most Tiles.
LockColor = 1 << 0
Set this flag if the Tile script controls the color of the Tile. If this is set, the Tile controls the color as it is placed onto the TilemapA GameObject that allows you to quickly create 2D levels using tiles and a grid overlay. More info
See in Glossary. You cannot change the Tile’s color through painting or using scriptsA piece of code that allows you to create your own Components, trigger game events, modify Component properties over time and respond to user input in any way you like. More info
See in Glossary. If this is not set, you can change the Tile’s color through painting or using scripts.
LockTransform = 1 << 1
Set this flag if the Tile script controls the transform of the Tile. If this is set, the Tile controls the transform as it is placed onto the Tilemap. You cannot rotate or change the Tile’s transform through painting or using scripts. If this is not set, you can change the Tile’s transform through painting or using scripts.
LockAll = LockColor | LockTransform
This is a combination of all the lock flags used by TileBase.
InstantiateSpawnGameObjectRuntimeOnly = 1 << 2
Set this flag if the Tile script should spawn its game object only when your project is running and not in Editor mode.
None = 0
This Tile does not generate a colliderAn invisible shape that is used to handle physical collisions for an object. A collider doesn’t need to be exactly the same shape as the object’s mesh - a rough approximation is often more efficient and indistinguishable in gameplay. More info
See in Glossary shape.
Sprite = 1
The collider shape generated by this Tile is the physics shape set by the SpriteA 2D graphic objects. If you are used to working in 3D, Sprites are essentially just standard textures but there are special techniques for combining and managing sprite textures for efficiency and convenience during development. More info
See in Glossary that the Tile returns. If no physics shape has been set in the Sprite, it tries to generate a shape based on the outline of the Sprite.
Note: If a collider shape for a Tile needs to be generated in runtime, set a physics shape for the Sprite or set the Texture of the Sprite to be readable in order for Unity to generate a shape based on the outline.
Grid = 2
The collider shape generated by this Tile is the shape of the cell, defined by the layout of the Grid.
ITilemap
is the base class where Tile
can retrieve data from the Tilemap when the Tilemap tries to retrieve data from the Tile.
Vector3Int origin { get; }
This returns the origin point of the Tilemap in cellspace.
Vector3Int size { get; }
This returns the size of the Tilemap in cellspace.
Bounds localBounds { get; }
This returns the bounds of the Tilemap in localspace.
BoundsInt cellBounds { get; }
This returns the bounds of the Tilemap in cellspace.
Sprite GetSprite(Vector3Int location);
This returns the sprite used by the Tile in the Tilemap at the given location.
Color GetColor(Vector3Int location);
This returns the color used by the Tile in the Tilemap at the given location.
Matrix4x4 GetTransformMatrix(Vector3Int location);
This returns the transform matrix used by the Tile in the Tilemap at the given location.
TileFlags GetTileFlags(Vector3Int location);
This returns the tile flags used by the Tile in the Tilemap at the given location.
TileBase GetTile(Vector3Int location);
This returns the Tile in the Tilemap at the given location. If there is no Tile there, it returns null.
T GetTile<T>(Vector3Int location) where T : TileBase;
This returns the Tile in the Tilemap at the given location with type T. If there is no Tile with the matching type there, it returns null.
void RefreshTile(Vector3Int location);
This requests a refresh of the Tile in the Tilemap at the given location.
T GetComponent<T>();
This returns the component T that is attached to the GameObjectThe fundamental object in Unity scenes, which can represent characters, props, scenery, cameras, waypoints, and more. A GameObject’s functionality is defined by the Components attached to it. More info
See in Glossary of the Tilemap.
When you visit any website, it may store or retrieve information on your browser, mostly in the form of cookies. This information might be about you, your preferences or your device and is mostly used to make the site work as you expect it to. The information does not usually directly identify you, but it can give you a more personalized web experience. Because we respect your right to privacy, you can choose not to allow some types of cookies. Click on the different category headings to find out more and change our default settings. However, blocking some types of cookies may impact your experience of the site and the services we are able to offer.
More information
These cookies enable the website to provide enhanced functionality and personalisation. They may be set by us or by third party providers whose services we have added to our pages. If you do not allow these cookies then some or all of these services may not function properly.
These cookies allow us to count visits and traffic sources so we can measure and improve the performance of our site. They help us to know which pages are the most and least popular and see how visitors move around the site. All information these cookies collect is aggregated and therefore anonymous. If you do not allow these cookies we will not know when you have visited our site, and will not be able to monitor its performance.
These cookies may be set through our site by our advertising partners. They may be used by those companies to build a profile of your interests and show you relevant adverts on other sites. They do not store directly personal information, but are based on uniquely identifying your browser and internet device. If you do not allow these cookies, you will experience less targeted advertising. Some 3rd party video providers do not allow video views without targeting cookies. If you are experiencing difficulty viewing a video, you will need to set your cookie preferences for targeting to yes if you wish to view videos from these providers. Unity does not control this.
These cookies are necessary for the website to function and cannot be switched off in our systems. They are usually only set in response to actions made by you which amount to a request for services, such as setting your privacy preferences, logging in or filling in forms. You can set your browser to block or alert you about these cookies, but some parts of the site will not then work. These cookies do not store any personally identifiable information.