1. Epic GamesDeveloper
  3. USmartObjectDefinition

USmartObjectDefinition

SmartObject definition asset.

API > API/Plugins > API/Plugins/SmartObjectsModule

SmartObject definition asset. Contains sharable information that can be used by multiple SmartObject instances at runtime.

   
Name USmartObjectDefinition
Type class
Header File /Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/Public/SmartObjectDefinition.h
Include Path #include "SmartObjectDefinition.h"

Syntax

UCLASS (MinimalAPI, BlueprintType, Blueprintable, CollapseCategories)  
class USmartObjectDefinition :  
    public UDataAsset ,  
    public IPropertyBindingBindingCollectionOwner

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

USmartObjectDefinition ( const FObjectInitializer& ObjectInitializer
)

   SmartObjectDefinition.h  

Structs

Name Remarks
FSmartObjectDefinitionAssetVariation Used internally by USmartObjectDefinition to store a variation of a definition asset.

Variables

Public

Name Type Remarks Include Path Unreal Specifiers
PreviewData FSmartObjectDefinitionPreviewData Actor class used for previewing the user in the asset editor. SmartObjectDefinition.h
  • EditDefaultsOnly
  • BlueprintReadWrite
  • Category="SmartObject"

Protected

Name Type Remarks Include Path Unreal Specifiers
ActivityTags FGameplayTagContainer Tags identifying this Smart Object's use case. SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
ActivityTagsMergingPolicy ESmartObjectTagMergingPolicy Indicates how Tags from slots and parent object are combined to be evaluated by a TagQuery from a find request. SmartObjectDefinition.h
  • EditAnywhere
  • Category="SmartObject"
  • AdvancedDisplay
  • Meta=(NoBinding)
BindingCollection FSmartObjectBindingCollection Property bindings. SmartObjectDefinition.h
  • VisibleAnywhere
  • Category="SmartObject"
  • AdvancedDisplay
bValid TOptional< bool >   SmartObjectDefinition.h  
DefaultBehaviorDefinitions TArray< TObjectPtr< USmartObjectBehaviorDefinition > > List of behavior definitions of different types provided to SO's user if the slot does not provide one. SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
  • Instanced
DefinitionData TArray< FSmartObjectDefinitionDataProxy > Custom definition data items (struct inheriting from SmartObjectDefinitionData) for the whole Smart Object. SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
  • Meta=(DisallowedStructs="/Script/SmartObjectsModule.SmartObjectSlotAnnotation")
FSmartObjectBindingCollection friend   SmartObjectDefinition.h  
ObjectTagFilter FGameplayTagQuery This object is available if instance tags match this query; always available if query is empty. SmartObjectDefinition.h
  • Meta=(DeprecatedProperty, DeprecationMessage="Use FWorldCondition_SmartObjectActorTagQuery or FSmartObjectWorldConditionObjectTagQuery in Preconditions instead.")
Parameters FInstancedPropertyBag Parameters for the SmartObject definition SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
  • Meta=(NoBinding)
ParametersID FGuid Binding ID for the parameters. SmartObjectDefinition.h  
Preconditions FWorldConditionQueryDefinition Preconditions that must pass for the object to be found/used. SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
  • Meta=(NoBinding)
RootID FGuid Binding ID for the whole asset. SmartObjectDefinition.h  
Slots TArray< FSmartObjectSlotDefinition > Where SmartObject's user needs to stay to be able to activate it. SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
UserTagFilter FGameplayTagQuery This object is available if user tags match this query; always available if query is empty. SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
UserTagsFilteringPolicy ESmartObjectTagFilteringPolicy Indicates how TagQueries from slots and parent object will be processed against User Tags from a find request. SmartObjectDefinition.h
  • EditAnywhere
  • Category="SmartObject"
  • AdvancedDisplay
  • Meta=(NoBinding)
Variations TArray< FSmartObjectDefinitionAssetVariation > Variations of the asset based on provided parameters, created on demand via GetAssetVariation(). SmartObjectDefinition.h  
WorldConditionSchemaClass TSubclassOf< USmartObjectWorldConditionSchema >   SmartObjectDefinition.h
  • EditDefaultsOnly
  • Category="SmartObject"
  • AdvancedDisplay
  • Meta=(NoBinding)

Functions

Public

Name Remarks Include Path Unreal Specifiers

FSmartObjectSlotDefinition & DebugAddSlot()

 Adds and returns a reference to a defaulted slot (used for testing purposes) SmartObjectDefinition.h  

bool FindSlotAndDefinitionDataIndexByID ( const FGuid ID,
int32& OutSlotIndex,
int32& OutDefinitionDataIndex
) const

 Returns slot and definition data indices the ID represents. SmartObjectDefinition.h  

int32 FindSlotByID ( const FGuid ID
) const

   SmartObjectDefinition.h  

const FGameplayTagContainer & GetActivityTags()

 Returns the list of tags describing the activity associated to this definition SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"

ESmartObjectTagMergingPolicy GetActivityTagsMergingPolicy()

 Returns the tag merging policy to apply on Activity tags from this definition SmartObjectDefinition.h  
Returns a variation of this asset with specified parameters applied. SmartObjectDefinition.h  
  SmartObjectDefinition.h  

const USmartObjectBehaviorDefinition * GetBehaviorDefinition ( const int32 SlotIndex,
const TSubclassOf< USmartObjectBehaviorDefinition >& DefinitionClass
) const

 Retrieves a specific type of behavior definition for a given slot. SmartObjectDefinition.h  

FBox GetBounds()

 Return bounds encapsulating all slots SmartObjectDefinition.h
  • BlueprintCallable
  • Category="SmartObject"

const FInstancedPropertyBag & GetDefaultParameters()

   SmartObjectDefinition.h  

const T & GetDefinitionData ()

 Returns a reference to the definition data of the specified type. SmartObjectDefinition.h  

const T * GetDefinitionDataPtr ()

 Returns a pointer to the definition data of the specified type. SmartObjectDefinition.h  

FWorldConditionQueryDefinition & GetMutablePreconditions()

   SmartObjectDefinition.h  

FSmartObjectSlotDefinition & GetMutableSlot ( const int32 Index
)

   SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"

TArrayView< FSmartObjectSlotDefinition > GetMutableSlots()

 Returns a view on all the slot definitions SmartObjectDefinition.h  

const FWorldConditionQueryDefinition & GetPreconditions()

   SmartObjectDefinition.h  

TSubclassOf< USmartObjectSlotValidationFilter > GetPreviewValidationFilterClass()

   SmartObjectDefinition.h  

const FSmartObjectSlotDefinition & GetSlot ( const int32 Index
) const

   SmartObjectDefinition.h  

void GetSlotActivityTags ( const FSmartObjectSlotDefinition& SlotDefinition,
FGameplayTagContainer& OutActivityTags
) const

 Fills the provided GameplayTagContainer with the activity tags associated to the slot according to the tag merging policy. SmartObjectDefinition.h  

void GetSlotActivityTags ( const int32 SlotIndex,
FGameplayTagContainer& OutActivityTags
) const

 Fills the provided GameplayTagContainer with the activity tags associated to the slot according to the tag merging policy. SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"
  • Meta=(DisplayName="Get Slot Activity Tags (By Index)", ScriptName="GetSlotActivityTagsByIndex", AutoCreateRefTerm="OutActivityTags")

TConstArrayView< FSmartObjectSlotDefinition > GetSlots()

   SmartObjectDefinition.h  

FTransform GetSlotWorldTransform ( const int32 SlotIndex,
const FTransform& OwnerTransform
) const

 Returns the transform (in world space) of the given slot index. SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"

const FGameplayTagQuery & GetUserTagFilter()

 Returns the tag query to run on the user tags provided by a request to accept this definition SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"

ESmartObjectTagFilteringPolicy GetUserTagsFilteringPolicy()

 Returns the tag filtering policy that should be applied on User tags by this definition SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"

const USmartObjectWorldConditionSchema * GetWorldConditionSchema()

   SmartObjectDefinition.h  

const TSubclassOf< USmartObjectWorldConditionSchema > & GetWorldConditionSchemaClass()

   SmartObjectDefinition.h  
Indicates if 'Validate' was called. SmartObjectDefinition.h  
Indicates the result of the last validation if 'Validate' was called. SmartObjectDefinition.h  

TOptional< bool > IsValid()

 Returns result of the last validation if `Validate_ was called; unset otherwise. SmartObjectDefinition.h  

bool IsValidSlotIndex ( const int32 SlotIndex
) const

   SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"

const TArray< FSmartObjectSlotDefinition > & K2_GetSlots()

   SmartObjectDefinition.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"
  • Meta=(DisplayName="Get Smart Object Slot Definitions")

void SetActivityTags ( const FGameplayTagContainer& InActivityTags
)

 Sets the list of tags describing the activity associated to this definition SmartObjectDefinition.h  

void SetActivityTagsMergingPolicy ( const ESmartObjectTagMergingPolicy InActivityTagsMergingPolicy
)

 Sets the tag merging policy to apply on Activity tags from this definition SmartObjectDefinition.h  

void SetUserTagFilter ( const FGameplayTagQuery& InUserTagFilter
)

 Sets the tag query to run on the user tags provided by a request to accept this definition SmartObjectDefinition.h
  • BlueprintCallable
  • Category="SmartObject"

void SetUserTagsFilteringPolicy ( const ESmartObjectTagFilteringPolicy InUserTagsFilteringPolicy
)

 Sets the tag filtering policy to apply on User tags by this definition SmartObjectDefinition.h  

bool Validate ( TArray< TPair< EMessageSeverity::Type, FText > >* ErrorsToReport
) const

 Performs validation for the current definition. SmartObjectDefinition.h  

bool Validate ( TArray< FText >* ErrorsToReport
) const

   SmartObjectDefinition.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetAssetRegistryTags ( FAssetRegistryTagsContext Context
) const

   SmartObjectDefinition.h  

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   SmartObjectDefinition.h  

Protected

Name Remarks Include Path Unreal Specifiers

FSmartObjectDefinitionDataHandle GetDataHandleByID ( const FGuid StructID
)

   SmartObjectDefinition.h  

bool UpdateAndValidatePath ( FPropertyBindingPath& Path
) const

 Updates a single path and returns whether it is still valid. SmartObjectDefinition.h  

void UpdateBindingPaths()

 Updates the path for all bindings from the associated value and remove invalid ones. SmartObjectDefinition.h  

void UpdateSlotReferences()

   SmartObjectDefinition.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void CollectSaveOverrides ( FObjectCollectSaveOverridesContext SaveContext
)

   SmartObjectDefinition.h  

virtual void GetPreloadDependencies ( TArray< UObject* >& OutDeps
)

   SmartObjectDefinition.h  

virtual EDataValidationResult IsDataValid ( FDataValidationContext& Context
) const

   SmartObjectDefinition.h  

virtual void PostEditChangeChainProperty ( FPropertyChangedChainEvent& PropertyChangedEvent
)

   SmartObjectDefinition.h  

virtual void PostInitProperties()

   SmartObjectDefinition.h  

virtual void PostLoad()

   SmartObjectDefinition.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   SmartObjectDefinition.h  

virtual void Serialize ( FArchive& Ar
)

   SmartObjectDefinition.h  

Overridden from IPropertyBindingBindingCollectionOwner

Name Remarks Include Path Unreal Specifiers

virtual void CreateParametersForStruct ( const FGuid InStructID,
TArrayView< UE::PropertyBinding::FPropertyCreationDescriptor > InOutCreationDescs
)

   SmartObjectDefinition.h  

virtual bool GetBindableStructByID ( const FGuid InStructID,
TInstancedStruct< FPropertyBindingBindableStructDescriptor >& OutDesc
) const

   SmartObjectDefinition.h  

virtual void GetBindableStructs ( const FGuid InTargetStructID,
TArray< TInstancedStruct< FPropertyBindingBindableStructDescriptor > >& OutStructDescs
) const

   SmartObjectDefinition.h  

virtual bool GetBindingDataView ( const FPropertyBindingBinding& InBinding,
EBindingSide InSide,
FPropertyBindingDataView& OutDataView
)

   SmartObjectDefinition.h  

virtual bool GetBindingDataViewByID ( const FGuid InStructID,
FPropertyBindingDataView& OutDataView
) const

   SmartObjectDefinition.h  
  SmartObjectDefinition.h  
  SmartObjectDefinition.h  

virtual FGuid GetFallbackStructID()

   SmartObjectDefinition.h  

virtual void OnPropertyBindingChanged ( const FPropertyBindingPath& InSourcePath,
const FPropertyBindingPath& InTargetPath
)

   SmartObjectDefinition.h  

Static

Name Remarks Include Path Unreal Specifiers

static bool ArePropertiesCompatible ( const FProperty* SourceProperty,
const FProperty* TargetProperty
)

   SmartObjectDefinition.h  

static const USmartObjectBehaviorDefinition * GetBehaviorDefinitionByType ( const TArray< USmartObjectBehaviorDefinition* >& BehaviorDefinitions,
const TSubclassOf< USmartObjectBehaviorDefinition >& DefinitionClass
)

 Finds first behavior definition of a given class in the provided list of definitions. SmartObjectDefinition.h  

static uint64 GetVariationParametersHash ( const FInstancedPropertyBag& Parameters
)

 Calculates hash of the parameters. SmartObjectDefinition.h  

Deprecated Variables

Name Type Remarks Include Path Unreal Specifiers
PreviewClass_DEPRECATED TSoftClassPtr< AActor > Actor class used for previewing the definition in the asset editor. SmartObjectDefinition.h  
PreviewMeshPath_DEPRECATED FSoftObjectPath Path of the static mesh used for previewing the definition in the asset editor. SmartObjectDefinition.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page