Navigation
Unreal Engine C++ API Reference > Runtime > CoreUObject > UObject
References
| Module | CoreUObject |
| Header | /Engine/Source/Runtime/CoreUObject/Public/UObject/ObjectMacros.h |
| Include | #include "UObject/ObjectMacros.h" |
Syntax
namespace UM
{
enum
&123;
AdvancedDisplay,
ArrayParm,
ArrayTypeDependentParams,
AutoCreateRefTerm,
HideAssetPicker,
BlueprintInternalUseOnly,
BlueprintProtected,
CallableWithoutWorldContext,
CommutativeAssociativeBinaryOperator,
CompactNodeTitle,
CustomStructureParam,
DefaultToSelf,
DeprecatedFunction,
ExpandEnumAsExecs,
ExpandBoolAsExecs,
ScriptMethod,
ScriptMethodSelfReturn,
ScriptMethodMutable,
ScriptOperator,
ScriptConstant,
ScriptConstantHost,
HidePin,
HideSpawnParms,
Keywords,
Latent,
LatentInfo,
MaterialParameterCollectionFunction,
NativeBreakFunc,
NativeMakeFunc,
UnsafeDuringActorConstruction,
WorldContext,
BlueprintAutocast,
NotBlueprintThreadSafe,
DeterminesOutputType,
DynamicOutputParam,
DataTablePin,
SetParam,
MapParam,
MapKeyParam,
MapValueParam,
Bitmask,
BitmaskEnum,
Bitflags,
UseEnumValuesAsMaskValuesInEditor,
AnimBlueprintFunction,
ArrayParam,
&125;
}
Values
| Name | Description |
|---|---|
| AdvancedDisplay | [FunctionMetadata] Used with a comma-separated list of parameter names that should show up as advanced pins (requiring UI expansion). |
| ArrayParm | [FunctionMetadata] Indicates that a BlueprintCallable function should use a Call Array Function node and that the parameters specified in the comma delimited list should be treated as wild card array properties. |
| ArrayTypeDependentParams | [FunctionMetadata] Used when ArrayParm has been specified to indicate other function parameters that should be treated as wild card properties linked to the type of the array parameter. |
| AutoCreateRefTerm | [FunctionMetadata] For reference parameters, indicates that a value should be created to be used for the input if none is linked via BP. |
| HideAssetPicker | [FunctionMetadata] Forcibly hide the asset picker for pins matching any parameter names in this piece of metadata. |
| BlueprintInternalUseOnly | [FunctionMetadata] This function is an internal implementation detail, used to implement another function or node. It is never directly exposed in a graph. |
| BlueprintProtected | [FunctionMetadata] This function is only accessible from within its class and derived classes. |
| CallableWithoutWorldContext | [FunctionMetadata] Used for BlueprintCallable functions that have a WorldContext pin to indicate that the function can be called even if the class does not implement the virtual function GetWorld(). |
| CommutativeAssociativeBinaryOperator | [FunctionMetadata] Indicates that a BlueprintCallable function should use the Commutative Associative Binary node. |
| CompactNodeTitle | [FunctionMetadata] Indicates that a BlueprintCallable function should display in the compact display mode and the name to use in that mode. |
| CustomStructureParam | [FunctionMetadata] Used with CustomThunk to declare that a parameter is actually polymorphic |
| DefaultToSelf | [FunctionMetadata] For BlueprintCallable functions indicates that the object property named's default value should be the self context of the node |
| DeprecatedFunction | [FunctionMetadata] This function is deprecated, any blueprint references to it cause a compilation warning. |
| ExpandEnumAsExecs | [ClassMetadata] [FunctionMetadata] Used in conjunction with DeprecatedNode or DeprecatedFunction to customize the warning message displayed to the user. |
| ExpandBoolAsExecs | Synonym for ExpandEnumAsExecs. |
| ScriptMethod | [ClassMetadata] [PropertyMetadata] [FunctionMetadata] The name to display for this class, property, or function instead of auto-generating it from the name. |
| ScriptMethodSelfReturn | [FunctionMetadata] Used with ScriptMethod to denote that the return value of the function should overwrite the value of the instance that made the call (structs only, equivalent to using UPARAM(ref) on the struct argument). |
| ScriptMethodMutable | [FunctionMetadata] Used with ScriptMethod to denote that the first argument of the function should be considered mutable even if passed as a const reference (structs only, equivalent to using UPARAM(ref) on the struct argument). |
| ScriptOperator | [FunctionMetadata] Flags a static function taking a struct as its first argument so that it "hoists" the function to be an operator of the struct when exporting it to a scripting language. |
| ScriptConstant | [FunctionMetadata] Flags a static function returning a value so that it "hoists" the function to be a constant of its host type when exporting it to a scripting language. |
| ScriptConstantHost | [FunctionMetadata] Used with ScriptConstant to override the host type for a constant. Should be the name of a struct or class with no prefix, eg) Vector2D or Actor |
| HidePin | [FunctionMetadata] For BlueprintCallable functions indicates that the parameter pin should be hidden from the user's view. |
| HideSpawnParms | [FunctionMetadata] For some functions used by async task nodes, specify this parameter should be skipped when exposing pins |
| Keywords | [FunctionMetadata] For BlueprintCallable functions provides additional keywords to be associated with the function for search purposes. |
| Latent | [FunctionMetadata] Indicates that a BlueprintCallable function is Latent |
| LatentInfo | [FunctionMetadata] For Latent BlueprintCallable functions indicates which parameter is the LatentInfo parameter |
| MaterialParameterCollectionFunction | [FunctionMetadata] For BlueprintCallable functions indicates that the material override node should be used |
| NativeBreakFunc | [FunctionMetadata] For BlueprintCallable functions indicates that the function should be displayed the same as the implicit Break Struct nodes |
| NativeMakeFunc | [FunctionMetadata] For BlueprintCallable functions indicates that the function should be displayed the same as the implicit Make Struct nodes |
| UnsafeDuringActorConstruction | [FunctionMetadata] Used by BlueprintCallable functions to indicate that this function is not to be allowed in the Construction Script. |
| WorldContext | [FunctionMetadata] Used by BlueprintCallable functions to indicate which parameter is used to determine the World that the operation is occurring within. |
| BlueprintAutocast | [FunctionMetadata] Used only by static BlueprintPure functions from BlueprintLibrary. A cast node will be automatically added for the return type and the type of the first parameter of the function. |
| NotBlueprintThreadSafe | [FunctionMetadata] Only valid in Blueprint Function Libraries. Mark this function as an exception to the class's general BlueprintThreadSafe metadata. |
| DeterminesOutputType | [FunctionMetadata] [InterfaceMetadata] Metadata that flags function params that govern what type of object the function returns |
| DynamicOutputParam | [FunctionMetadata] [InterfaceMetadata] Metadata that flags the function output param that will be controlled by the "MD_DynamicOutputType" pin |
| DataTablePin | [FunctionMetadata][InterfaceMetadata] Metadata to identify an DataTable Pin. Depending on which DataTable is selected, we display different RowName options |
| SetParam | [FunctionMetadata][InterfaceMetadata] Metadata that flags TSet parameters that will have their type determined at blueprint compile time |
| MapParam | [FunctionMetadata] [InterfaceMetadata] Metadata that flags TMap function parameters that will have their type determined at blueprint compile time |
| MapKeyParam | [FunctionMetadata] [InterfaceMetadata] Metadata that flags TMap function parameters that will have their key type determined at blueprint compile time |
| MapValueParam | [FunctionMetadata][InterfaceMetadata] Metadata that flags TMap function parameter that will have their value type determined at blueprint compile time |
| Bitmask | [FunctionMetadata] [InterfaceMetadata] Metadata that identifies an integral property as a bitmask. |
| BitmaskEnum | [FunctionMetadata] [InterfaceMetadata] Metadata that associates a bitmask property with a bitflag enum. |
| Bitflags | [InterfaceMetadata] Metadata that identifies an enum as a set of explicitly-named bitflags. |
| UseEnumValuesAsMaskValuesInEditor | [InterfaceMetadata] Metadata that signals to the editor that enum values correspond to mask values instead of bitshift (index) values. |
| AnimBlueprintFunction | [InterfaceMetadata] Stub function used internally by animation blueprints |
| ArrayParam | [FunctionMetadata] [InterfaceMetadata] Metadata that flags TArray function parameters that will have their type determined at blueprint compile time |
Remarks
Metadata usable in UFUNCTION.