1. Epic GamesDeveloper
  3. USmartObjectComponent

USmartObjectComponent

API > API/Plugins > API/Plugins/SmartObjectsModule

Inheritance Hierarchy

References

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

Syntax

UCLASS (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

Variables

  Type Name Description
Protected variable UProperty Category, EditAnywhere, AdvancedDisplay Config bool bCanBePartOfCollection Controls whether a given SmartObject can be aggregated in SmartObjectPersistentCollections.
Protected variable UProperty Category, EditAnywhere, Meta Replicated FSmartObjectDefinitionReference DefinitionRef Reference to Smart Object Definition Asset with parameters.
Protected variable FDelegateHandle EventDelegateHandle  
Protected variable friend FSmartObjectComponentInstanceData  
Protected variable UProperty Category, Meta BlueprintAssignable FSmartObjectComponentEventSignature OnSmartObjectEvent  
Protected variable FSmartObjectComponentEventNativeSignature OnSmartObjectEventNative Native version of OnSmartObjectEvent.
Protected variable UProperty Category BlueprintReadOnly Transient, Replicated visibleanywhere FSmartObjectHandle RegisteredHandle RegisteredHandle != FSmartObjectHandle::Invalid when registered into a collection by SmartObjectSubsystem
Protected variable ESmartObjectRegistrationType RegistrationType  

Constructors

  Type Name Description
Public function  

USmartObjectComponent ( const FObjectInitializer& ObjectInitializer
)

  

Functions

  Type Name Description
Public function Const const USmartObjectDefinition *  
Public function Const bool  
Public function Const UFunction blueprintgetter const USmartObjectDefinition *  
Public function Static FOnSmartObjectChanged &  
Public function FSmartObjectComponentEventNativeSignature &  
Public function Const FSmartObjectHandle  
Public function Const ESmartObjectRegistrationType  
Public function Const FBox  
Public function void  
Public function Const UFunction BlueprintCallable, Category bool Returns true if the Smart Object component is registered to the Smart Object subsystem.
Public function Const UFunction BlueprintCallable, Category, Meta bool Returns the enabled state of the smart object regardless of the disabled reason.
Public function Const UFunction BlueprintCallable, Category, Meta bool Returns the enabled state of the smart object based on a specific reason.
Protected function void  
Public function void  
Public function void  
Protected function UFunction Category, Meta, BlueprintImplementableEvent void

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

  
Protected function void  
Public function UFunction blueprintsetter void

SetDefinition ( USmartObjectDefinition* DefinitionAsset
)

 Sets the Smart Object Definition.
Public function void

SetRegisteredHandle ( const FSmartObjectHandle Value,
const ESmartObjectRegistrationType InRegistrationType
)

  
Public function Const UFunction BlueprintCallable, Category, Meta bool

SetSmartObjectEnabled ( const bool bEnable
)

 Enables or disables the smart object using the default reason (i.e. Gameplay).
Public function Const UFunction BlueprintCallable, Category, Meta bool

SetSmartObjectEnabledForReason ( FGameplayTag ReasonTag,
const bool bEnabled
)

 Enables or disables the smart object for the specified reason.
Protected function void  

Overridden from UActorComponent

  Type Name Description
Protected function Virtual void Begins Play for the component.
Protected function Virtual void

EndPlay ( const EEndPlayReason::Type EndPlayReason
)

 Ends gameplay for this component.
Protected function Virtual Const TStructOnScope< FActorComponentInstanceData > Called before we throw away components during RerunConstructionScripts, to cache any data we wish to persist across that operation
Protected function Virtual void Called when a component is registered, after Scene is set, but before CreateRenderState_Concurrent or OnCreatePhysicsState are called.
Protected function Virtual void Called when a component is unregistered.

Overridden from UObject

  Type Name Description
Protected function Virtual Const void Returns properties that are replicated for the lifetime of the actor channel
Protected function Virtual void

PostEditChangeProperty ( FPropertyChangedEvent& PropertyChangedEvent
)

 Called when a property on this object has been modified externally
Protected function Virtual void Called after applying a transaction to the object.
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 Handles reading, writing, and reference collecting using FArchive.

Typedefs

Name Description
FOnSmartObjectChanged  

Constants

Name Description
OnSmartObjectChanged  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page