UM::

Metadata usable in UCLASS.

Windows
MacOS
Linux

References

Module

CoreUObject

Header

/Engine/Source/Runtime/CoreUObject/Public/UObject/ObjectMacros.h

Include

#include "UObject/ObjectMacros.h"

Syntax

namespace UM
{
    enum
    {
        BlueprintSpawnableComponent,
        ChildCanTick,
        ChildCannotTick,
        IgnoreCategoryKeywordsInSubclasses,
        DeprecatedNode,
        DeprecationMessage,
        DisplayName,
        ScriptName,
        IsBlueprintBase,
        KismetHideOverrides,
        ProhibitedInterfaces,
        RestrictedToClasses,
        ShowWorldContextPin,
        DontUseGenericSpawnObject,
        ExposedAsyncProxy,
        BlueprintThreadSafe,
        UsesHierarchy,
    }
}

Values

Name

Description

BlueprintSpawnableComponent

[ClassMetadata] Used for Actor Component classes. If present indicates that it can be spawned by a Blueprint.

ChildCanTick

[ClassMetadata] Used for Actor and Component classes. If the native class cannot tick, Blueprint generated classes based this Actor or Component can have bCanEverTick flag overridden even if bCanBlueprintsTickByDefault is false.

ChildCannotTick

[ClassMetadata] Used for Actor and Component classes. If the native class cannot tick, Blueprint generated classes based this Actor or Component can never tick even if bCanBlueprintsTickByDefault is true.

IgnoreCategoryKeywordsInSubclasses

[ClassMetadata] Used to make the first subclass of a class ignore all inherited showCategories and hideCategories commands

DeprecatedNode

[ClassMetadata] For BehaviorTree nodes indicates that the class is deprecated and will display a warning when compiled.

DeprecationMessage

[ClassMetadata] [PropertyMetadata] [FunctionMetadata] Used in conjunction with DeprecatedNode, DeprecatedProperty, or DeprecatedFunction to customize the warning message displayed to the user.

DisplayName

[ClassMetadata] [PropertyMetadata] [FunctionMetadata] The name to display for this class, property, or function instead of auto-generating it from the name.

ScriptName

[ClassMetadata] [PropertyMetadata] [FunctionMetadata] The name to use for this class, property, or function when exporting it to a scripting language. May include deprecated names as additional semi-colon separated entries.

IsBlueprintBase

[ClassMetadata] Specifies that this class is an acceptable base class for creating blueprints.

KismetHideOverrides

[ClassMetadata] Comma delimited list of blueprint events that are not be allowed to be overridden in classes of this type

ProhibitedInterfaces

[ClassMetadata] Specifies interfaces that are not compatible with the class.

RestrictedToClasses

[ClassMetadata] Used by BlueprintFunctionLibrary classes to restrict the graphs the functions in the library can be used in to the classes specified.

ShowWorldContextPin

[ClassMetadata] Indicates that when placing blueprint nodes in graphs owned by this class that the hidden world context pin should be visible because the self context of the class cannot provide the world context and it must be wired in manually

DontUseGenericSpawnObject

ExposedAsyncProxy

BlueprintThreadSafe

UsesHierarchy

[ClassMetadata] Indicates the class uses hierarchical data. Used to instantiate hierarchical editing features in details panels

Remarks

Metadata usable in UCLASS.

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