unreal.SmartObjectRequestFilter

class unreal.SmartObjectRequestFilter(user_tags: GameplayTagContainer = Ellipsis, claim_priority: SmartObjectClaimPriority = 0, activity_requirements: GameplayTagQuery = [], behavior_definition_classes: None = [], should_evaluate_conditions: bool = False, should_include_claimed_slots: bool = False, should_include_disabled_slots: bool = False)

Bases: StructBase

Struct that can be used to filter results of a smart object request when trying to find or claim a smart object

C++ Source:

  • Plugin: SmartObjects

  • Module: SmartObjectsModule

  • File: SmartObjectSubsystem.h

Editor Properties: (see get_editor_property/set_editor_property)

  • activity_requirements (GameplayTagQuery): [Read-Write] Only return slots whose activity tags are matching this query.

  • behavior_definition_classes (Array[type(Class)]): [Read-Write] If set, will filter out any SmartObject that uses different BehaviorDefinition classes.

  • claim_priority (SmartObjectClaimPriority): [Read-Write] The user’s claim priority. The search will contain already claimed slots at lower priority.

  • should_evaluate_conditions (bool): [Read-Write] If true will evaluate the slot and object conditions, otherwise will skip them.

  • should_include_claimed_slots (bool): [Read-Write] If true, this search will contain claimed slots.

  • should_include_disabled_slots (bool): [Read-Write] If true, this search will contain disabled slots.

  • user_tags (GameplayTagContainer): [Read-Write] Gameplay tags of the Actor or Entity requesting the Smart Object slot.

property activity_requirements: GameplayTagQuery

[Read-Write] Only return slots whose activity tags are matching this query.

Type:

(GameplayTagQuery)

property behavior_definition_classes: None

[Read-Write] If set, will filter out any SmartObject that uses different BehaviorDefinition classes.

Type:

(Array[type(Class)])

property claim_priority: SmartObjectClaimPriority

[Read-Write] The user’s claim priority. The search will contain already claimed slots at lower priority.

Type:

(SmartObjectClaimPriority)

property should_evaluate_conditions: bool

[Read-Write] If true will evaluate the slot and object conditions, otherwise will skip them.

Type:

(bool)

property should_include_claimed_slots: bool

[Read-Write] If true, this search will contain claimed slots.

Type:

(bool)

property should_include_disabled_slots: bool

[Read-Write] If true, this search will contain disabled slots.

Type:

(bool)

property user_tags: GameplayTagContainer

[Read-Write] Gameplay tags of the Actor or Entity requesting the Smart Object slot.

Type:

(GameplayTagContainer)