1. Epic GamesDeveloper
  3. USmartObjectBlueprintFunctionLibrary

USmartObjectBlueprintFunctionLibrary

API > API/Plugins > API/Plugins/SmartObjectsModule

Inheritance Hierarchy

References

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

Syntax

UCLASS (Meta=(ScriptName="SmartObjectLibrary"))  
class USmartObjectBlueprintFunctionLibrary : public UBlueprintFunctionLibrary

Functions

  Type Name Description
Public function Static UFunction BlueprintCallable, Category, Meta bool

AddMultipleSmartObjects ( const TArray< AActor* >& SmartObjectActors
)

 Adds to the simulation all smart objects for multiple actors.
Public function Static UFunction BlueprintCallable, Category, Meta bool

AddOrRemoveMultipleSmartObjects ( const TArray< AActor* >& SmartObjectActors,
const bool bAdd
)

 Adds to the simulation all smart objects for multiple actors or removes them according to 'bAdd'.
Public function Static UFunction BlueprintCallable, Category, Meta bool

AddOrRemoveSmartObject ( UPARAM(DisplayName="SmartObjectActor") AActor* SmartObject,
UPARAM(DisplayName="bAdd") const bool bEnabled
)

 Adds to the simulation all smart objects for an actor or removes them according to 'bAdd'.
Public function Static UFunction BlueprintCallable, Category, Meta bool

AddSmartObject ( AActor* SmartObjectActor
)

 Adds to the simulation all smart objects for an actor.
Public function Static UFunction BlueprintPure, Category, Meta FString Converts a SmartObjectClaimHandle value to a string
Public function Static UFunction BlueprintPure, Category, Meta FString Converts a SmartObjectDefinition value to a string
Public function Static UFunction BlueprintPure, Category, Meta FString FSmartObjectHandle operators Converts a SmartObjectHandle value to a string
Public function Static UFunction BlueprintPure, Category, Meta FString Converts a SmartObjectRequestResult value to a string
Public function Static UFunction BlueprintPure, Category, Meta FString FSmartObjectSlotHandle operators Converts a SmartObjectSlotHandle value to a string
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if SmartObjectHandle A is equal to SmartObjectHandle B (A == B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if SmartObjectSlotHandle A is equal to SmartObjectSlotHandle B (A == B)
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

FindSmartObjectsInActor ( const FSmartObjectRequestFilter& Filter,
AActor* SearchActor,
TArray< FSmartObjectRequestResult >& OutResults,
const AActor* UserActor
)

 Search a given Actor for slot candidates respecting the request criteria and selection conditions.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

FindSmartObjectsInComponent ( const FSmartObjectRequestFilter& Filter,
USmartObjectComponent* SmartObjectComponent,
TArray< FSmartObjectRequestResult >& OutResults,
const AActor* UserActor
)

 Search a given Smart Object Component for slot candidates respecting the request criteria and selection conditions.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

FindSmartObjectsInList ( UObject* WorldContextObject,
const FSmartObjectRequestFilter& Filter,
const TArray< AActor* >& ActorList,
TArray< FSmartObjectRequestResult >& OutResults,
const AActor* UserActor
)

 Search list of specific actors (often from a physics query) for slot candidates respecting request criteria and selection conditions.
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta bool

FindSmartObjectsInTargetingRequest ( UObject* WorldContextObject,
const FSmartObjectRequestFilter& Filter,
const FTargetingRequestHandle TargetingHandle,
TArray< FSmartObjectRequestResult >& OutResults,
const AActor* UserActor
)

 Search the results of the given targeting handle request for smart objects that match the request criteria
Public function Static UFunction BlueprintPure, Category, Meta FSmartObjectClaimHandle  
Public function Static UFunction BlueprintCallable, Category, Meta FSmartObjectClaimHandle

GetValueAsSOClaimHandle ( UBlackboardComponent* BlackboardComponent,
const FName& KeyName
)

  
Public function Static UFunction BlueprintCallable, Category, Meta bool  
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta bool Returns true if the given handle is valid
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta bool Returns true if the given Smart Object Slot Handle is valid.
Public function Static UFunction BlueprintCallable, Category, Meta FSmartObjectClaimHandle

MarkSmartObjectSlotAsClaimed ( UObject* WorldContextObject,
const FSmartObjectSlotHandle SlotHandle,
const AActor* UserActor,
ESmartObjectClaimPriority ClaimPriority
)

 Marks a smart object slot from a request result as claimed.
Public function Static UFunction BlueprintCallable, Category, Meta bool

MarkSmartObjectSlotAsFree ( UObject* WorldContextObject,
const FSmartObjectClaimHandle ClaimHandle
)

 Marks a claimed or occupied smart object as free.
Public function Static UFunction BlueprintCallable, Category, Meta const USmartObjectBehaviorDefinition *

MarkSmartObjectSlotAsOccupied ( UObject* WorldContextObject,
const FSmartObjectClaimHandle ClaimHandle,
TSubclassOf< USmartObjectBehaviorDefinition > DefinitionClass
)

 Marks a previously claimed smart object slot as occupied.
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if SmartObjectHandle A is NOT equal to SmartObjectHandle B (A != B)
Public function Static UFunction BlueprintPure, Category, Meta bool Returns true if SmartObjectSlotHandle A is NOT equal to SmartObjectSlotHandle B (A != B)
Public function Static UFunction BlueprintCallable, Category, Meta bool

RemoveMultipleSmartObjects ( const TArray< AActor* >& SmartObjectActors
)

 Removes from the simulation all smart objects for multiple actors.
Public function Static UFunction BlueprintCallable, Category, Meta bool

RemoveSmartObject ( AActor* SmartObjectActor
)

 Removes from the simulation all smart objects for an actor.
Public function Static UFunction BlueprintCallable, Category, Meta void  
Public function Static UFunction BlueprintCallable, Category, Meta bool

SetMultipleSmartObjectsEnabled ( const TArray< AActor* >& SmartObjectActors,
const bool bEnabled
)

 Marks all smart objects for a list of actors as enabled or not according to 'bEnabled'.
Public function Static UFunction BlueprintCallable, Category, Meta bool

SetSmartObjectEnabled ( AActor* SmartObjectActor,
const bool bEnabled
)

 Marks all smart objects for an actor as enabled or not according to 'bEnabled'.
Public function Static UFunction BlueprintCallable, Category void

SetValueAsSOClaimHandle ( UBlackboardComponent* BlackboardComponent,
const FName& KeyName,
FSmartObjectClaimHandle Value
)

  
Public function Static UFunction BlueprintCallable, BlueprintPure, Category, Meta FSmartObjectClaimHandle Returns the invalid smart object claim handle.

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page