Navigation
API > API/Plugins > API/Plugins/CommonUI
| Name | UCommonUIVisibilitySubsystem |
| Type | class |
| Header File | /Engine/Plugins/Runtime/CommonUI/Source/CommonUI/Public/CommonUIVisibilitySubsystem.h |
| Include Path | #include "CommonUIVisibilitySubsystem.h" |
Syntax
UCLASS (MinimalAPI, DisplayName="UI Visibility Subsystem")
class UCommonUIVisibilitySubsystem : public ULocalPlayerSubsystem
Inheritance Hierarchy
- UObjectBase → UObjectBaseUtility → UObject → USubsystem → ULocalPlayerSubsystem → UCommonUIVisibilitySubsystem
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
UCommonUIVisibilitySubsystem() |
CommonUIVisibilitySubsystem.h |
Classes
| Name | Remarks |
|---|---|
| FHardwareVisibilityTagsChangedEvent |
Constants
| Name | Type | Remarks | Include Path |
|---|---|---|---|
| DebugTagsToEnable | FGameplayTagContainer | CommonUIVisibilitySubsystem.h | |
| DebugTagsToSuppress | FGameplayTagContainer | CommonUIVisibilitySubsystem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| OnVisibilityTagsChanged | FHardwareVisibilityTagsChangedEvent | CommonUIVisibilitySubsystem.h |
Protected
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| ComputedVisibilityTags | FGameplayTagContainer | CommonUIVisibilitySubsystem.h | ||
| UserVisibilityTags | FGameplayTagContainer | CommonUIVisibilitySubsystem.h |
Functions
Public
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
void AddUserVisibilityCondition
(
const FGameplayTag UserTag |
CommonUIVisibilitySubsystem.h | ||
const FGameplayTagContainer & GetVisibilityTags () |
Get the visibility tags currently in play (the combination of platform traits and current input tags). | CommonUIVisibilitySubsystem.h | |
bool HasVisibilityTag
(
const FGameplayTag VisibilityTag |
Returns true if the player currently has the specified visibility tag (note: this value should not be cached without listening for OnVisibilityTagsChanged as it can change at runtime) | CommonUIVisibilitySubsystem.h | |
void RemoveUserVisibilityCondition
(
const FGameplayTag UserTag |
CommonUIVisibilitySubsystem.h |
Overridden from USubsystem
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual void Deinitialize() |
CommonUIVisibilitySubsystem.h | ||
virtual void Initialize
(
FSubsystemCollectionBase& Collection |
CommonUIVisibilitySubsystem.h | ||
virtual bool ShouldCreateSubsystem
(
UObject* Outer |
CommonUIVisibilitySubsystem.h |
Protected
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
virtual FGameplayTagContainer ComputeVisibilityTags() |
CommonUIVisibilitySubsystem.h | ||
void OnInputMethodChanged
(
ECommonInputType CurrentInputType |
CommonUIVisibilitySubsystem.h | ||
void RefreshVisibilityTags() |
CommonUIVisibilitySubsystem.h |
Static
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
static UCommonUIVisibilitySubsystem * Get
(
const ULocalPlayer* LocalPlayer |
CommonUIVisibilitySubsystem.h | ||
static UCommonUIVisibilitySubsystem * GetChecked
(
const ULocalPlayer* LocalPlayer |
CommonUIVisibilitySubsystem.h | ||
static void SetDebugVisibilityConditions
(
const FGameplayTagContainer& TagsToEnable, |
CommonUIVisibilitySubsystem.h |