unreal.SmartObjectSlotEntranceLocationRequest

class unreal.SmartObjectSlotEntranceLocationRequest(user_actor: Actor = Ellipsis, validation_filter: Class = Ellipsis, navigation_data: NavigationData = Ellipsis, user_capsule_params: SmartObjectUserCapsuleParams = Ellipsis, search_location: Vector = Ellipsis, select_method: FSmartObjectSlotEntrySelectionMethod = Ellipsis, location_type: SmartObjectSlotNavigationLocationType = Ellipsis, project_navigation_location: bool = False, trace_ground_location: bool = False, check_transition_trajectory: bool = False, check_entrance_location_overlap: bool = False, check_slot_location_overlap: bool = False, use_slot_location_as_fallback: bool = False)

Bases: StructBase

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)

C++ Source:

  • Plugin: SmartObjects

  • Module: SmartObjectsModule

  • File: SmartObjectSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • check_entrance_location_overlap (bool): [Read-Write] If true, check user capsule collisions at the entrance location. Uses capsule dimensions set in the validation filter.

  • check_slot_location_overlap (bool): [Read-Write] If true, check user capsule collisions at the slot location. Uses capsule dimensions set in an annotation on the slot.

  • check_transition_trajectory (bool): [Read-Write] If true, check collisions between navigation location and slot location. If collisions are found, an entry is discarded.

  • location_type (SmartObjectSlotNavigationLocationType): [Read-Write] Enum indicating if we’re looking for a location to enter or exit the Smart Object slot.

  • navigation_data (NavigationData): [Read-Write] Navigation data to use for the navigation queries. If not set and UserActor is valid, the navigation data is queried via INavAgentInterface.

  • project_navigation_location (bool): [Read-Write] If true, try to project the location on navigable area. If projection fails, an entry is discarded.

  • search_location (Vector): [Read-Write] Search location that may be used to select an entry from multiple candidates. (e.g. user actor location).

  • select_method (FSmartObjectSlotEntrySelectionMethod): [Read-Write] How to select an entry when a slot has multiple entries.

  • trace_ground_location (bool): [Read-Write] If true, try to trace the location on ground. If trace fails, an entry is discarded.

  • use_slot_location_as_fallback (bool): [Read-Write] If true, include slot location as a candidate if no navigation annotation is present.

  • user_actor (Actor): [Read-Write] Actor that is using the smart object slot. (Optional)

  • user_capsule_params (SmartObjectUserCapsuleParams): [Read-Write] Size of the user of the smart object. If not set and UserActor is valid, the dimensions are queried via INavAgentInterface.

  • validation_filter (type(Class)): [Read-Write] Filter to use for the validation. If not set and UserActor is valid, the filter is queried via USmartObjectUserComponent.

property check_entrance_location_overlap: bool

[Read-Write] If true, check user capsule collisions at the entrance location. Uses capsule dimensions set in the validation filter.

Type:

(bool)

property check_slot_location_overlap: bool

[Read-Write] If true, check user capsule collisions at the slot location. Uses capsule dimensions set in an annotation on the slot.

Type:

(bool)

property check_transition_trajectory: bool

[Read-Write] If true, check collisions between navigation location and slot location. If collisions are found, an entry is discarded.

Type:

(bool)

property location_type: SmartObjectSlotNavigationLocationType

[Read-Write] Enum indicating if we’re looking for a location to enter or exit the Smart Object slot.

Type:

(SmartObjectSlotNavigationLocationType)

property navigation_data: NavigationData

[Read-Write] Navigation data to use for the navigation queries. If not set and UserActor is valid, the navigation data is queried via INavAgentInterface.

Type:

(NavigationData)

property project_navigation_location: bool

[Read-Write] If true, try to project the location on navigable area. If projection fails, an entry is discarded.

Type:

(bool)

property search_location: Vector

[Read-Write] Search location that may be used to select an entry from multiple candidates. (e.g. user actor location).

Type:

(Vector)

property select_method: FSmartObjectSlotEntrySelectionMethod

[Read-Write] How to select an entry when a slot has multiple entries.

Type:

(FSmartObjectSlotEntrySelectionMethod)

property trace_ground_location: bool

[Read-Write] If true, try to trace the location on ground. If trace fails, an entry is discarded.

Type:

(bool)

property use_slot_location_as_fallback: bool

[Read-Write] If true, include slot location as a candidate if no navigation annotation is present.

Type:

(bool)

property user_actor: Actor

[Read-Write] Actor that is using the smart object slot. (Optional)

Type:

(Actor)

property user_capsule_params: SmartObjectUserCapsuleParams

[Read-Write] Size of the user of the smart object. If not set and UserActor is valid, the dimensions are queried via INavAgentInterface.

Type:

(SmartObjectUserCapsuleParams)

property validation_filter: Class

[Read-Write] Filter to use for the validation. If not set and UserActor is valid, the filter is queried via USmartObjectUserComponent.

Type:

(type(Class))