1. Epic GamesDeveloper
  3. USmartObjectComponent

USmartObjectComponent

API > API/Plugins > API/Plugins/SmartObjectsModule

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

Syntax

UCLASS (MinimalAPI, Blueprintable, ClassGroup=Gameplay, Meta=(BlueprintSpawnableComponent),  
       Config=Game,  
       HideCategories=(Activation, AssetUserData, Collision, Cooking, HLOD, Lighting, LOD, Mobile, Mobility, Navigation, Physics, RayTracing, Rendering, Tags, TextureStreaming))  
class USmartObjectComponent : public USceneComponent

Inheritance Hierarchy

Implements Interfaces

Constructors

Name Remarks Include Path Unreal Specifiers

USmartObjectComponent ( const FObjectInitializer& ObjectInitializer
)

   SmartObjectComponent.h  

Typedefs

Name Type Remarks Include Path
FOnSmartObjectChanged TMulticastDelegate_OneParam< void, const USmartObjectComponent & >   SmartObjectComponent.h
FOnSmartObjectComponentChanged TMulticastDelegate_OneParam< void, TNotNull< const USmartObjectComponent * > >   SmartObjectComponent.h

Constants

Name Type Remarks Include Path
OnSmartObjectChanged PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnSmartObjectChanged   SmartObjectComponent.h
OnSmartObjectComponentChanged FOnSmartObjectComponentChanged   SmartObjectComponent.h

Variables

Protected

Name Type Remarks Include Path Unreal Specifiers
bDeprecationApplied bool Flag to keep track of the deprecation status of the object SmartObjectComponent.h  
CachedDefinitionAssetVariation TObjectPtr< USmartObjectDefinition >   SmartObjectComponent.h
  • Transient
  • Category=SmartObject
  • BlueprintSetter=SetDefinition
  • BlueprintGetter=GetDefinition
  • Meta=(DisplayName="Definition Asset")
OnSavingDefinitionDelegateHandle FDelegateHandle   SmartObjectComponent.h  

Functions

Public

Name Remarks Include Path Unreal Specifiers

const USmartObjectDefinition * GetBaseDefinition()

   SmartObjectComponent.h  

bool GetCanBePartOfCollection()

   SmartObjectComponent.h  

FGuid GetComponentGuid()

 Returns this component Guid SmartObjectComponent.h  

const USmartObjectDefinition * GetDefinition()

   SmartObjectComponent.h
  • BlueprintGetter

const FSmartObjectDefinitionReference & GetDefinitionReference()

   SmartObjectComponent.h  

FSmartObjectDefinitionReference & GetMutableDefinitionReference()

   SmartObjectComponent.h  

FSmartObjectComponentEventNativeSignature & GetOnSmartObjectEventNative()

   SmartObjectComponent.h  

FSmartObjectHandle GetRegisteredHandle()

   SmartObjectComponent.h  

ESmartObjectRegistrationType GetRegistrationType()

   SmartObjectComponent.h  

FBox GetSmartObjectBounds()

   SmartObjectComponent.h  

void InvalidateRegisteredHandle()

   SmartObjectComponent.h  
Returns true if the Smart Object component is registered to the Smart Object subsystem. SmartObjectComponent.h
  • BlueprintCallable
  • Category="SmartObject"

bool IsSmartObjectEnabled()

 Returns the enabled state of the smart object regardless of the disabled reason. SmartObjectComponent.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Is SmartObject Enabled (for any reason)", ReturnDisplayName="Enabled")

bool IsSmartObjectEnabledForReason ( FGameplayTag ReasonTag
) const

 Returns the enabled state of the smart object based on a specific reason. SmartObjectComponent.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Is SmartObject Enabled (for specific reason)", ReturnDisplayName="Enabled")

void OnRuntimeInstanceBound ( FSmartObjectRuntime& RuntimeInstance
)

   SmartObjectComponent.h  

void OnRuntimeInstanceUnbound ( FSmartObjectRuntime& RuntimeInstance
)

   SmartObjectComponent.h  

void SetDefinition ( USmartObjectDefinition* DefinitionAsset
)

 Sets the Smart Object Definition. SmartObjectComponent.h
  • BlueprintSetter

void SetRegisteredHandle ( const FSmartObjectHandle Value,
const ESmartObjectRegistrationType InRegistrationType
)

   SmartObjectComponent.h  

bool SetSmartObjectEnabled ( const bool bEnable
) const

 Enables or disables the smart object using the default reason (i.e. Gameplay). SmartObjectComponent.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Set SmartObject Enabled (default reason: Gameplay)", ReturnDisplayName="Status changed")

bool SetSmartObjectEnabledForReason ( FGameplayTag ReasonTag,
const bool bEnabled
) const

 Enables or disables the smart object for the specified reason. SmartObjectComponent.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Set SmartObject Enabled (specific reason)", ReturnDisplayName="Status changed")

void ValidateGUIDForDeprecation()

 Conditionally updates the GUID if it was never set. Used for collection deprecation only. SmartObjectComponent.h  

Protected

Name Remarks Include Path Unreal Specifiers

void OnRuntimeEventReceived ( const FSmartObjectEventData& Event
)

   SmartObjectComponent.h  

void ReceiveOnEvent ( const FSmartObjectEventData& EventData,
const AActor* Interactor
)

   SmartObjectComponent.h
  • BlueprintImplementableEvent
  • Category=SmartObject
  • Meta=(DisplayName="OnSmartObjectEventReceived")

void RegisterToSubsystem()

   SmartObjectComponent.h  

void UnregisterFromSubsystem ( const ESmartObjectUnregistrationType UnregistrationType
)

   SmartObjectComponent.h  

Overridden from UActorComponent

Name Remarks Include Path Unreal Specifiers

virtual void BeginPlay()

   SmartObjectComponent.h  

virtual void EndPlay ( const EEndPlayReason::Type EndPlayReason
)

   SmartObjectComponent.h  

virtual TStructOnScope< FActorComponentInstanceData > GetComponentInstanceData()

   SmartObjectComponent.h  

virtual void OnRegister()

   SmartObjectComponent.h  

virtual void OnUnregister()

   SmartObjectComponent.h  

Overridden from UObject

Name Remarks Include Path Unreal Specifiers

virtual void GetLifetimeReplicatedProps ( TArray< FLifetimeProperty >& OutLifetimeProps
) const

   SmartObjectComponent.h  

virtual void PostDuplicate ( EDuplicateMode::Type DuplicateMode
)

   SmartObjectComponent.h  

virtual void PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

   SmartObjectComponent.h  

virtual void PostEditImport()

   SmartObjectComponent.h  

virtual void PostEditUndo()

   SmartObjectComponent.h  

virtual void PostInitProperties()

   SmartObjectComponent.h  

virtual void PreSave ( FObjectPreSaveContext SaveContext
)

   SmartObjectComponent.h  

virtual void Serialize ( FArchive& Ar
)

   SmartObjectComponent.h  

Static

Name Remarks Include Path Unreal Specifiers

static PRAGMA_DISABLE_DEPRECATION_WARNINGSFOnSmartObjectChanged & GetOnSmartObjectChanged()

   SmartObjectComponent.h  

static FOnSmartObjectComponentChanged & GetOnSmartObjectComponentChanged()

   SmartObjectComponent.h  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page