Unreal Engine 4.26 Documentation

Unreal Engine 4.27 Documentation

Unreal Engine 5.0 Documentation

Unreal Engine 5.1 Documentation

Unreal Engine 5.2 Documentation

Unreal Engine 5.3 Documentation

> Unreal Engine Blueprint API Reference > Field

Light Theme

Dark Theme

Field

Windows

MacOS

Linux

On this page

Actions

Actions

Add Construction Field	AddConstructionField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined field network. This command will be used in a construction script to setup some particles properties (anchors...). See documentation, for examples of how to recreate variations of the above generic fields using field networks (https://wiki.it.epicgames.net/display/~Brice.Criswell/Fields) Target is Field System Component
Add Persistent Field	AddPersistentField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined field network. This command will be persistent in time and will live until the component is destroyed or until the RemovePersistenFields function is called. See documentation, for examples of how to recreate variations of the above generic fields using field networks (https://wiki.it.epicgames.net/display/~Brice.Criswell/Fields) Target is Field System Component
Add Physics Field	AddPhysicsField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined transient field network. See documentation, for examples of how to recreate variations of the above generic fields using field networks Target is Geometry Collection Component
Add Transient Field	AddTransientField This function will dispatch a command to the physics thread to apply a generic evaluation of a user defined transient field network. See documentation, for examples of how to recreate variations of the above generic fields using field networks (https://wiki.it.epicgames.net/display/~Brice.Criswell/Fields) Target is Field System Component
Apply External Strain	ApplyExternalStran This function will dispatch a command to the physics thread to apply a strain field on a clustered set of geometry. This is used to trigger a breaking event within the solver. Target is Field System Component
Apply Radial Force	ApplyRadialForce This function will dispatch a command to the physics thread to apply a linear force that points away from a position. Target is Field System Component
Apply Uniform Force	ApplyUniformForce This function will dispatch a command to the physics thread to apply a uniform linear force on each particle within the simulation. Target is Field System Component
Falloff Radial Force	FalloffRadialForce This function will dispatch a command to the physics thread to apply a linear force from a position in space. The force vector is weaker as it moves away from the center. Target is Field System Component
Falloff Uniform Force	FalloffUniformForce This function will dispatch a command to the physics thread to apply a linear force in a uniform direction. The force vector is weaker as it moves away from the center. Target is Field System Component
Remove Construction Fields	RemoveConstructionFields This function will remove all the field component construction fields from chaos and from the world Target is Field System Component
Remove Persistent Fields	RemovePersistentFields This function will remove all the field component persistent fields from chaos and from the world Target is Field System Component
Set Box Falloff	Box scalar field that will be defined only within a box Target is Box Falloff
Set Culling Field	Evaluate the input field according to the result of the culling field Target is Culling Field
Set Dynamic State	SetDynamicState This function will dispatch a command to the physics thread to apply a kinematic to dynamic state change for the geo collection particles within the field. Target is Geometry Collection Component
Set Meta Data Filter	Set the particles filter type Target is MetaDataFilter
Set Meta Data Iteration	Set the number of iteration type Target is MetaDataIteration
Set Meta Data Resolution	Set the processing resolution type Target is MetaDataResolution
Set Noise Field	Defines a perlin noise scalar value if the sample is within a box Target is Noise Field
Set Operator Field	Compute an operation between 2 incoming fields Target is Operator Field
Set Plane Falloff	Plane scalar field that will be defined only within a distance from a plane Target is Plane Falloff
Set Radial Falloff	Sphere scalar field that will be defined only within a sphere Target is Radial Falloff
Set Radial Mask	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. Target is Radial Int Mask
Set Radial Vector	Set a radial vector value. The direction is the normalized vector from the field position to the sample one. The output is equal to this direction * magnitude. Target is Radial Vector
Set Random Vector	Set a random vector value independently of the sample position. The output is equal to magnitude * random direction Target is Random Vector
Set Terminal Field	Terminal field of a graph Target is Return Results Terminal
Set To Float Field	Convert an integer field to a float one Target is To Float Field
Set To Integer Field	Convert a float field to a integer one Target is To Integer Field
Set Uniform Integer	Set a uniform integer value independently of the sample position. The output is equal to magnitude Target is Uniform Integer
Set Uniform Scalar	Set a uniform scalar value independently of the sample position. The output is equal to magnitude Target is Uniform Scalar
Set Uniform Vector	Set a uniform vector value independently of the sample position.The output is equal to magnitude * direction Target is Uniform Vector
Set Wave Scalar	Set a temporal wave scalar value according to the sample distance from the field position. Target is Wave Scalar

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.

Take our survey

Dismiss