1. Epic GamesDeveloper
  3. FSmartObjectSlotEntranceLocationRequest

FSmartObjectSlotEntranceLocationRequest

Struct used to request slot entry or exit location.

API > API/Plugins > API/Plugins/SmartObjectsModule

References

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

Syntax

USTRUCT (BlueprintType )  
struct FSmartObjectSlotEntranceLocationRequest

Remarks

Struct used to request slot entry or exit location.

When used with actor, it is generally enough to set the UserActor. In that case NavigationData, ValidationFilter, and UserCapsule are queried via the INavAgentInterface and USmartObjectUserComponent on the actor if they are not set.

If the user actor is not available (e.g. with Mass), then ValidationFilter and UserCapsule must be defined, and if bProjectNavigationLocation is set NavigationData must be valid.

The location validation is done in following order:

  • navigation projection
  • trace ground location (uses altered location from navigation test if applicable)
  • check transition trajectory (test between unmodified navigation location and slow location)

Variables

  Type Name Description
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bCheckEntranceLocationOverlap If true, check user capsule collisions at the entrance location.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bCheckSlotLocationOverlap If true, check user capsule collisions at the slot location.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bCheckTransitionTrajectory If true, check collisions between navigation location and slot location.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bProjectNavigationLocation If true, try to project the location on navigable area. If projection fails, an entry is discarded.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bTraceGroundLocation If true, try to trace the location on ground. If trace fails, an entry is discarded.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite bool bUseSlotLocationAsFallback If true, include slot location as a candidate if no navigation annotation is present.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite ESmartObjectSlotNavigationLocationType LocationType Enum indicating if we're looking for a location to enter or exit the Smart Object slot.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TObjectPtr< const ANavigationData > NavigationData Navigation data to use for the navigation queries.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FVector SearchLocation Search location that may be used to select an entry from multiple candidates.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FSmartObjectSlotEntrySelectionMethod SelectMethod How to select an entry when a slot has multiple entries.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite PRAGMA_ENABLE_DEPRECATION_WARNINGSTObjectPtr< const AActor > UserActor Actor that is using the smart object slot. (Optional)
Public variable TOptional< FSmartObjectUserCapsuleParams > UserCapsule  
Public variable UProperty Category, EditAnywhere BlueprintReadWrite FSmartObjectUserCapsuleParams UserCapsuleParams Size of the user of the smart object.
Public variable UProperty Category, EditAnywhere BlueprintReadWrite TSubclassOf< USmartObjectSlotValidationFilter > ValidationFilter Filter to use for the validation.

Constructors

  Type Name Description
Public function PRAGMA_DISABLE_DEPRECATION_WARNINGS Macro needed to avoid deprecation errors with "UserCapsule" being copied or created in the default methods.
Public function    
Public function    

Operators

  Type Name Description
Public function FSmartObjectSlotEntranceLocationRequest &  
Public function FSmartObjectSlotEntranceLocationRequest &  

Ask questions and help your peers Developer Forums

Write your own tutorials or read those from others Learning Library

On this page