IGameplayTagsEditorModule

The public interface to this module

Windows
MacOS
Linux

Inheritance Hierarchy

IModuleInterface

IGameplayTagsEditorModule

References

Module

GameplayTagsEditor

Header

/Engine/Plugins/Editor/GameplayTagsEditor/Source/GameplayTagsEditor/Public/GameplayTagsEditorModule.h

Include

#include "GameplayTagsEditorModule.h"

Syntax

class IGameplayTagsEditorModule : public IModuleInterface

Remarks

The public interface to this module

Functions

Name Description

Public function

bool

 

AddNewGameplayTagSource

(
    const FString& NewTagSource,
    const FString& RootDirToUse
)

Adds a new tag source, well use project config directory if not specified.

Public function

bool

 

AddNewGameplayTagToINI

(
    const FString& NewTag,
    const FString& Comment,
    FName TagSourceName,
    bool bIsRestrictedTag,
    bool bAllowNonRestrictedChildren
)

Tries to add a new gameplay tag to the ini lists

Public function

bool

 

AddTransientEditorGameplayTag

(
    const FString& NewTransientTag
)

Adds a transient gameplay tag (only valid for the current editor session)

Public function

bool

 

DeleteTagFromINI

(
    TSharedPtr< struct FGameplayTagNode...
)

Tries to delete a tag from the library.

Public function Static

IGameplayTag...

 

Get()

Singleton-like access to this module's interface.

Public function Static

bool

 

IsAvailable()

Checks to see if this module is loaded and ready.

Public function

TSharedRef< ...

 

MakeGameplayTagContainerWidget

(
    FOnSetGameplayTagContainer OnSetTag,
    TSharedPtr< FGameplayTagContainer >...,
    const FString& FilterString
)

Creates a simple version of a tag container widget that has a default value and will call a custom callback

Public function

TSharedRef< ...

 

MakeGameplayTagWidget

(
    FOnSetGameplayTag OnSetTag,
    TSharedPtr< FGameplayTag > Gameplay...,
    const FString& FilterString
)

Creates a simple version of a gameplay tag widget that has a default value and will call a custom callback

Public function

bool

 

RenameTagInINI

(
    const FString& TagToRename,
    const FString& TagToRenameTo
)

Tries to rename a tag, leaving a rediretor in the ini, and adding the new tag if it does not exist yet

Public function

bool

 

UpdateTagInINI

(
    const FString& TagToUpdate,
    const FString& Comment,
    bool bIsRestrictedTag,
    bool bAllowNonRestrictedChildren
)

Updates info about a tag
Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss