unreal.FieldSystemMetaDataFilter

class unreal.FieldSystemMetaDataFilter(outer=None, name='None')

Bases: unreal.FieldSystemMetaData

Filter the particles on which the field will be applied

C++ Source:

  • Module: FieldSystemEngine

  • File: FieldSystemObjects.h

Editor Properties: (see get_editor_property/set_editor_property)

  • asset_user_data (Array(AssetUserData)): [Read-Write] Asset User Data: Array of user data stored with the component

  • auto_activate (bool): [Read-Write] Auto Activate: Whether the component is activated at creation or must be explicitly activated.

  • can_ever_affect_navigation (bool): [Read-Write] Can Ever Affect Navigation: Whether this component can potentially influence navigation

  • component_tags (Array(Name)): [Read-Write] Component Tags: Array of tags that can be used for grouping and categorizing. Can also be accessed from scripting.

  • editable_when_inherited (bool): [Read-Write] Editable when Inherited: True if this component can be modified when it was inherited from a parent actor class

  • filter_type (FieldFilterType): [Read-Write] Filter Type: Filter state type used to select the particles on which the field will be applied

  • is_editor_only (bool): [Read-Write] Is Editor Only: If true, the component will be excluded from non-editor builds

  • object_type (FieldObjectType): [Read-Write] Object Type: Filter object type used to select the particles on which the field will be applied

  • on_component_activated (ActorComponentActivatedSignature): [Read-Write] On Component Activated: Called when the component has been activated, with parameter indicating if it was from a reset

  • on_component_deactivated (ActorComponentDeactivateSignature): [Read-Write] On Component Deactivated: Called when the component has been deactivated

  • position_type (FieldPositionType): [Read-Write] Position Type: Specify which position type will be used for the field evaluation

  • primary_component_tick (ActorComponentTickFunction): [Read-Write] Primary Component Tick: Main tick function for the Component

  • replicates (bool): [Read-Write] Replicates: Is this component currently replicating? Should the network code consider it for replication? Owning Actor must be replicating first!

property filter_type

[Read-Write] Filter Type: Filter state type used to select the particles on which the field will be applied

Type

(FieldFilterType)

property object_type

[Read-Write] Object Type: Filter object type used to select the particles on which the field will be applied

Type

(FieldObjectType)

property position_type

[Read-Write] Position Type: Specify which position type will be used for the field evaluation

Type

(FieldPositionType)

set_meta_data_filter_type(filter_type, object_type, position_type) FieldSystemMetaDataFilter

Set the particles filter type

Parameters
  • filter_type (FieldFilterType) – State type used to select the state particles on which the field will be applied

  • object_type (FieldObjectType) – Object type used to select the type of objects(rigid, cloth…) on which the field will be applied

  • position_type (FieldPositionType) – Position type used to compute the samples positions

Return type

FieldSystemMetaDataFilter