UF::

Valid keywords for the UFUNCTION and UDELEGATE macros

Windows
MacOS
Linux

References

Module

CoreUObject

Header

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

Include

#include "UObject/ObjectMacros.h"

Syntax

namespace UF
{
    enum
    {
        BlueprintImplementableEvent,
        BlueprintNativeEvent,
        SealedEvent,
        Exec,
        Server,
        Client,
        NetMulticast,
        Reliable,
        Unreliable,
        BlueprintPure,
        BlueprintCallable,
        BlueprintGetter,
        BlueprintSetter,
        BlueprintAuthorityOnly,
        BlueprintCosmetic,
        BlueprintInternalUseOnly,
        CallInEditor,
        CustomThunk,
        Category,
        WithValidation,
        ServiceRequest,
        ServiceResponse,
        Variadic,
        ReturnDisplayName,
        InternalUseParam,
    }
}

Values

Name

Description

BlueprintImplementableEvent

This function is designed to be overridden by a blueprint.

BlueprintNativeEvent

This function is designed to be overridden by a blueprint, but also has a native implementation.

SealedEvent

This function is sealed and cannot be overridden in subclasses.

Exec

This function is executable from the command line.

Server

This function is replicated, and executed on servers.

Client

This function is replicated, and executed on clients.

NetMulticast

This function is both executed locally on the server and replicated to all clients, regardless of the Actor's NetOwner.

Reliable

Replication of calls to this function should be done on a reliable channel.

Unreliable

Replication of calls to this function can be done on an unreliable channel.

BlueprintPure

This function fulfills a contract of producing no side effects, and additionally implies BlueprintCallable.

BlueprintCallable

This function can be called from blueprint code and should be exposed to the user of blueprint editing tools.

BlueprintGetter

This function is used as the get accessor for a blueprint exposed property. Implies BlueprintPure and BlueprintCallable.

BlueprintSetter

This function is used as the set accessor for a blueprint exposed property. Implies BlueprintCallable.

BlueprintAuthorityOnly

This function will not execute from blueprint code if running on something without network authority.

BlueprintCosmetic

This function is cosmetic and will not run on dedicated servers.

BlueprintInternalUseOnly

Indicates that a Blueprint exposed function should not be exposed to the end user.

CallInEditor

This function can be called in the editor on selected instances via a button in the details panel.

CustomThunk

The UnrealHeaderTool code generator will not produce a execFoo thunk for this function; it is up to the user to provide one.

Category

Specifies the category of the function when displayed in blueprint editing tools.

WithValidation

This function must supply a _Validate implementation.

ServiceRequest

This function is RPC service request.

ServiceResponse

This function is RPC service response.

Variadic

[FunctionMetadata] Marks a UFUNCTION as accepting variadic arguments.

ReturnDisplayName

[FunctionMetadata] Indicates the display name of the return value pin

InternalUseParam

[FunctionMetadata] Indicates that a particular function parameter is for internal use only, which means it will be both hidden and not connectible.

Remarks

Valid keywords for the UFUNCTION and UDELEGATE macros

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