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&40;BlueprintType, Blueprintable, CollapseCategories&41;  
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 FSmartObjectSlotDefinition & Adds and returns a reference to a defaulted slot (used for testing purposes)
Protected function Const int32

FindSlotByID ( const FGuid ID
)

  
Public function Const 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 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 FBox Return bounds encapsulating all slots
Public function FWorldConditionQueryDefinition &  
Public function 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 const FSmartObjectSlotDefinition &

GetSlot ( const int32 Index
)

  
Public function Const 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 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 TConstArrayView< FSmartObjectSlotDefinition >  
Public function Const FTransform

GetSlotWorldTransform ( const int32 SlotIndex,
const FTransform& OwnerTransform
)

 Returns the transform (in world space) of the given slot index.
Public function Const const FGameplayTagQuery & Returns the tag query to run on the user tags provided by a request to accept this definition
Public function Const 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 TOptional< bool >

IsValid ()

 Returns result of the last validation if `Validate_ was called; unset otherwise.
Public function Const bool

IsValidSlotIndex ( const int32 SlotIndex
)

  
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 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 void  
Public function Const bool

Validate ( TArray< FText >* ErrorsToReport
)

 Performs validation for the current definition.

Overridden from UObject

  Type Name Description
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 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 Use ObjectActorClass in PreviewData instead.
Public variable UProperty FSoftObjectPath PreviewMeshPath_DEPRECATED Use ObjectMeshPath in PreviewData instead.

Deprecated Functions

  Type Name Description
Public function Const const FGameplayTagQuery & Use FWorldCondition_SmartObjectActorTagQuery or FSmartObjectWorldConditionObjectTagQuery in Preconditions instead.
Public function Const PRAGMA_DISABLE_DEPRECATION_WARNINGSTOptional< FTransform >

GetSlotTransform ( const FTransform& OwnerTransform,
const FSmartObjectSlotIndex SlotIndex
)

 Please use GetSlotWorldTransform() instead.
Public function void

SetObjectTagFilter ( const FGameplayTagQuery& InObjectTagFilter
)

 Use FWorldCondition_SmartObjectActorTagQuery or FSmartObjectWorldConditionObjectTagQuery in Preconditions instead.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page