UDocumentation UE5.7 10.02.2026 (Source)
API documentation for Unreal Engine 5.7
FActorPrimitiveColorHandler Class Reference

#include <ActorPrimitiveColorHandler.h>

Classes

struct  FPrimitiveColorHandler
 

Public Member Functions

UE_API FActorPrimitiveColorHandler ()
 
UE_API void RegisterPrimitiveColorHandler (FPrimitiveColorHandler &PrimitiveColorHandler)
 
UE_API void RegisterPrimitiveColorHandler (FName InHandlerName, const FText &InHandlerText, const FGetColorFunc &InHandlerFunc, const FActivateFunc &InActivateFunc=DefaultFunc, const FText &InHandlerToolTipText=FText())
 
UE_API void RegisterPrimitiveColorHandler (FName InHandlerName, const FText &InHandlerText, bool bInAvailalbleInEditor, const FGetColorFunc &InHandlerFunc, const FActivateFunc &InActivateFunc=DefaultFunc, const FText &InHandlerToolTipText=FText())
 
UE_API void UnregisterPrimitiveColorHandler (FName InHandlerName)
 
UE_API void GetRegisteredPrimitiveColorHandlers (TArray< FPrimitiveColorHandler > &OutPrimitiveColorHandlers) const
 
UE_API FName GetActivePrimitiveColorHandler () const
 
UE_API bool SetActivePrimitiveColorHandler (FName InHandlerName, UWorld *InWorld)
 
UE_API FText GetActivePrimitiveColorHandlerDisplayName () const
 
UE_API void RefreshPrimitiveColorHandler (FName InHandlerName, UWorld *InWorld)
 
UE_API void RefreshPrimitiveColorHandler (FName InHandlerName, const TArray< AActor * > &InActors)
 
UE_API void RefreshPrimitiveColorHandler (FName InHandlerName, const TArray< UPrimitiveComponent * > &InPrimitiveComponents)
 
UE_API FLinearColor GetPrimitiveColor (const UPrimitiveComponent *InPrimitiveComponent) const
 

Static Public Member Functions

static UE_API FActorPrimitiveColorHandlerGet ()
 

Detailed Description

FActorPrimitiveColorHandler is a simple mechanism for custom actor coloration registration. Once an actor color handler is registered, it can automatically be activated with the SHOW ACTORCOLORATION <HANDLERNAME> command.

Constructor & Destructor Documentation

◆ FActorPrimitiveColorHandler()

FActorPrimitiveColorHandler::FActorPrimitiveColorHandler ( )

Member Function Documentation

◆ Get()

FActorPrimitiveColorHandler & FActorPrimitiveColorHandler::Get ( )
static

◆ GetActivePrimitiveColorHandler()

FName FActorPrimitiveColorHandler::GetActivePrimitiveColorHandler ( ) const

◆ GetActivePrimitiveColorHandlerDisplayName()

FText FActorPrimitiveColorHandler::GetActivePrimitiveColorHandlerDisplayName ( ) const

◆ GetPrimitiveColor()

FLinearColor FActorPrimitiveColorHandler::GetPrimitiveColor ( const UPrimitiveComponent *  InPrimitiveComponent) const

◆ GetRegisteredPrimitiveColorHandlers()

void FActorPrimitiveColorHandler::GetRegisteredPrimitiveColorHandlers ( TArray< FPrimitiveColorHandler > &  OutPrimitiveColorHandlers) const

◆ RefreshPrimitiveColorHandler() [1/3]

void FActorPrimitiveColorHandler::RefreshPrimitiveColorHandler ( FName  InHandlerName,
const TArray< AActor * > &  InActors 
)

◆ RefreshPrimitiveColorHandler() [2/3]

void FActorPrimitiveColorHandler::RefreshPrimitiveColorHandler ( FName  InHandlerName,
const TArray< UPrimitiveComponent * > &  InPrimitiveComponents 
)

◆ RefreshPrimitiveColorHandler() [3/3]

void FActorPrimitiveColorHandler::RefreshPrimitiveColorHandler ( FName  InHandlerName,
UWorld InWorld 
)

◆ RegisterPrimitiveColorHandler() [1/3]

void FActorPrimitiveColorHandler::RegisterPrimitiveColorHandler ( FName  InHandlerName,
const FText InHandlerText,
bool  bInAvailalbleInEditor,
const FGetColorFunc InHandlerFunc,
const FActivateFunc InActivateFunc = DefaultFunc,
const FText InHandlerToolTipText = FText() 
)

◆ RegisterPrimitiveColorHandler() [2/3]

void FActorPrimitiveColorHandler::RegisterPrimitiveColorHandler ( FName  InHandlerName,
const FText InHandlerText,
const FGetColorFunc InHandlerFunc,
const FActivateFunc InActivateFunc = DefaultFunc,
const FText InHandlerToolTipText = FText() 
)

◆ RegisterPrimitiveColorHandler() [3/3]

void FActorPrimitiveColorHandler::RegisterPrimitiveColorHandler ( FActorPrimitiveColorHandler::FPrimitiveColorHandler PrimitiveColorHandler)

◆ SetActivePrimitiveColorHandler()

bool FActorPrimitiveColorHandler::SetActivePrimitiveColorHandler ( FName  InHandlerName,
UWorld InWorld 
)

◆ UnregisterPrimitiveColorHandler()

void FActorPrimitiveColorHandler::UnregisterPrimitiveColorHandler ( FName  InHandlerName)

The documentation for this class was generated from the following files: