1. Epic GamesDeveloper
  3. USmartObjectDefinition

USmartObjectDefinition

SmartObject definition asset.

API > API/Plugins > API/Plugins/SmartObjectsModule

Inheritance Hierarchy

References

   
Module SmartObjectsModule
Header /Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/Public/SmartObjectDefinition.h
Include #include "SmartObjectDefinition.h"

Syntax

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

Remarks

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

Variables

  Type Name Description
Public variable UProperty FSmartObjectDefinitionPreviewData PreviewData Actor class used for previewing the user in the asset editor.

Constructors

  Type Name Description
Public function  

USmartObjectDefinition ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function bool  
Public function void

AddPropertyBinding ( const FPropertyBindingPath& SourcePath,
const FPropertyBindingPath& TargetPath
)

  
Public function Static bool

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

  
Public function FSmartObjectSlotDefinition & Adds and returns a reference to a defaulted slot (used for testing purposes)
Public function Const bool

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

 Returns slot and definition data indices the ID represents.
Public function Const int32

FindSlotByID ( const FGuid ID
)

  
Public function void

GetAccessibleStructs ( const FGuid TargetStructID,
TArray< FBindableStructDesc >& OutStructDescs
)

  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category const FGameplayTagContainer & Returns the list of tags describing the activity associated to this definition
Public function Const ESmartObjectTagMergingPolicy Returns the tag merging policy to apply on Activity tags from this definition
Public function USmartObjectDefinition * Returns a variation of this asset with specified parameters applied.
Public function Const const USmartObjectBehaviorDefinition *

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

 Retrieves a specific type of behavior definition for a given slot.
Public function Const UFunction BlueprintCallable, Category FBox Return bounds encapsulating all slots
Protected function FSmartObjectDefinitionDataHandle

GetDataHandleByID ( const FGuid StructID
)

  
Public function Const FGuid  
Public function bool

GetDataViewByID ( const FGuid StructID,
FPropertyBindingDataView& OutDataView
)

  
Public function Const const FInstancedPropertyBag &  
Public function Const const T & Returns a reference to the definition data of the specified type.
Public function Const const T * Returns a pointer to the definition data of the specified type.
Public function FWorldConditionQueryDefinition &  
Public function UFunction BlueprintCallable, BlueprintPure, Category FSmartObjectSlotDefinition &

GetMutableSlot ( const int32 Index
)

  
Public function TArrayView< FSmartObjectSlotDefinition > Returns a view on all the slot definitions
Public function Const const FWorldConditionQueryDefinition &  
Public function Const TSubclassOf< USmartObjectSlotValidationFilter >  
Public function const FPropertyBindingPath *  
Public function Const const FSmartObjectSlotDefinition &

GetSlot ( const int32 Index
)

  
Public function Const void

GetSlotActivityTags ( const FSmartObjectSlotDefinition& SlotDefinition,
FGameplayTagContainer& OutActivityTags
)

 Fills the provided GameplayTagContainer with the activity tags associated to the slot according to the tag merging policy.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta void

GetSlotActivityTags ( const int32 SlotIndex,
FGameplayTagContainer& OutActivityTags
)

 Fills the provided GameplayTagContainer with the activity tags associated to the slot according to the tag merging policy.
Public function Const TConstArrayView< FSmartObjectSlotDefinition >  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category FTransform

GetSlotWorldTransform ( const int32 SlotIndex,
const FTransform& OwnerTransform
)

 Returns the transform (in world space) of the given slot index.
Public function bool

GetStructDescByID ( const FGuid StructID,
FBindableStructDesc& OutDesc
)

  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category const FGameplayTagQuery & Returns the tag query to run on the user tags provided by a request to accept this definition
Public function Const UFunction BlueprintCallable, BlueprintPure, Category ESmartObjectTagFilteringPolicy Returns the tag filtering policy that should be applied on User tags by this definition
Public function Const const USmartObjectWorldConditionSchema *  
Public function Const const TSubclassOf< USmartObjectWorldConditionSchema > &  
Public function Const bool Indicates if 'Validate' was called.
Public function Const bool Indicates the result of the last validation if 'Validate' was called.
Public function Const TOptional< bool >

IsValid ()

 Returns result of the last validation if `Validate_ was called; unset otherwise.
Public function Const UFunction BlueprintCallable, BlueprintPure, Category bool

IsValidSlotIndex ( const int32 SlotIndex
)

  
Public function Const UFunction BlueprintCallable, BlueprintPure, Category, Meta const TArray< FSmartObjectSlotDefinition > &  
Public function void  
Public function void

SetActivityTags ( const FGameplayTagContainer& InActivityTags
)

 Sets the list of tags describing the activity associated to this definition
Public function void

SetActivityTagsMergingPolicy ( const ESmartObjectTagMergingPolicy InActivityTagsMergingPolicy
)

 Sets the tag merging policy to apply on Activity tags from this definition
Public function UFunction BlueprintCallable, Category void

SetUserTagFilter ( const FGameplayTagQuery& InUserTagFilter
)

 Sets the tag query to run on the user tags provided by a request to accept this definition
Public function void

SetUserTagsFilteringPolicy ( const ESmartObjectTagFilteringPolicy InUserTagsFilteringPolicy
)

 Sets the tag filtering policy to apply on User tags by this definition
Protected function bool  
Protected function void  
Protected function void  
Public function Const bool

Validate ( TArray< FText >* ErrorsToReport
)

 Performs validation for the current definition.

Overridden from UObject

  Type Name Description
Protected function Virtual void Collect any save override state.
Public function Virtual Const void Gathers a list of asset registry searchable tags which are name/value pairs with some type information This only needs to be implemented for asset objects
Protected function Virtual Const EDataValidationResult Generic function to validate objects during changelist validations, etc.
Protected function Virtual void This alternate version of PostEditChange is called when properties inside structs are modified.
Protected function Virtual void Called after the C++ constructor and after the properties have been initialized, including those loaded from config.
Protected function Virtual void Do any object-specific cleanup required immediately after loading an object.
Protected function Virtual void

PreSave ( FObjectPreSaveContext SaveContext
)

 Presave function.

Deprecated Variables

  Type Name Description
Public variable UProperty TSoftClassPtr< AActor > PreviewClass_DEPRECATED Actor class used for previewing the definition in the asset editor.
Public variable UProperty FSoftObjectPath PreviewMeshPath_DEPRECATED Path of the static mesh used for previewing the definition in the asset editor.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page