AdvancedDisplay="Parameter1, Parameter2, .."
|
The comma-separated list of parameters will show up as advanced pins (requiring UI expansion).
|
AdvancedDisplay=N
|
Replace N with a number, and all parameters after the Nth will show up as advanced pins (requiring UI expansion). E.g. 'AdvancedDisplay=2' will mark all but the first two parameters as advanced).
|
ArrayParm="Parameter1, Parameter2, .."
|
Indicates that a BlueprintCallable function should use a Call Array Function node and that the listed parameters should be treated as wild card array properties.
|
ArrayTypeDependentParams="Parameter"
|
When ArrayParm is used, this specifier indicates one parameter which will determine the types of all parameters in the ArrayParm list.
|
AutoCreateRefTerm="Parameter1, Parameter2, .."
|
The listed parameters, although passed by reference, will have an automatically-created default if their pins are left disconnected. This is a convenience feature for Blueprints.
|
BlueprintAutocast
|
Used only by static BlueprintPure functions from a Blueprint Function Library. A Cast node will be automatically added for the return type and the type of the first parameter of the function.
|
BlueprintInternalUseOnly
|
This function is an internal implementation detail, used to implement another function or node. It is never directly exposed in a Blueprint Graph.
|
BlueprintProtected
|
This function can only be called on the owning Object in a Blueprint. It cannot be called on another instance.
|
CallableWithoutWorldContext
|
Used for BlueprintCallable functions that have a WorldContext pin to indicate that the function can be called even if its class does not implement the GetWorld function.
|
CommutativeAssociativeBinaryOperator
|
Indicates that a BlueprintCallable function should use the Commutative Associative Binary node. This node lacks pin names, but features an "Add Pin" button that creates additional input pins.
|
CompactNodeTitle="Name"
|
Indicates that a BlueprintCallable function should display in the compact display mode, and provides the name to display in that mode.
|
CustomStructureParam="Parameter1, Parameter2, .."
|
The listed parameters are all treated as wildcards. This specifier requires the UFUNCTION -level specifier, CustomThunk , which will require the user to provide a custom exec function. In this function, the parameter types can be checked and the appropriate function calls can be made based on those parameter types. The base UFUNCTION should never be called, and should assert or log an error if it is.
To declare a custom exec function, use the syntax DECLARE_FUNCTION(execMyFunctionName) where MyFunctionName is the name of the original function.
|
DefaultToSelf
|
For BlueprintCallable functions, this indicates that the Object property's named default value should be the self context of the node.
|
DeprecatedFunction
|
Any Blueprint references to this function will cause compilation warnings telling the user that the function is deprecated. You can add to the deprecation warning message (e.g. to provide instructions on replacing the deprecated function) using the DeprecationMessage metadata specifier.
|
DeprecationMessage ="Message Text"
|
If the function is deprecated, this message will be added to the standard deprecation warning when trying to compile a Blueprint that uses it.
|
DevelopmentOnly
|
Functions marked as DevelopmentOnly will only run in Development mode. This is useful for functionality like debug output, which is expected not to exist in shipped products.
|
DisplayName="Blueprint Node Name"
|
The name of this node in a Blueprint will be replaced with the value provided here, instead of the code-generated name.
|
ExpandEnumAsExecs="Parameter"
|
For BlueprintCallable functions, this indicates that one input execution pin should be created for each entry in the enum used by the parameter. That the named parameter must be of an enumerated type recognized by the Engine via the UENUM tag.
|
HidePin="Parameter"
|
For BlueprintCallable functions, this indicates that the parameter pin should be hidden from the user's view. Note that only one parameter pin per function can be hidden in this manner.
|
HideSelfPin
|
Hides the "self" pin, which is used to indicate the object on which the function is being called. The "self" pin is automatically hidden on BlueprintPure functions that are compatible with the calling Blueprint's class. This is generally used with the DefaultToSelf specifier.
|
InternalUseParam="Parameter"
|
Similar to HidePin , this hides the named parameter's pin from the user's view, and can only be used for one parameter per function.
|
KeyWords="Set Of Keywords"
|
Specifies a set of keywords that can be used when searching for this function, such as when placing a node to call the function in a Blueprint Graph.
|
Latent
|
Indicates a latent action. Latent actions have one parameter of type FLatentActionInfo , and this parameter is named by the LatentInfo specifier.
|
LatentInfo="Parameter"
|
For Latent BlueprintCallable functions indicates which parameter is the LatentInfo parameter.
|
MaterialParameterCollectionFunction
|
For BlueprintCallable functions, indicates that the material override node should be used.
|
NativeBreakFunc
|
For BlueprintCallable functions, indicates that the function should be displayed the same way as a standard Break Struct node.
|
NotBlueprintThreadSafe
|
Only valid in Blueprint Function Libraries. This function will be treated as an exception to the owning class's general BlueprintThreadSafe metadata.
|
ShortToolTip="Short tool tip"
|
A short tooltip that is used in some contexts where the full tooltip might be overwhelming, such as the parent class picker dialog.
|
ToolTip="Hand-written tool tip"
|
Overrides the automatically generated tooltip from code comments.
|
UnsafeDuringActorConstruction
|
This function is not safe to call during Actor construction.
|
WorldContext="Parameter"
|
Used by BlueprintCallable functions to indicate which parameter determines the World that the operation is occurring within.
|