Navigation
API > API/Runtime > API/Runtime/CoreUObject > API/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;
AllowAbstract,
AllowAnyActor,
AllowedClasses,
AllowPreserveRatio,
AllowPrivateAccess,
ArrayClamp,
AssetBundles,
BlueprintBaseOnly,
BlueprintCompilerGeneratedDefaults,
ClampMin,
ClampMax,
ConfigHierarchyEditable,
ContentDir,
Delta,
DeprecatedProperty,
DisallowedAssetDataTags,
DisallowedClasses,
DisplayAfter,
DisplayPriority,
DisplayThumbnail,
EditCondition,
EditConditionHides,
EditFixedOrder,
ExactClass,
ExposeFunctionCategories,
ExposeOnSpawn,
FilePathFilter,
RelativeToGameDir,
FixedIncrement,
ForceShowEngineContent,
ForceShowPluginContent,
HideAlphaChannel,
HideInDetailPanel,
HideViewOptions,
IgnoreForMemberInitializationTest,
InlineEditConditionToggle,
LinearDeltaSensitivity,
LongPackageName,
MakeEditWidget,
MakeStructureDefaultValue,
MetaClass,
MustImplement,
Multiple,
MaxLength,
MultiLine,
PasswordField,
NoElementDuplicate,
NoResetToDefault,
NoEditInline,
NoSpinbox,
OnlyPlaceable,
RelativePath,
RelativeToGameContentDir,
RequiredAssetDataTags,
ScriptNoExport,
ShowOnlyInnerProperties,
ShowTreeView,
SliderExponent,
TitleProperty,
UIMin,
UIMax,
Units,
ForceUnits,
Untracked,
DevelopmentOnly,
NeedsLatentFixup,
LatentCallbackTarget,
GetOptions,
PinHiddenByDefault,
ValidEnumValues,
InvalidEnumValues,
&125;
}
Values
| Name | Description |
|---|---|
| AllowAbstract | [PropertyMetadata] Used for Subclass and SoftClass properties. Indicates whether abstract class types should be shown in the class picker. |
| AllowAnyActor | [PropertyMetadata] Used for ComponentReference properties. Indicates whether other actor that are not in the property outer hierarchy should be shown in the component picker. |
| AllowedClasses | [PropertyMetadata] Used for FSoftObjectPath, ComponentReference and UClass properties. Comma delimited list that indicates the class type(s) of assets to be displayed in the asset picker(FSoftObjectPath) or component picker or class viewer (UClass). |
| AllowPreserveRatio | [PropertyMetadata] Used for FVector properties. It causes a ratio lock to be added when displaying this property in details panels. |
| AllowPrivateAccess | [PropertyMetadata] Indicates that a private member marked as BluperintReadOnly or BlueprintReadWrite should be accessible from blueprints |
| ArrayClamp | [PropertyMetadata] Used for integer properties. Clamps the valid values that can be entered in the UI to be between 0 and the length of the array specified. |
| AssetBundles | [PropertyMetadata] Used for SoftObjectPtr/SoftObjectPath properties. Comma separated list of Bundle names used inside PrimaryDataAssets to specify which bundles this reference is part of |
| BlueprintBaseOnly | [PropertyMetadata] Used for Subclass and SoftClass properties. Indicates whether only blueprint classes should be shown in the class picker. |
| BlueprintCompilerGeneratedDefaults | [PropertyMetadata] Property defaults are generated by the Blueprint compiler and will not be copied when CopyPropertiesForUnrelatedObjects is called post-compile. |
| ClampMin | [PropertyMetadata] Used for float and integer properties. Specifies the minimum value that may be entered for the property. |
| ClampMax | [PropertyMetadata] Used for float and integer properties. Specifies the maximum value that may be entered for the property. |
| ConfigHierarchyEditable | [PropertyMetadata] Property is serialized to config and we should be able to set it anywhere along the config hierarchy. |
| ContentDir | [PropertyMetadata] Used by FDirectoryPath properties. Indicates that the path will be picked using the Slate-style directory picker inside the game Content dir. |
| Delta | [PropertyMetadata] Used for float and integer properties. Specifies the step size when the slider is used (e.g. for Delta = 10, the value will scroll among steps of 10). |
| DeprecatedProperty | [PropertyMetadata] This property is deprecated, any blueprint references to it cause a compilation warning. |
| DisallowedAssetDataTags | [ClassMetadata] [PropertyMetadata] [FunctionMetadata] Used in conjunction with DeprecatedNode, DeprecatedProperty, or DeprecatedFunction to customize the warning message displayed to the user. |
| DisallowedClasses | [PropertyMetadata] Used for FSoftObjectPath, ActorComponentReference and UClass properties. Comma delimited list that indicates the class type(s) of assets that will NOT be displayed in the asset picker (FSoftObjectPath) or component picker or class viewer (UClass). |
| DisplayAfter | [PropertyMetadata] Indicates that the property should be displayed immediately after the property named in the metadata. |
| DisplayPriority | [PropertyMetadata] The relative order within its category that the property should be displayed in where lower values are sorted first.. |
| DisplayThumbnail | [PropertyMetadata] Indicates that the property is an asset type and it should display the thumbnail of the selected asset. |
| EditCondition | [PropertyMetadata] Specifies a boolean property that is used to indicate whether editing of this property is disabled. |
| EditConditionHides | [PropertyMetadata] Specifies a boolean property that is used to indicate whether this property should be hidden when the EditCondition evaluates to false. Requires an EditCondition to be set. |
| EditFixedOrder | [PropertyMetadata] Keeps the elements of an array from being reordered by dragging |
| ExactClass | [PropertyMetadata] Used for FSoftObjectPath properties in conjunction with AllowedClasses. Indicates whether only the exact classes specified in AllowedClasses can be used or whether subclasses are valid. |
| ExposeFunctionCategories | [PropertyMetadata] Specifies a list of categories whose functions should be exposed when building a function list in the Blueprint Editor. |
| ExposeOnSpawn | [PropertyMetadata] Specifies whether the property should be exposed on a Spawn Actor for the class type. |
| FilePathFilter | [PropertyMetadata] Used by FFilePath properties. Indicates the path filter to display in the file picker. |
| RelativeToGameDir | [PropertyMetadata] Used by FFilePath properties. Indicates that the FilePicker dialog will output a path relative to the game directory when setting the property. An absolute path will be used when outside the game directory. |
| FixedIncrement | [PropertyMetadata] Deprecated. |
| ForceShowEngineContent | [PropertyMetadata] Used by asset properties. Indicates that the asset pickers should always show engine content |
| ForceShowPluginContent | [PropertyMetadata] Used by asset properties. Indicates that the asset pickers should always show plugin content |
| HideAlphaChannel | [PropertyMetadata] Used for FColor and FLinearColor properties. Indicates that the Alpha property should be hidden when displaying the property widget in the details. |
| HideInDetailPanel | [PropertyMetadata] Indicates that the property should be hidden in the details panel. Currently only used by events. |
| HideViewOptions | [PropertyMetadata] Used for Subclass and SoftClass properties. Specifies to hide the ability to change view options in the class picker |
| IgnoreForMemberInitializationTest | [PropertyMetadata] Used for bypassing property initialization tests when the property cannot be safely tested in a deterministic fashion. Example: random numbers, guids, etc. |
| InlineEditConditionToggle | [PropertyMetadata] Signifies that the bool property is only displayed inline as an edit condition toggle in other properties, and should not be shown on its own row. |
| LinearDeltaSensitivity | [PropertyMetadata] Somewhat misleading name (because a higher value is less sensitive), but maps directly to the LinearDeltaSensitivity parameter in sliders created for float and integer properties. |
| LongPackageName | [ClassMetadata] [PropertyMetadata] Used by TObjectPtr properties. Allows the referenced object to be eager/lazy/background loaded in editor. |
| MakeEditWidget | [PropertyMetadata] Used for Transform/Rotator properties (also works on arrays of them). Indicates that the property should be exposed in the viewport as a movable widget. |
| MakeStructureDefaultValue | [PropertyMetadata] For properties in a structure indicates the default value of the property in a blueprint make structure node. |
| MetaClass | [PropertyMetadata] Used FSoftClassPath properties. Indicates the parent class that the class picker will use when filtering which classes to display. |
| MustImplement | [PropertyMetadata] Used for Subclass and SoftClass properties. Indicates the selected class must implement a specific interface |
| Multiple | [PropertyMetadata] Used for numeric properties. Stipulates that the value must be a multiple of the metadata value. |
| MaxLength | [PropertyMetadata] Used for FString and FText properties. Indicates the maximum length of the value that can be edited, or <=0 for unlimited. |
| MultiLine | [PropertyMetadata] Used for FString and FText properties. Indicates that the edit field should be multi-line, allowing entry of newlines. |
| PasswordField | [PropertyMetadata] Used for FString and FText properties. Indicates that the edit field is a secret field (e.g a password) and entered text will be replaced with dots. Do not use this as your only security measure. The property data is still stored as plain text. |
| NoElementDuplicate | [PropertyMetadata] Used for array properties. Indicates that the duplicate icon should not be shown for entries of this array in the property panel. |
| NoResetToDefault | [PropertyMetadata] Property wont have a 'reset to default' button when displayed in property windows |
| NoEditInline | [PropertyMetadata] Object properties pointing to an UObject instance whos class is marked editinline will not show their properties inline in property windows. Useful for getting actor components to appear in the component tree but not inline in the root actor details panel. |
| NoSpinbox | [PropertyMetadata] Used for integer and float properties. Indicates that the spin box element of the number editing widget should not be displayed. |
| OnlyPlaceable | [PropertyMetadata] Used for Subclass properties. Indicates whether only placeable classes should be shown in the class picker. |
| RelativePath | [PropertyMetadata] Used by FDirectoryPath properties. Indicates that the directory dialog will output a relative path when setting the property. |
| RelativeToGameContentDir | [PropertyMetadata] Used by FDirectoryPath properties. Indicates that the directory dialog will output a path relative to the game content directory when setting the property. |
| RequiredAssetDataTags | [PropertyMetadata] Used by asset properties. Filters out asset that do not have matching data registry tags, RowStructure=NameOfDataTableRow could be used to restrict data tables. |
| ScriptNoExport | [PropertyMetadata] [FunctionMetadata] Flag set on a property or function to prevent it being exported to a scripting language. |
| ShowOnlyInnerProperties | [PropertyMetadata] Used by struct properties. Indicates that the inner properties will not be shown inside an expandable struct, but promoted up a level. |
| ShowTreeView | [PropertyMetadata] Used for Subclass and SoftClass properties. Shows the picker as a tree view instead of as a list |
| SliderExponent | [PropertyMetadata] Used by numeric properties. Indicates how rapidly the value will grow when moving an unbounded slider. |
| TitleProperty | [PropertyMetadata] Used by arrays of structs. Indicates a single property inside of the struct that should be used as a title summary when the array entry is collapsed. |
| UIMin | [PropertyMetadata] Used for float and integer properties. Specifies the lowest that the value slider should represent. |
| UIMax | [PropertyMetadata] Used for float and integer properties. Specifies the highest that the value slider should represent. |
| Units | [PropertyMetadata] Used on any numeric property to declare the internal units for a property. |
| ForceUnits | [PropertyMetadata] Used instead of 'Units' metadata to forcibly show a property in a fixed unit, without locale or other conversion |
| Untracked | [PropertyMetadata] Used for SoftObjectPtr/SoftObjectPath properties to specify a reference should not be tracked. This reference will not be automatically cooked or saved into the asset registry for redirector/delete fixup. |
| DevelopmentOnly | [PropertyMetadata] For functions that should be compiled in development mode only. |
| NeedsLatentFixup | [PropertyMetadata] (Internal use only) Used for the latent action manager to fix up a latent action with the VM |
| LatentCallbackTarget | [PropertyMetadata] (Internal use only) Used for the latent action manager to track where it's re-entry should be |
| GetOptions | TArray |
| PinHiddenByDefault | [PropertyMetadata] The property can be exposed as a data pin, but is hidden by default. |
| ValidEnumValues | [PropertyMetadata] Used for enum properties to define the subset of valid values as a comma-separated string; values outside of this subset are not made available. |
| InvalidEnumValues | [PropertyMetadata] Used for enum properties to define the subset of invalid values as a comma-separated string; values within this subset are not made available. |
Remarks
Metadata usable in UPROPERTY.