FPlaceableItem

Structure defining a placeable item in the placement mode panel

Windows
MacOS
Linux

References

Module

PlacementMode

Header

/Engine/Source/Editor/PlacementMode/Public/IPlacementModeModule.h

Include

#include "IPlacementModeModule.h"

Syntax

struct FPlaceableItem

Remarks

Structure defining a placeable item in the placement mode panel

Variables

Name Description

Public variable

FAssetData

 

AssetData

Asset data pertaining to the class

Public variable

TOptional< FLin...

 

AssetTypeColorOverride

Optional overridden color tint for the asset

Public variable

bool

 

bAlwaysUseGenericThumbnail

Whether to always use the generic thumbnail for this item or not

Public variable

FName

 

ClassThumbnailBrushOverride

Optional override for the thumbnail brush (passed to FClassIconFinder::FindThumbnailForClass in the form ClassThumbnail.)

Public variable

FText

 

DisplayName

This item's display name

Public variable

UActorFactory &...

 

Factory

The factory used to create an instance of this placeable item

Public variable

FString

 

NativeName

This item's native name

Public variable

TOptional< int3...

 

SortOrder

Optional sort order (lowest first). Overrides default class name sorting.

Constructors

Name Description

Public function

FPlaceableItem()

Default constructor

Public function

FPlaceableItem

(
    UClass& InAssetClass,
    TOptional< int32 > InSortOrder
)

Constructor for any placeable class

Public function

FPlaceableItem

(
    UActorFactory* InFactory,
    const FAssetData& InAssetData,
    TOptional< int32 > InSortOrder
)

Constructor that takes a specific factory and asset

Public function

FPlaceableItem

(
    UClass& InAssetClass,
    const FAssetData& InAssetData,
    FName InClassThumbnailBrushOverride,
    TOptional< FLinearColor > InAssetTy...,
    TOptional< int32 > InSortOrder,
    TOptional< FText > InDisplayName
)

Constructor for any placeable class with associated asset data, brush and display name overrides

Functions

Name Description

Public function

void

 

AutoSetNativeAndDisplayName()

Automatically set this item's native and display names from its class or asset

Public function Const

FName

 

GetNativeFName()

Return NativeName as an FName (and cache it)

Deprecated Functions

Name Description

Public function

void

 

AutoSetDisplayName()

Use AutoSetNativeAndDisplayName instead

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