inkcpp
Loading...
Searching...
No Matches
UTagList Class Reference

Helpful tag list. More...

#include <TagList.h>

Inheritance diagram for UTagList:

Public Member Functions

bool Has (const FString &tag) const
 Checks if the tag is present in the array.
 
bool HasEnum (const UEnum *Enum, uint8 &value) const
 Check if tag list contains enum flag.
 
FString GetValue (const FString &name) const
 Searches for a tag that begins with 'name:' and returns the string after the colon.
 
bool GetEnum (const UEnum *Enum, uint8 &value) const
 Searches for a tag thats begins with 'EnumName:' and returns the enum value corresponding to the text after the ':'.
 
const TArray< FString > & GetTags () const
 Get all tags as array.
 

Detailed Description

Helpful tag list.

Member Function Documentation

◆ GetEnum()

bool UTagList::GetEnum ( const UEnum * Enum,
uint8 & value ) const

Searches for a tag thats begins with 'EnumName:' and returns the enum value corresponding to the text after the ':'.

Attention
If the enum appears multiple times, the first instance will be used
Return values
trueif a tag in the form "EnumName:FlagName" was found

Get Enum
Target
Enum

Select Asset
Return Value
Value

◆ GetTags()

const TArray< FString > & UTagList::GetTags ( ) const

Get all tags as array.

Get Tags
Target
Return Value

◆ GetValue()

FString UTagList::GetValue ( const FString & name) const

Searches for a tag that begins with 'name:' and returns the string after the colon.

Return values
""if no value was found, or if there are nothing behind ':'

Get Value
Target
Name
Return Value

◆ Has()

bool UTagList::Has ( const FString & tag) const

Checks if the tag is present in the array.

Has
Target
Tag
Return Value

◆ HasEnum()

bool UTagList::HasEnum ( const UEnum * Enum,
uint8 & value ) const

Check if tag list contains enum flag.

Check if one of the enum flag string represntations is equal to one flag in the list.

Parameters
Enumthe enum class to check flags from
valueof the flag iff one was found
Return values
trueif a flag was found
Attention
if multiple flags are present in the list, only the first will be returned
See also
GetEnum()

Has Enum
Target
Enum

Select Asset
Return Value
Value


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