Class Tags

Gameplay tags utilities.

Inheritance

Tags

Assembly: FlaxEngine.dll

File: Engine/Level/Tags.h

Syntax

public class Tags

Methods

HasAll(const Array<Tag>& list, const Array<Tag>& tags)

Checks if the list of tags contains all of the given tags (including parent tags check). For example, HasAll({"A.B", "C"}, {"A", "C"}) returns true, for exact check use HasAllExact.

Declaration

public static bool HasAll(const Array<Tag>& list, const Array<Tag>& tags)

Parameters

Array<Tag> list The tags list to use.

Array<Tag> tags The tags to check.

Returns

bool True if all of the given tags are contained by the list of tags. Returns true for empty list.

HasAllExact(const Array<Tag>& list, const Array<Tag>& tags)

Checks if the list of tags contains all of the given tags (exact match). For example, HasAllExact({"A.B", "C"}, {"A", "C"}) returns false, for parents check use HasAll.

Declaration

public static bool HasAllExact(const Array<Tag>& list, const Array<Tag>& tags)

Parameters

Array<Tag> list The tags list to use.

Array<Tag> tags The tags to check.

Returns

bool True if all of the given tags are contained by the list of tags. Returns true for empty list.

HasAny(const Array<Tag>& list, const Array<Tag>& tags)

Checks if the list of tags contains any of the given tags (including parent tags check). For example, HasAny({"A.B", "C"}, {"A"}) returns true, for exact check use HasAnyExact.

Declaration

public static bool HasAny(const Array<Tag>& list, const Array<Tag>& tags)

Parameters

Array<Tag> list The tags list to use.

Array<Tag> tags The tags to check.

Returns

bool True if any of of the given tags is contained by the list of tags.

HasAnyExact(const Array<Tag>& list, const Array<Tag>& tags)

Checks if the list of tags contains any of the given tags (exact match). For example, HasAnyExact({"A.B", "C"}, {"A"}) returns false, for parents check use HasAny.

Declaration

public static bool HasAnyExact(const Array<Tag>& list, const Array<Tag>& tags)

Parameters

Array<Tag> list The tags list to use.

Array<Tag> tags The tags to check.

Returns

bool True if any of the given tags is contained by the list of tags.

HasTag(const Array<Tag>& list, const Tag tag)

Checks if the list of tags contains a given tag (including parent tags check). For example, HasTag({"A.B"}, "A") returns true, for exact check use HasTagExact.

Declaration

public static bool HasTag(const Array<Tag>& list, const Tag tag)

Parameters

Array<Tag> list The tags list to use.

Tag tag The tag to check.

Returns

bool True if given tag is contained by the list of tags. Returns false for empty list.

HasTagExact(const Array<Tag>& list, const Tag tag)

Checks if the list of tags contains a given tag (exact match). For example, HasTag({"A.B"}, "A") returns false, for parents check use HasTag.

Declaration

public static bool HasTagExact(const Array<Tag>& list, const Tag tag)

Parameters

Array<Tag> list The tags list to use.

Tag tag The tag to check.

Returns

bool True if given tag is contained by the list of tags. Returns false for empty list.