1. Epic GamesDeveloper
  3. UPersonaOptions

UPersonaOptions

API > API/Editor > API/Editor/UnrealEd

   
Name UPersonaOptions
Type class
Header File /Engine/Source/Editor/UnrealEd/Classes/Preferences/PersonaOptions.h
Include Path #include "Preferences/PersonaOptions.h"

Syntax

UCLASS (HideCategories=Object, Config=EditorPerProjectUserSettings, MinimalAPI)  
class UPersonaOptions : public UObject

Inheritance Hierarchy

Constructors

Name Remarks Include Path Unreal Specifiers

UPersonaOptions ( const FObjectInitializer& ObjectInitializer
)

   Preferences/PersonaOptions.h  

Typedefs

Name Type Remarks Include Path
FOnIsClassAllowed TBaseDelegate_OneParam< bool, const UClass * >   Preferences/PersonaOptions.h
FOnIsPropertyAllowed TBaseDelegate_OneParam< bool, const FProperty * >   Preferences/PersonaOptions.h
FOnUpdateSettingsMulticaster TMulticastDelegate_TwoParams< void, const UPersonaOptions *, EPropertyChangeType::Type >   Preferences/PersonaOptions.h

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
AffectedBoneColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
AnimationCurveGroupingDelimiters FString Delimiters to split animation curve names for grouping Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Timeline"
AssetEditorOptions TArray< FAssetEditorOptions > Options that should be unique per asset editor (like skeletal mesh or anim sequence editors) Preferences/PersonaOptions.h
  • Config
bAllowIncompatibleSkeletonSelection bool Whether to allow animation assets that are incompatible with the current skeleton/skeletal mesh to be selected. Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Assets"
bAllowMeshSectionSelection bool Whether or not Skeletal Mesh Section selection should be enabled by default for the Animation Editor(s) Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Mesh"
bAllowPreviewMeshCollectionsToSelectFromDifferentSkeletons bool   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Preview Scene|AdditionalMesh"
bAllowPreviewMeshCollectionsToUseCustomAnimBP bool   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Preview Scene|AdditionalMesh"
bAlwaysOpenAnimationAssetsInNewTab uint32 Whether or not the Animation Editor opens in an additional tab when double clicking an animation asset or if it reuses an already existing Animation Editor tab. Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Assets"
bAutoAlignFloorToMesh uint32 Whether or not the floor should be aligned to the Skeletal Mesh's bounds by default for the Animation Editor(s) Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Preview Scene"
bExpandTreeOnSelection bool Whether to focus and expand an item's tree recursively based on selection Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Skeleton Tree"
bExposeClothingSceneElementMenu bool   Preferences/PersonaOptions.h  
bExposeNotifiesUICommands bool   Preferences/PersonaOptions.h  
bFlattenSkeletonHierarchyWhenFiltering bool Whether to keep the hierarchy or flatten it when searching for bones, sockets etc. Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Skeleton Tree"
bHideParentsWhenFiltering bool Whether to hide parent items when filtering or to display them grayed out Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Skeleton Tree"
bHighlightOrigin uint32 Whether or not the XYZ axis at the origin should be highlighted on the grid by default Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
bMuteAudio uint32 Whether or not audio should be muted by default for the Animation Editor(s) Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Audio"
bPauseAnimationOnCameraMove bool Pause the preview animation if playing when moving the camera and resume when finished Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
BranchingPointTimingNodeColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Composites and Montages"
bShowBoneColors bool If true then the bones are displayed with multiple semi-random colors Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
bShowBoneIndexes bool Whether to append each bone's index to its name when shown in the skeleton tree Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Skeleton Tree"
bShowGrid uint32 Whether or not the grid should be visible by default for the Animation Editor(s) Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
bTimelineDisplayCurveKeys bool Whether to display keys in the timeline's curve tracks Preferences/PersonaOptions.h
  • Config
bTimelineDisplayFormatSecondary bool Whether to display secondary format (times/frames) in the anim timeline Preferences/PersonaOptions.h
  • Config
bTimelineDisplayPercentage bool Whether to display percentage in the anim timeline Preferences/PersonaOptions.h
  • Config
bUseInlineSocketEditor bool Whether to use a socket editor that is created in-line inside the skeleton tree, or whether to use the separate details panel Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Skeleton Tree"
bUseTreeViewForAnimationCurves bool Whether to use tree view for animation curves Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Timeline"
CurveEditorSnapInterval float Snap value used to determine scrub resolution of the curve timeline Preferences/PersonaOptions.h
  • Config
DefaultBoneColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
DefaultBoneDrawSelection uint32 Index used to determine which Bone Draw Mode should be used by default for the Animation Editor(s) Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
DefaultLocalAxesSelection uint32 Index used to determine which ViewMode should be used by default for the Animation Editor(s) Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
DisabledBoneColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
NotifyTimingNodeColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Composites and Montages"
NumFolderFiltersInAssetBrowser uint32 The number of folder filters to allow at any one time in the animation tool's asset browser Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Asset Browser"
  • Meta=(ClampMin="1", ClampMax="10", UIMin="1", UIMax="10")
OnSettingsChange FOnUpdateSettingsMulticaster   Preferences/PersonaOptions.h  
ParentOfSelectedBoneColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
SectionTimingNodeColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Composites and Montages"
SelectedBoneColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
ShowMeshStats int32 Currently Stats can have None, Basic and Detailed. Please refer to EDisplayInfoMode. Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"
  • Meta=(ClampMin="0", ClampMax="3", UIMin="0", UIMax="3")
TimelineDisplayFormat EFrameNumberDisplayFormats Display format for the anim timeline Preferences/PersonaOptions.h
  • Config
TimelineEnabledSnaps TArray< FName > Whether to snap to various things Preferences/PersonaOptions.h
  • Config
TimelineScrubSnapValue int32 Snap value used to determine scrub resolution of the anim timeline Preferences/PersonaOptions.h
  • Config
VirtualBoneColor FLinearColor   Preferences/PersonaOptions.h
  • EditAnywhere
  • Config
  • Category="Viewport"

Protected

Name Type Remarks Include Path Unreal Specifiers
AllowedAnimationEditorTracks FNamePermissionList   Preferences/PersonaOptions.h  
OnIsClassAllowedDelegate FOnIsClassAllowed   Preferences/PersonaOptions.h  
OnIsPropertyAllowedDelegate FOnIsPropertyAllowed   Preferences/PersonaOptions.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

FNamePermissionList & GetAllowedAnimationEditorTracks()

   Preferences/PersonaOptions.h  

bool GetAllowIncompatibleSkeletonSelection()

   Preferences/PersonaOptions.h  

FAssetEditorOptions & GetAssetEditorOptions ( const FName& InContext
)

   Preferences/PersonaOptions.h  

bool IsAllowedClass ( const UClass* InClass
) const

 Returns whether or not the supplied class can be used in the current editor context. Preferences/PersonaOptions.h  

bool IsAllowedProperty ( const FProperty* InProperty
) const

 Returns whether or not the supplied properties can be used in the current editor context. Preferences/PersonaOptions.h  

FDelegateHandle RegisterOnUpdateSettings ( const FOnUpdateSettingsMulticaster::FDelegate& Delegate
)

   Preferences/PersonaOptions.h  

void SetAllowIncompatibleSkeletonSelection ( bool bState
)

   Preferences/PersonaOptions.h  

void SetAutoAlignFloorToMesh ( bool bInAutoAlignFloorToMesh
)

   Preferences/PersonaOptions.h  

void SetBranchingPointTimingNodeColor ( const FLinearColor& InColor
)

   Preferences/PersonaOptions.h  

void SetCameraSpeed ( FName InContext,
int32 InCameraSpeed,
int32 InViewportIndex
)

   Preferences/PersonaOptions.h  

void SetCameraSpeedScalar ( FName InContext,
float InCameraSpeedScalar,
int32 InViewportIndex
)

   Preferences/PersonaOptions.h  

void SetCameraSpeedSettings ( FName InContext,
const FEditorViewportCameraSpeedSettings& SpeedSettings,
int32 InViewportIndex
)

   Preferences/PersonaOptions.h  

void SetDefaultBoneDrawSelection ( uint32 InDefaultBoneAxesSelection
)

   Preferences/PersonaOptions.h  

void SetDefaultLocalAxesSelection ( uint32 InDefaultLocalAxesSelection
)

   Preferences/PersonaOptions.h  

void SetHighlightOrigin ( bool bInHighlightOrigin
)

   Preferences/PersonaOptions.h  

void SetMuteAudio ( bool bInMuteAudio
)

   Preferences/PersonaOptions.h  

void SetNotifyTimingNodeColor ( const FLinearColor& InColor
)

   Preferences/PersonaOptions.h  

void SetOnIsClassAllowed ( const FOnIsClassAllowed& InOnIsClassAllowed
)

 Sets a delegate that allows external code to restrict which features can be used within the Persona editor by filtering which classes are allowed. Preferences/PersonaOptions.h  

void SetOnIsPropertyAllowed ( const FOnIsPropertyAllowed& InOnIsPropertyAllowed
)

 Sets a delegate that allows external code to restrict which features can be used within the Persona editor by filtering which properties are allowed. Preferences/PersonaOptions.h  

void SetSectionTimingNodeColor ( const FLinearColor& InColor
)

   Preferences/PersonaOptions.h  

void SetShowGrid ( bool bInShowGrid
)

   Preferences/PersonaOptions.h  

void SetShowMeshStats ( int32 InShowMeshStats
)

   Preferences/PersonaOptions.h  

void SetViewCameraFollow ( FName InContext,
EAnimationViewportCameraFollowMode InCameraFollowMode,
FName InCameraFollowBoneName,
int32 InViewportIndex
)

   Preferences/PersonaOptions.h  

void SetViewFOV ( FName InContext,
float InViewFOV,
int32 InViewportIndex
)

   Preferences/PersonaOptions.h  

void SetViewModeIndex ( FName InContext,
EViewModeIndex InViewModeIndex,
int32 InViewportIndex
)

   Preferences/PersonaOptions.h  

void UnregisterOnUpdateSettings ( FDelegateHandle Object
)

   Preferences/PersonaOptions.h  

Protected

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   Preferences/PersonaOptions.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page