Class used when bundling tilemaps/grids. More...

Inheritance diagram for TilePlus.TpTileFab:

Collaboration diagram for TilePlus.TpTileFab:

Classes
class	AssetSpec
	class used to describe a single tile archive and where it should be loaded. More...

Public Member Functions
bool	AddGuid ()
	Add a GUID to this asset. Only works once.
bool	Release ()
	Release memory from all bundles.

Public Attributes
List< AssetSpec >	m_TileAssets =new()
	A list of TpTileBundle assets, tilemap names and tags.
string?	m_ScenePath
	The scene path for this asset.
string?	m_TimeStamp
	The timestamp for this asset.
string?	m_OriginalScene
	The original scene this was created from.
bool	m_FromGridSelection
	set true if this TileFab was created from a GridSelection rather than an entire tilemap.
bool	m_IgnoreInPainter
	Set true if Painter should not show this in its Palettes list.
bool	m_UserFlag
	Arbitrary boolean for use when filtering layouts.
string	m_UserString = string.Empty
	Arbitrary string for use when filtering layouts.
Sprite?	m_Icon
	Added in V3. A representative sprite. Painter will display this.

Properties
byte	AssetVersion `[get]`
	Gets the asset version.
Guid	TileFabGuid `[get]`
	Get the asset's GUID as a GUID struct.
BoundsInt	LargestBounds `[get]`
	Get the largest bounds.
bool	AnyPersistables `[get]`
	Returns true if ANY of the bundle assets have persistable GUIDs; ie were set up correctly for TPT5.
bool	EmptyTileFab `[get]`
	Returns true if this TileFab has no Bundle assets or none of the assets have any tiles.
bool	IsChunkified `[get]`
	is this tilefab chunkified? Checks the Bundles
string	AssetGuidString `[get]`
	Get a string representation of the GUID.

Detailed Description

Class used when bundling tilemaps/grids.

Version 2 adds GUIDs

Member Function Documentation

◆ AddGuid()

bool TilePlus.TpTileFab.AddGuid ( )

Add a GUID to this asset. Only works once.

Returns: true if the GUID was added, false if there already was a GUID

◆ Release()

bool TilePlus.TpTileFab.Release ( )

Release memory from all bundles.

Returns

Member Data Documentation

◆ m_FromGridSelection

bool TilePlus.TpTileFab.m_FromGridSelection

set true if this TileFab was created from a GridSelection rather than an entire tilemap.

◆ m_Icon

Sprite? TilePlus.TpTileFab.m_Icon

Added in V3. A representative sprite. Painter will display this.

◆ m_IgnoreInPainter

bool TilePlus.TpTileFab.m_IgnoreInPainter

Set true if Painter should not show this in its Palettes list.

◆ m_OriginalScene

string? TilePlus.TpTileFab.m_OriginalScene

The original scene this was created from.

◆ m_ScenePath

string? TilePlus.TpTileFab.m_ScenePath

The scene path for this asset.

◆ m_TileAssets

List<AssetSpec> TilePlus.TpTileFab.m_TileAssets =new()

A list of TpTileBundle assets, tilemap names and tags.

◆ m_TimeStamp

string? TilePlus.TpTileFab.m_TimeStamp

The timestamp for this asset.

◆ m_UserFlag

bool TilePlus.TpTileFab.m_UserFlag

Arbitrary boolean for use when filtering layouts.

◆ m_UserString

string TilePlus.TpTileFab.m_UserString = string.Empty

Arbitrary string for use when filtering layouts.

Property Documentation

◆ AnyPersistables

bool TilePlus.TpTileFab.AnyPersistables

get

Returns true if ANY of the bundle assets have persistable GUIDs; ie were set up correctly for TPT5.

◆ AssetGuidString

string TilePlus.TpTileFab.AssetGuidString

get

Get a string representation of the GUID.

◆ AssetVersion

byte TilePlus.TpTileFab.AssetVersion

get

Gets the asset version.

The asset version.

◆ EmptyTileFab

bool TilePlus.TpTileFab.EmptyTileFab

get

Returns true if this TileFab has no Bundle assets or none of the assets have any tiles.

◆ IsChunkified

bool TilePlus.TpTileFab.IsChunkified

get

is this tilefab chunkified? Checks the Bundles

◆ LargestBounds

BoundsInt TilePlus.TpTileFab.LargestBounds

get

Get the largest bounds.

◆ TileFabGuid

Guid TilePlus.TpTileFab.TileFabGuid

get

Get the asset's GUID as a GUID struct.

The unique identifier.

The documentation for this class was generated from the following file:

/Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/AssetScripts/Bundles/TpTileFab.cs

Classes

Public Member Functions

Public Attributes

Properties