TilePlus.TpChunkSelectorBase Class Reference

Not for use, just a concrete base class. More...

Inheritance diagram for TilePlus.TpChunkSelectorBase:

Collaboration diagram for TilePlus.TpChunkSelectorBase:

Public Member Functions
virtual ? TileFabLoadParams	Selector (RectInt locator, TpZoneLayout layout, Dictionary< string, Tilemap > monitoredMaps)
	Obtain TileFab load params given a locator.
virtual bool	Initialize (TpZoneManager zm, object? obj=null)
	Initialization. Parameters zm The Zone Manager this Selector is using obj Arbitrary data Returns true if XXXX, false otherwise.
virtual bool	Release ()
	Release any assets used by the selector such as caches. Returns false if error
virtual void	OnEnable ()
	OnEnable handler: add a GUID if not present. Typically this occurs when the SO is created from Unity's Create Asset menu.
virtual List< TemplateSelectorQueryResults< T > >	GetTilePlusTilesOfType< T > (Func< T, string, bool >? filter=null, int size=16, object? options=null)
	Query the TileFab for TPT tiles of a certrain type.
virtual BoundsInt	SelectorTotalSize (TpZoneLayout layout)
	Get the largest bounds from all Fabs used by a selector.
void	AddGuid ()
	Add/Change GUID for this asset.

Public Attributes
FabOrBundleLoadFlags	m_LoadFlags = FabOrBundleLoadFlags.NormalWithFilter
	Load flags to use.

Properties
virtual ? List< TpTileFab >	UsedTileFabs [get]
	A list of the TileFabs used by this selector. If not appropriate, return null.
int	ChunkSize [get, set]
	The chunk size used by this selector.
Guid	SelectorGuid [get]
	A GUID for this selector.
string	AssetGuidString [get]
	GUID as string.
Properties inherited from TilePlus.IChunkSelector
FabOrBundleLoadFlags	LoadFlags [get]
	Default load flags. Override in derived class.

Detailed Description

Not for use, just a concrete base class.

Member Function Documentation

AddGuid()

void TilePlus.TpChunkSelectorBase.AddGuid

(

)

Add/Change GUID for this asset.

GetTilePlusTilesOfType< T >()

virtual List< TemplateSelectorQueryResults< T > > TilePlus.TpChunkSelectorBase.GetTilePlusTilesOfType< T > ( Func< T, string, bool >? filter = null, int size = 16, object? options = null )

virtual

Query the TileFab for TPT tiles of a certrain type.

Parameters

options	Optional object for custom use.
filter	optional filter
size	default size of returned list.

Template Parameters

T

Type

Returns

List of TemplateSelectorQueryResults

Reimplemented in TilePlus.TpChunkZoneSelector.

Type Constraints

T

:

TilePlusBase

Initialize()

virtual bool TilePlus.TpChunkSelectorBase.Initialize ( TpZoneManager zm, object? obj = null )

virtual

Initialization.

Parameters

zm	The Zone Manager this Selector is using
obj	Arbitrary data

Returns

true if XXXX, false otherwise.

Implements TilePlus.IChunkSelector.

Reimplemented in TilePlus.TpChunkZoneSelector, and TilePlus.TpSingleFabChunkSelector.

OnEnable()

virtual void TilePlus.TpChunkSelectorBase.OnEnable ( )

virtual

OnEnable handler: add a GUID if not present. Typically this occurs when the SO is created from Unity's Create Asset menu.

Release()

virtual bool TilePlus.TpChunkSelectorBase.Release ( )

virtual

Release any assets used by the selector such as caches.

Returns

false if error

Implements TilePlus.IChunkSelector.

Reimplemented in TilePlus.TpChunkZoneSelector, and TilePlus.TpSingleFabChunkSelector.

Selector()

virtual ? TileFabLoadParams TilePlus.TpChunkSelectorBase.Selector ( RectInt locator, TpZoneLayout layout, Dictionary< string, Tilemap > monitoredMaps )

virtual

Obtain TileFab load params given a locator.

Parameters

locator	The Locator.
layout	The Zone Layout instance.
monitoredMaps	Tilemaps used by the ZoneManager.

Returns

TileFab load params

Implements TilePlus.IChunkSelector.

Reimplemented in TilePlus.TpChunkZoneSelector, and TilePlus.TpSingleFabChunkSelector.

SelectorTotalSize()

virtual BoundsInt TilePlus.TpChunkSelectorBase.SelectorTotalSize ( TpZoneLayout layout )

virtual

Get the largest bounds from all Fabs used by a selector.

Implements TilePlus.IChunkSelector.

Reimplemented in TilePlus.TpChunkZoneSelector, and TilePlus.TpSingleFabChunkSelector.

Member Data Documentation

m_LoadFlags

FabOrBundleLoadFlags TilePlus.TpChunkSelectorBase.m_LoadFlags = FabOrBundleLoadFlags.NormalWithFilter

Load flags to use.

Property Documentation

AssetGuidString

string TilePlus.TpChunkSelectorBase.AssetGuidString

get

GUID as string.

ChunkSize

int TilePlus.TpChunkSelectorBase.ChunkSize

getset

The chunk size used by this selector.

Implements TilePlus.IChunkSelector.

SelectorGuid

Guid TilePlus.TpChunkSelectorBase.SelectorGuid

get

A GUID for this selector.

Implements TilePlus.IChunkSelector.

UsedTileFabs

virtual ? List<TpTileFab> TilePlus.TpChunkSelectorBase.UsedTileFabs

get

A list of the TileFabs used by this selector. If not appropriate, return null.

Implements TilePlus.IChunkSelector.

---

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

• /Users/jms/Documents/Tpt_55/TPT55/Assets/Plugins/TilePlus/Runtime/AssetScripts/Chunking/TpChunkSelectorBase.cs