Interface ITagService

A centralized IService that deals with all ITagData related logic.

Namespace: IdleKit.Gameplay

Assembly: cs.temp.dll.dll

Syntax

public interface ITagService : IService

Methods

ContainsAllTags(ITagData[], ITagData[])

Whether or not all tagsToCheckFor exist in the tags.

Declaration

bool ContainsAllTags(ITagData[] tags, ITagData[] tagsToCheckFor)

Parameters

Type	Name	Description
ITagData[]	tags
ITagData[]	tagsToCheckFor

Returns

Type	Description
Boolean

ContainsAllTags(ITagData[], String[])

Whether or not the Tag Ids specified via tagIdsToCheckFor exists in the tags.

Declaration

bool ContainsAllTags(ITagData[] tags, string[] tagIdsToCheckFor)

Parameters

Type	Name	Description
ITagData[]	tags
String[]	tagIdsToCheckFor

Returns

Type	Description
Boolean

ContainsAnyTags(ITagData[], ITagData[])

Whether or not any tagsToCheckFor exist in the tags.

Declaration

bool ContainsAnyTags(ITagData[] tags, ITagData[] tagsToCheckFor)

Parameters

Type	Name	Description
ITagData[]	tags
ITagData[]	tagsToCheckFor

Returns

Type	Description
Boolean

ContainsAnyTags(ITagData[], String[])

Whether or not any the Tag Ids specified via tagIdsToCheckFor exist in the tags.

Declaration

bool ContainsAnyTags(ITagData[] tags, string[] tagIdsToCheckFor)

Parameters

Type	Name	Description
ITagData[]	tags
String[]	tagIdsToCheckFor

Returns

Type	Description
Boolean

ContainsTag(ITagData[], ITagData)

Whether or not the given tagToCheckFor exists in the tags.

Declaration

bool ContainsTag(ITagData[] tags, ITagData tagToCheckFor)

Parameters

Type	Name	Description
ITagData[]	tags
ITagData	tagToCheckFor

Returns

Type	Description
Boolean

ContainsTag(ITagData[], String)

Whether or not the given Tag Id specified via tagIdToCheckFor exists in the tags.

Declaration

bool ContainsTag(ITagData[] tags, string tagIdToCheckFor)

Parameters

Type	Name	Description
ITagData[]	tags
String	tagIdToCheckFor

Returns

Type	Description
Boolean

ContainsTargetTags(ITagData[], ITagData[], Boolean)

Checks whether the array of ITagData within tagsToCheckFor exist within tags.

Declaration

bool ContainsTargetTags(ITagData[] tags, ITagData[] tagsToCheckFor, bool requireAll)

Parameters

Type	Name	Description
ITagData[]	tags
ITagData[]	tagsToCheckFor
Boolean	requireAll

Returns

Type	Description
Boolean

Remarks

If requireAll is true then all tags in tagsToCheckFor must exist within tags. If requireAll is false only one tag in tagsToCheckFor must exist within tags.

ContainsTargetTags(ITagData[], String[], Boolean)

Checks whether the array of Tag Ids specified via tagIdsToCheckFor exist within tags.

Declaration

bool ContainsTargetTags(ITagData[] tags, string[] tagIdsToCheckFor, bool requireAll)

Parameters

Type	Name	Description
ITagData[]	tags
String[]	tagIdsToCheckFor
Boolean	requireAll

Returns

Type	Description
Boolean

Remarks

If requireAll is true then all tags in tagIdsToCheckFor must exist within tags. If requireAll is false only one tag in tagIdsToCheckFor must exist within tags.

GetTag(String)

Returns a ITagData by id

Declaration

ITagData GetTag(string id)

Parameters

Type	Name	Description
String	id

Returns

Type	Description
ITagData

GetTaggedEntitiesWithAllTags<T>(ITagData[])

Returns IEntitys of the type T which contain all of the tags specified via tagsToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithAllTags<T>(ITagData[] tagsToCheckFor)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
ITagData[]	tagsToCheckFor

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

GetTaggedEntitiesWithAllTags<T>(String[])

Returns IEntitys of the type T which contain all of the tag Ids specified via tagIdsToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithAllTags<T>(string[] tagIdsToCheckFor)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
String[]	tagIdsToCheckFor

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

GetTaggedEntitiesWithAnyTags<T>(ITagData[])

Returns IEntitys of the type T which contain any of the tags specified via tagsToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithAnyTags<T>(ITagData[] tagsToCheckFor)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
ITagData[]	tagsToCheckFor

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

GetTaggedEntitiesWithAnyTags<T>(String[])

Returns IEntitys of the type T which contain any of the tag Ids specified via tagIdsToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithAnyTags<T>(string[] tagIdsToCheckFor)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
String[]	tagIdsToCheckFor

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

GetTaggedEntitiesWithTag<T>(ITagData)

Returns IEntitys of the type T which contain the tag specified in tagToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithTag<T>(ITagData tagToCheckFor)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
ITagData	tagToCheckFor

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

GetTaggedEntitiesWithTag<T>(String)

Returns IEntitys of the type T which contain the tag specified in tagToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithTag<T>(string tagToCheckFor)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
String	tagToCheckFor

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

GetTaggedEntitiesWithTags<T>(ITagData[], Boolean)

Returns IEntitys of the type T which contain the tags specified in tagsToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithTags<T>(ITagData[] tagsToCheckFor, bool requireAll)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
ITagData[]	tagsToCheckFor
Boolean	requireAll

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

Remarks

If requireAll is true the ITaggedEntity must contain all tags specified in tagsToCheckFor. If requireAll is false the ITaggedEntity only has to contain one tag specified in tagsToCheckFor.

Examples

When passing tagsToCheckFor containing "Business" + "Rare", only ITaggedEntity objects that contain both "Business" and "Rare" tags will be returned when requireAll is true. If requireAll is false then any ITaggedEntity that contains either "Business" or "Rare" tags will be returned.

GetTaggedEntitiesWithTags<T>(String[], Boolean)

Returns IEntitys of the type T which contain the tags specified in tagIdsToCheckFor. The IEntity must implement ITaggedEntity.

Declaration

T[] GetTaggedEntitiesWithTags<T>(string[] tagIdsToCheckFor, bool requireAll)
    where T : class, ITaggedEntity

Parameters

Type	Name	Description
String[]	tagIdsToCheckFor
Boolean	requireAll

Returns

Type	Description
T[]

Type Parameters

Name	Description
T

Remarks

If requireAll is true the ITaggedEntity must contain all tags specified in tagIdsToCheckFor. If requireAll is false the ITaggedEntity only has to contain one tag specified in tagIdsToCheckFor.

Examples

When passing tagIdsToCheckFor containing "Business" + "Rare", only ITaggedEntity objects that contain both "Business" and "Rare" tags will be returned when requireAll is true. If requireAll is false then any ITaggedEntity that contains either "Business" or "Rare" tags will be returned.

GetTags(String[])

Returns an array of ITagData specified by ids

Declaration

ITagData[] GetTags(string[] ids)

Parameters

Type	Name	Description
String[]	ids

Returns

Type	Description
ITagData[]