1. Epic GamesDeveloper
  3. USmartObjectBlueprintFunctionLibrary

USmartObjectBlueprintFunctionLibrary

API > API/Plugins > API/Plugins/SmartObjectsModule

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

Syntax

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

Inheritance Hierarchy

Functions

Static

Name Remarks Include Path Unreal Specifiers

static bool AddMultipleSmartObjects ( const TArray< AActor* >& SmartObjectActors
)

 Adds to the simulation all smart objects for multiple actors. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static 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'. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static bool AddOrRemoveSmartObject ( AActor* SmartObject,
const bool bEnabled
)

 Adds to the simulation all smart objects for an actor or removes them according to 'bAdd'. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static bool AddSmartObject ( AActor* SmartObjectActor
)

 Adds to the simulation all smart objects for an actor. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static FString Conv_SmartObjectClaimHandleToString ( const FSmartObjectClaimHandle& Result
)

 Converts a SmartObjectClaimHandle value to a string SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(DisplayName="To String (SmartObjectClaimHandle)", CompactNodeTitle="->", BlueprintAutocast)

static FString Conv_SmartObjectDefinitionToString ( const USmartObjectDefinition* Definition
)

 Converts a SmartObjectDefinition value to a string SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(DisplayName="To String (SmartObjectDefinition)", CompactNodeTitle="->", BlueprintAutocast)

static FString Conv_SmartObjectHandleToString ( const FSmartObjectHandle& Handle
)

 FSmartObjectHandle operators Converts a SmartObjectHandle value to a string SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(DisplayName="To String (SmartObjectHandle)", CompactNodeTitle="->", BlueprintAutocast)

static FString Conv_SmartObjectRequestResultToString ( const FSmartObjectRequestResult& Result
)

 Converts a SmartObjectRequestResult value to a string SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(DisplayName="To String (SmartObjectRequestResult)", CompactNodeTitle="->", BlueprintAutocast)

static FString Conv_SmartObjectSlotHandleToString ( const FSmartObjectSlotHandle& Handle
)

 FSmartObjectSlotHandle operators Converts a SmartObjectSlotHandle value to a string SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="Utilities|String"
  • Meta=(DisplayName="To String (SmartObjectSlotHandle)", CompactNodeTitle="->", BlueprintAutocast)

static bool Equal_SmartObjectHandleSmartObjectHandle ( const FSmartObjectHandle& A,
const FSmartObjectHandle& B
)

 Returns true if SmartObjectHandle A is equal to SmartObjectHandle B (A == B) SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (SmartObjectHandle)", CompactNodeTitle="==", ScriptMethod="Equals", ScriptOperator="==", Keywords="== equal")
  • Category="SmartObjects"

static bool Equal_SmartObjectSlotHandleSmartObjectSlotHandle ( const FSmartObjectSlotHandle& A,
const FSmartObjectSlotHandle& B
)

 Returns true if SmartObjectSlotHandle A is equal to SmartObjectSlotHandle B (A == B) SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Equal (SmartObjectSlotHandle)", CompactNodeTitle="==", ScriptMethod="Equals", ScriptOperator="==", Keywords="== equal")
  • Category="SmartObjects"

static 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. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure=False
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static 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. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure=False
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static 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. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure=False
  • Category="SmartObject"
  • Meta=(WorldContext="WorldContextObject", ReturnDisplayName="bSuccess")

static 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 SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure=False
  • Category="SmartObject"
  • Meta=(WorldContext="WorldContextObject", ReturnDisplayName="bSuccess")

static FSmartObjectClaimHandle GetBlackboardValueAsSOClaimHandle ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key
)

   SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner", DisplayName="Get Blackboard Value As Smart Object Claim Handle")

static FSmartObjectClaimHandle GetValueAsSOClaimHandle ( UBlackboardComponent* BlackboardComponent,
const FName& KeyName
)

   SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="Claim Handle")

static bool IsValidSmartObjectClaimHandle ( const FSmartObjectClaimHandle Handle
)

   SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="Is Valid (Smart Object Claim Handle)", ReturnDisplayName="Is Valid")

static bool IsValidSmartObjectHandle ( const FSmartObjectHandle& Handle
)

 Returns true if the given handle is valid SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObjects"
  • Meta=(DisplayName="Is Valid (Smart Object Handle)", ReturnDisplayName="Is Valid")

static bool IsValidSmartObjectSlotHandle ( const FSmartObjectSlotHandle& Handle
)

 Returns true if the given Smart Object Slot Handle is valid. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObjects"
  • Meta=(DisplayName="Is Valid (Smart Object Slot Handle)", ReturnDisplayName="Is Valid")

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

 Marks a smart object slot from a request result as claimed. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(WorldContext="WorldContextObject", ReturnDisplayName="Claim Handle")

static bool MarkSmartObjectSlotAsFree ( UObject* WorldContextObject,
const FSmartObjectClaimHandle ClaimHandle
)

 Marks a claimed or occupied smart object as free. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(WorldContext="WorldContextObject", ReturnDisplayName="bSuccess")

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

 Marks a previously claimed smart object slot as occupied. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(WorldContext="WorldContextObject")

static bool NotEqual_SmartObjectHandleSmartObjectHandle ( const FSmartObjectHandle& A,
const FSmartObjectHandle& B
)

 Returns true if SmartObjectHandle A is NOT equal to SmartObjectHandle B (A != B) SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal (SmartObjectHandle)", CompactNodeTitle="!=", ScriptMethod="NotEqual", ScriptOperator="!=", Keywords="!= not equal")
  • Category="SmartObjects"

static bool NotEqual_SmartObjectSlotHandleSmartObjectSlotHandle ( const FSmartObjectSlotHandle& A,
const FSmartObjectSlotHandle& B
)

 Returns true if SmartObjectSlotHandle A is NOT equal to SmartObjectSlotHandle B (A != B) SmartObjectBlueprintFunctionLibrary.h
  • BlueprintPure
  • Meta=(DisplayName="Not Equal (SmartObjectSlotHandle)", CompactNodeTitle="!=", ScriptMethod="NotEqual", ScriptOperator="!=", Keywords="!= not equal")
  • Category="SmartObjects"

static bool RemoveMultipleSmartObjects ( const TArray< AActor* >& SmartObjectActors
)

 Removes from the simulation all smart objects for multiple actors. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static bool RemoveSmartObject ( AActor* SmartObjectActor
)

 Removes from the simulation all smart objects for an actor. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

static void SetBlackboardValueAsSOClaimHandle ( UBTNode* NodeOwner,
const FBlackboardKeySelector& Key,
const FSmartObjectClaimHandle& Value
)

   SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="AI|BehaviorTree"
  • Meta=(HidePin="NodeOwner", DefaultToSelf="NodeOwner", DisplayName="Set Blackboard Value As Smart Object Claim Handle")

static 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'. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(DisplayName="SetMultipleSmartObjectsEnabled", ReturnDisplayName="bSuccess")

static bool SetSmartObjectEnabled ( AActor* SmartObjectActor,
const bool bEnabled
)

 Marks all smart objects for an actor as enabled or not according to 'bEnabled'. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="bSuccess")

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

   SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • Category="SmartObject"

static FSmartObjectClaimHandle SmartObjectClaimHandle_Invalid()

 Returns the invalid smart object claim handle. SmartObjectBlueprintFunctionLibrary.h
  • BlueprintCallable
  • BlueprintPure
  • Category="SmartObject"
  • Meta=(ReturnDisplayName="Invalid Claim Handle")

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page