unreal.RadialIntMask

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

Bases: unreal.FieldNodeInt

This function first defines a radial integer field equal to Interior-value inside a sphere / Exterior-value outside. This field will be used alongside the particle input value and the mask condition to compute the particle output value.

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

  • exterior_value (int32): [Read-Write] Exterior Value: If the sample distance from the center is greater than radius, the intermediate value will be set the exterior value

  • interior_value (int32): [Read-Write] Interior Value: If the sample distance from the center is less than radius, the intermediate value will be set the interior value

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

  • 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 (Vector): [Read-Write] Position: Center position of the radial mask field

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

  • radius (float): [Read-Write] Radius: Radius of the radial mask field

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

  • set_mask_condition (SetMaskConditionType): [Read-Write] Set Mask Condition: If the mask condition is set to always the output value will be the intermediate one. If set to not interior/exterior the output value will be the intermediate one if the input is different from the interior/exterior value

property exterior_value

[Read-Write] Exterior Value: If the sample distance from the center is greater than radius, the intermediate value will be set the exterior value

Type

(int32)

property interior_value

[Read-Write] Interior Value: If the sample distance from the center is less than radius, the intermediate value will be set the interior value

Type

(int32)

property position

[Read-Write] Position: Center position of the radial mask field

Type

(Vector)

property radius

[Read-Write] Radius: Radius of the radial mask field

Type

(float)

property set_mask_condition

[Read-Write] Set Mask Condition: If the mask condition is set to always the output value will be the intermediate one. If set to not interior/exterior the output value will be the intermediate one if the input is different from the interior/exterior value

Type

(SetMaskConditionType)

set_radial_int_mask(radius, position, interior_value, exterior_value, set_mask_condition_in) → RadialIntMask

This function first defines a radial integer field equal to Interior-value inside a sphere / Exterior-value outside. This field will be used alongside the particle input value and the mask condition to compute the particle output value. - If Mask-condition = set-always : the particle output value will be equal to Interior-value if the particle position is inside a sphere / Exterior-value otherwise. - If Mask-condition = merge-interior : the particle output value will be equal to Interior-value if the particle position is inside the sphere or if the particle input value is already Interior-Value / Exterior-value otherwise. - If Mask-condition = merge-exterior : the particle output value will be equal to Exterior-value if the particle position is outside the sphere or if the particle input value is already Exterior-Value / Interior-value otherwise.

Parameters

  • radius (float) – Radius of the radial field

  • position (Vector) – Center position of the radial field”

  • interior_value (int32) – If the sample distance from the center is less than radius, the intermediate value will be set the interior value

  • exterior_value (int32) – If the sample distance from the center is greater than radius, the intermediate value will be set the exterior value

  • set_mask_condition_in (SetMaskConditionType) – If the mask condition is set to always the output value will be the intermediate one. If set to not interior/exterior the output value will be the intermediate one if the input is different from the interior/exterior value

Return type

RadialIntMask