Navigation
API > API/Plugins > API/Plugins/SmartObjectsModule
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)
| Name | FSmartObjectSlotEntranceLocationRequest |
| Type | struct |
| Header File | /Engine/Plugins/Runtime/SmartObjects/Source/SmartObjectsModule/Public/SmartObjectSubsystem.h |
| Include Path | #include "SmartObjectSubsystem.h" |
Syntax
USTRUCT (BlueprintType )
struct FSmartObjectSlotEntranceLocationRequest
Constructors
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
PRAGMA_DISABLE_DEPRECATION_WARNINGS FSmartObjectSlotEntranceLocationRequest () |
Macro needed to avoid deprecation errors with "UserCapsule" being copied or created in the default methods. | SmartObjectSubsystem.h | |
| SmartObjectSubsystem.h | |||
| SmartObjectSubsystem.h |
Variables
Public
| Name | Type | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|---|
| bCheckEntranceLocationOverlap | bool | If true, check user capsule collisions at the entrance location. | SmartObjectSubsystem.h |
|
| bCheckSlotLocationOverlap | bool | If true, check user capsule collisions at the slot location. | SmartObjectSubsystem.h |
|
| bCheckTransitionTrajectory | bool | If true, check collisions between navigation location and slot location. | SmartObjectSubsystem.h |
|
| bProjectNavigationLocation | bool | If true, try to project the location on navigable area. If projection fails, an entry is discarded. | SmartObjectSubsystem.h |
|
| bTraceGroundLocation | bool | If true, try to trace the location on ground. If trace fails, an entry is discarded. | SmartObjectSubsystem.h |
|
| bUseSlotLocationAsFallback | bool | If true, include slot location as a candidate if no navigation annotation is present. | SmartObjectSubsystem.h |
|
| bUseUpAxisLockedRotation | bool | If true, the result rotation will only contain rotation around the UP axis (i.e., Yaw only; Pitch and Roll set to 0). | SmartObjectSubsystem.h |
|
| LocationType | ESmartObjectSlotNavigationLocationType | Enum indicating if we're looking for a location to enter or exit the smart object slot. | SmartObjectSubsystem.h |
|
| NavigationData | TObjectPtr< const ANavigationData > | Navigation data to use for the navigation queries. | SmartObjectSubsystem.h |
|
| SearchLocation | FVector | Search location that may be used to select an entry from multiple candidates. | SmartObjectSubsystem.h |
|
| SelectMethod | FSmartObjectSlotEntrySelectionMethod | How to select an entry when a slot has multiple entries. | SmartObjectSubsystem.h |
|
| UserActor | TObjectPtr< const AActor > | Actor that is using the smart object slot. (Optional) | SmartObjectSubsystem.h |
|
| UserCapsule | TOptional< FSmartObjectUserCapsuleParams > | SmartObjectSubsystem.h | ||
| UserCapsuleParams | FSmartObjectUserCapsuleParams | Size of the user of the smart object. | SmartObjectSubsystem.h |
|
| ValidationFilter | TSubclassOf< USmartObjectSlotValidationFilter > | Filter to use for the validation. | SmartObjectSubsystem.h |
|
Functions
Public
Operators
| Name | Remarks | Include Path | Unreal Specifiers |
|---|---|---|---|
| SmartObjectSubsystem.h | |||
| SmartObjectSubsystem.h |