Sha256: 9aebe6fc79407aa69ad0e61d1497000efd8a1fbcab02251c46081445628fda31
Contents?: true
Size: 1.99 KB
Versions: 4
Compression:
Stored size: 1.99 KB
Contents
/* Copyright (c) 2024 Julian Benda
*
* This file is part of inkCPP which is released under MIT license.
* See file LICENSE.txt or go to
* https://github.com/JBenda/inkcpp for full license details.
*/
#pragma once
#include "CoreMinimal.h"
#include "TagList.generated.h"
/**
* Helpful tag list
* @ingroup unreal
*/
UCLASS()
class INKCPP_API UTagList : public UObject
{
GENERATED_BODY()
public:
UTagList();
/** Initializes the tag list from an array
* @private
*/
void Initialize(const TArray<FString>& tags);
UFUNCTION(BlueprintPure, Category = "Ink")
/** Checks if the tag is present in the array.
*
* @blueprint
*/
bool Has(const FString& tag) const;
UFUNCTION(BlueprintPure, Category = "Ink")
/** Check if tag list contains enum flag.
* Check if one of the enum flag string represntations is equal
* to one flag in the list.
* @param Enum the enum class to check flags from
* @param value of the flag iff one was found
* @retval true if a flag was found
* @attention if multiple flags are present in the list, only the first will be returned
* @see #GetEnum()
*
* @blueprint
*/
bool HasEnum(const UEnum* Enum, uint8& value) const;
UFUNCTION(BlueprintPure, Category = "Ink")
/** Searches for a tag that begins with 'name:' and returns the string after the colon
* @retval "" if no value was found, or if there are nothing behind ':'
*
* @blueprint
*/
FString GetValue(const FString& name) const;
UFUNCTION(BlueprintPure, Category = "Ink")
/** 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
* @retval true if a tag in the form "EnumName:FlagName" was found
*
* @blueprint
*/
bool GetEnum(const UEnum* Enum, uint8& value) const;
UFUNCTION(BlueprintPure, Category = "Ink")
/** Get all tags as array.
*
* @blueprint
*/
const TArray<FString>& GetTags() const;
private:
TArray<FString> Tags;
};
Version data entries
4 entries across 4 versions & 1 rubygems