An energy field is a special type of Object that act like an attractor. Based on the InclusionMask set by the user specific resources will be affected by it. Energy fields behaviors are controlled by the FieldType; wich can cause resources (Particles and PhysicObject) to ie: spin, swirl, reflect or follow a specific tunnel or vacuum. Multiple different type of effects can be generated to simulate real world phenomenon.

To determine if a resource in space is affected each EnergyField are defined by a CollisionBounds. If an Object or Particles enter this invisible boundary it is susceptible to be affected by the EnergyField.

See Also

Static Variables

Name Description
object Parent Object associated to the current EnergyField.
shape Access the ColliderData properties of the CollisionBounds set for the current EnergyField.
tunnel_track_x Track asset that controls the kTunnel vector component X.
tunnel_track_y Track asset that controls the kTunnel vector component Y.
tunnel_track_z Track asset that controls the kTunnel vector component Z.
distance_model_track Track asset that controls the DistanceModel of the EnergyField.


Name Description
enabled Activate or deactivate the EnergyField.
strength The amount of force the EnergyField apply.
influence Control the level of attraction the EnergyField apply on the selected resources it attracts.
local_matrix A 4x4 matrix that allows you to locally offset the EnergyField around its parent Object pivot point.
tunnel_resolution The amount of segments to use in order to subdivide the kTunnel tracks.
inclusion_mask InclusionMask that controls the type of resources should be attracted by the EnergyField.
filter Optional sub-string used to include or reject attracted resource(s).
field_type The current FieldType used by the EnergyField.
distance_model The DistanceModel to calculate the level of attraction of the EnergyField.


Name Description
SetTunnelTrack Assign a specific kTunnel Track to an axis.
SetBoundsType Specify the type of CollisionBounds to use in order to attract resource(s).
SetDistanceModelTrack Specify an existing Track asset to control the DistanceModel
Evaluate Force the EnergyField to be re-evaluated for a specific Object.


The type of behavior that can be applied to an EnergyField.

  • kPower: Omnidirectional power source; it applies a central force to the resource(s) that hit is bounds.
  • kWind: Simulate wind by applying a directional central force to the resources that comes in contact with the field bounds.
  • kSwirl: Creates a vortex like effect by redirecting the trajectory of the resource in a circular motion.
  • kSpin: Creates a tornado like effect by forcing the resources to orbit in motion around the central region of the dedicated shape assigned to the energy field.
  • kDrag: Apply an inverted force to the incoming resources slowing down its progression in space simulating a drag effect.
  • kReflect: Bounce back objects and particles using their impact direction with the energy field shape.
  • kTurbulence: Apply random noise based on the strength factor of the field to the resource(s) hitting the bounds.
  • kTunnel: Creates a vacuum like effect for all resources hitting the tubular area of the energy field. Particles and objects will be funneled all the way down the tunnel until no more control points are available on the custom tracks that forms the tunnel.
Visit the Energy Field Type section of the editor Manual contains demonstration of each FieldType.

NRG - API 2022.4.384543 - Fri Nov 4 2022
Copyright © 2022 All Rights Reserved. Terms of Service - Privacy Policy - EULA