Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase Class Reference

Detailed Description

Provides categorization features for tags related resources.

See also
TagsDatabaseUtils, TagsDatabase, Tag

Static Public Member Functions

static bool IsTagCategorized (this Tag tag)
 Checking is the tag has hashed resources collection. More...
 
static bool IsTagCategorized (string tagKey)
 Checking is the tag has hashed resources collection. More...
 
static string[] GetTags ()
 Returns collection of tags with hashed resources. More...
 
static ICollection< UnityEngine.Object > GetResources (params Tag[] tags)
 Looks for resources with following tags among cached. More...
 
static ICollection< UnityEngine.Object > GetResources (this Tag tag)
 Looking for loaded resources with the tag. More...
 
static ICollection< UnityEngine.Object > GetResources (string tagKey)
 Looking for loaded resources with the tag. More...
 
static void CategorizeCacheableDynamicResources ()
 Categorizing all the loaded DynamicResource instances.
 
static void CategorizeCacheablePrefabAssets< TagsProviderComponentType > ()
 Categorizing all the found prefabs with components inherited from the TagsSourceType abstract class. More...
 
static void CategorizeCacheableAssets< AssetType, TagsSourceType > ()
 Scanning DynamicResource instances and sorting it among the Tag related collections. More...
 

Properties

static CategorizationProcessState CategorizationState [get]
 State of asynchronicity categorization process.
 
static bool CategorizationInprogress [get]
 False in case if CategorizationState is CategorizationProcessState.NotStarted or CategorizationProcessState.Finished
 
static int CategorizedTagsCount [get]
 Count of tags with bonded branches of resources collection.
 
static string CategorizationProcessLog [get, set]
 Output log of the resource cataloging process.
 

Events

static Action CategorizationLogsUpdated
 Occurs when the CategorizationProcessLog value has been updated.
 
static Action CategorizationFinished
 Occurs when categorization process is finished.
 

Member Function Documentation

◆ CategorizeCacheableAssets< AssetType, TagsSourceType >()

static void Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.CategorizeCacheableAssets< AssetType, TagsSourceType > ( )
static

Scanning DynamicResource instances and sorting it among the Tag related collections.

Template Parameters
AssetTypeType of the base asset.
  • GameObject for prefabs.
  • custom for your own scriptable objects.
TagsSourceTypeThe type of the ITagsCollection component in case of a GameObject.
Exceptions
CategorizationProcessAlreadyInProgressProcess already has been started.

Works only for tags with enabled Tag.IsCached. Using TagsDatabaseUtils.MergedDatabase as tags source.

Type Constraints
AssetType :UnityEngine.Object 
TagsSourceType :UnityEngine.Object 
TagsSourceType :ITagsCollection 

◆ CategorizeCacheablePrefabAssets< TagsProviderComponentType >()

static void Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.CategorizeCacheablePrefabAssets< TagsProviderComponentType > ( )
static

Categorizing all the found prefabs with components inherited from the TagsSourceType abstract class.

Template Parameters
TagsProviderComponentTypeThe type of the ITagsCollection component in case of a GameObject.
Type Constraints
TagsProviderComponentType :UnityEngine.Object 
TagsProviderComponentType :ITagsCollection 
TagsProviderComponentType :CategorizeCacheableAssets 
TagsProviderComponentType :GameObject 
TagsProviderComponentType :TagsProviderComponentType 

◆ GetResources() [1/3]

static ICollection< UnityEngine.Object > Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.GetResources ( params Tag[]  tags)
static

Looks for resources with following tags among cached.

Parameters
tagsTags that must be defined for the resource.
Returns
Collection of resources with requested tags.

◆ GetResources() [2/3]

static ICollection< UnityEngine.Object > Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.GetResources ( string  tagKey)
static

Looking for loaded resources with the tag.

Parameters
tagKeyTag.Key value.
Returns
Resources collection in case if registered.
See also
Tag.IsCached

Entire objects in the collection implements ITagsCollection interface.

◆ GetResources() [3/3]

static ICollection< UnityEngine.Object > Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.GetResources ( this Tag  tag)
static

Looking for loaded resources with the tag.

Parameters
tagRequired tag.
Returns
Resources collection in case if registered.
See also
Tag.IsCached

Entire objects in the collection implements ITagsCollection interface.

◆ GetTags()

static string[] Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.GetTags ( )
static

Returns collection of tags with hashed resources.

Returns
Collection of tags.

◆ IsTagCategorized() [1/2]

static bool Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.IsTagCategorized ( string  tagKey)
static

Checking is the tag has hashed resources collection.

Parameters
tagKeyTag.Key value.
Returns
Result of existence of hashed resources.
See also
Tag.IsCached

◆ IsTagCategorized() [2/2]

static bool Doloro.DataManagement.DynamicResources.Modules.TagsTool.CategorizedTagsDatabase.IsTagCategorized ( this Tag  tag)
static

Checking is the tag has hashed resources collection.

Parameters
tagUsing only Tag.Key value.
Returns
Result of existence of hashed resources.
See also
Tag.IsCached

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