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

Detailed Description

A tag settings that defines behavior of systems those integrate the Tag Tool.

See also
DynamicResource
Inheritance diagram for Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag:
Collaboration diagram for Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag:

Public Member Functions

delegate void TagHandler (Tag tag)
 Handler using for tag related operations. More...
 
 Tag (string key)
 Instantiates the tag's data. More...
 
object Clone ()
 Cloning the tag instance to the new one. More...
 
void MergeTo (Tag to)
 Copying values of the: More...
 
void MergeTo (IMergeableResource to)
 Redirecting to the MergeTo(Tag) with safe cast of resource to the Tag. More...
 
void MergeTo (T to)
 Sharing itself values to some another merging resource. More...
 

Static Public Attributes

const string TOOLTIP_CACHEABLE
 Tool tip for the IsCached field's UI element. More...
 
const string TOOLTIP_VISIBILITY = "Visibility of the tag among the systems."
 Tool tip for the Visibility field's UI element.
 
const string TOOLTIP_KEY = "An unique key of the tag."
 Tool tip for the Key field's UI element.
 
const string TOOLTIP_COLOR = "Color of the tag backplate."
 Tool tip for the Tint field's UI element.
 
static UnityEngine.Color DefaultTagTint = new UnityEngine.Color(0.35f, 0.35f, 1f)
 Color applied to the tags by default.
 

Protected Member Functions

virtual void OnModified ()
 Occurs when a tag's property has been changed.
 

Properties

string Key [get, set]
 An unique key of the tag.
 
TagVisibility Visibility [get, set]
 Visibility of the tag among the systems.
 
bool IsCached [get, set]
 If true than the DynamicResources with the tag will be placed by the Dynamic Resource Tool in separated hash table. More...
 
Color Tint [get, set]
 Color of the tag GUI backplate.
 

Events

static TagHandler Modified
 Occurs when some tag has been modified.
 

Constructor & Destructor Documentation

◆ Tag()

Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag.Tag ( string  key)

Instantiates the tag's data.

Parameters
keyUnique key of the tag.

Member Function Documentation

◆ Clone()

object Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag.Clone ( )

Cloning the tag instance to the new one.

Returns

◆ MergeTo() [1/3]

void Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag.MergeTo ( IMergeableResource  to)

Redirecting to the MergeTo(Tag) with safe cast of resource to the Tag.

Parameters
toTarget resource.

◆ MergeTo() [2/3]

Sharing itself values to some another merging resource.

Parameters
toTarget resource that will contains the value merged with stored in this resource.

◆ MergeTo() [3/3]

void Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag.MergeTo ( Tag  to)

Copying values of the:

Parameters
to

◆ TagHandler()

delegate void Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag.TagHandler ( Tag  tag)

Handler using for tag related operations.

Parameters
tag

Member Data Documentation

◆ TOOLTIP_CACHEABLE

const string Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag.TOOLTIP_CACHEABLE
static
Initial value:
= "If true than the `DynamicResource`s with the tag will " +
"be placed by the `Dynamic Resource Tool` in cache.\n\n" +
"That allows much faster search by the tag in future but " +
"damaging RAM using in case if collections is big.\n\n" +
"Recommendation: Use for base resource tags like:\n" +
"\t- `Car`\n" +
"\t- `Weapon`\n" +
"\t- `Character`\n" +
"\t- `Props`"

Tool tip for the IsCached field's UI element.

Property Documentation

◆ IsCached

bool Doloro.DataManagement.DynamicResources.Modules.TagsTool.Tag.IsCached
getset

If true than the DynamicResources with the tag will be placed by the Dynamic Resource Tool in separated hash table.

That allows much faster search by the tag in future but " + damaging RAM using in case if collections is big.

Recommendation: Use for base resource tags like:

  • Car
  • Weapon
  • Character
  • Props

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