Doloro GDK 22 .1.0 Beta
by Tauri Interactive
Doloro.DataManagement.DynamicResources.Search.TagsDefinitionFilter< T > Class Template Reference

Detailed Description

Checks that the ITagsCollection instance has certain tags as defined.

Type Constraints
T :UnityEngine.Object 
T :ITagsCollection 
Inheritance diagram for Doloro.DataManagement.DynamicResources.Search.TagsDefinitionFilter< T >:
Collaboration diagram for Doloro.DataManagement.DynamicResources.Search.TagsDefinitionFilter< T >:

Public Member Functions

 TagsDefinitionFilter (params string[] demandedTagKeys)
 Creating new filter instance. More...
 
virtual bool IsResourcePassingFilter (GameObject resource, out UnityEngine.Object filteredResource)
 Looking for component with a type defined at the HandlingType property. More...
 
virtual bool IsResourcePassingFilter (UnityEngine.Object resource, out UnityEngine.Object filteredResource)
 Checks is the resource is can be casted to the HandlingType and handles it if possible. More...
 
bool IsResourcePassingFilter (UnityEngine.GameObject resource, out UnityEngine.Object filteredResource)
 Passing the resource through the query filter. More...
 

Protected Member Functions

override bool OnResourceFilter (object resource, out UnityEngine.Object filteredResource)
 Checks that all the tags defined at the TagKeys be defined at the ITagsCollection resource. More...
 

Properties

string[] TagKeys [get, set]
 Tags that must be defined via the ITagsCollection to pass this filter. More...
 
override string GetStaticSignature [get]
 Returns value in format DRTDF[+TagKeys] More...
 
virtual Type HandlingType [get]
 Type that will be handled by the query. More...
 
bool IsComponentsHandler [get]
 Checks is handling type is component-like.
 

Constructor & Destructor Documentation

◆ TagsDefinitionFilter()

Creating new filter instance.

Parameters
demandedTagKeysKeys that must be defined.

Member Function Documentation

◆ IsResourcePassingFilter() [1/3]

virtual bool Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.IsResourcePassingFilter ( GameObject  resource,
out UnityEngine.Object  filteredResource 
)
virtualinherited

Looking for component with a type defined at the HandlingType property.

Handle it via OnResourceFilter(object, out UnityEngine.Object) if found.

Parameters
resourceInput resource for check.
filteredResourceSub-resource that was selected by filter as the target. Will be registered in filter->resource pair in Resource collection.
Returns
Checks is the resource passing the filter. False if check is impossible.

◆ IsResourcePassingFilter() [2/3]

bool Doloro.DataManagement.DynamicResources.Search.IResourceFilter.IsResourcePassingFilter ( UnityEngine.GameObject  resource,
out UnityEngine.Object  filteredResource 
)
inherited

Passing the resource through the query filter.

Parameters
resourceComparable resource.
filteredResourceSub-resource that was selected by filter as the target. Will be registered in filter->resource pair in Resource collection.
Returns
True if the resource passing query filter.

◆ IsResourcePassingFilter() [3/3]

virtual bool Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.IsResourcePassingFilter ( UnityEngine.Object  resource,
out UnityEngine.Object  filteredResource 
)
virtualinherited

Checks is the resource is can be casted to the HandlingType and handles it if possible.

Parameters
resourceInput resource for check.
Returns
Parameters
filteredResourceSub-resource that was selected by filter as the target. Will be registered in filter->resource pair in Resource collection.
Checks is the resource passing the filter. False if check is impossible.

Implements Doloro.DataManagement.DynamicResources.Search.IResourceFilter.

◆ OnResourceFilter()

override bool Doloro.DataManagement.DynamicResources.Search.TagsDefinitionFilter< T >.OnResourceFilter ( object  resource,
out UnityEngine.Object  filteredResource 
)
protectedvirtual

Checks that all the tags defined at the TagKeys be defined at the ITagsCollection resource.

Parameters
resourceComponent of the type defined at the ResourceTypeFilter<T>.HandlingType property.
filteredResourceSub-resource that was selected by filter as the target. Will be registered in filter->resource pair in Resource collection.
Returns
True if the resource passing query filter.

Reimplemented from Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.

Property Documentation

◆ GetStaticSignature

override string Doloro.DataManagement.DynamicResources.Search.TagsDefinitionFilter< T >.GetStaticSignature
get

Returns value in format DRTDF[+TagKeys]

DRTDF+Item+Weapon+Melee

Implements Doloro.DataManagement.DynamicResources.Search.IResourceFilter.

◆ HandlingType

virtual Type Doloro.DataManagement.DynamicResources.Search.ResourceTypeFilter< T >.HandlingType
getinherited

Type that will be handled by the query.

Could be:

  • Inherited from the UnityEngine.Component for UnityEngine.GameObject resources.
  • Could be interface or parent class for UnityEngine.Object resources.

◆ TagKeys

Tags that must be defined via the ITagsCollection to pass this filter.

Always not null.

Implements Doloro.DataManagement.DynamicResources.ITagsCollection.


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