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.

Static Variables

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

Variables

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

Functions

Name	Description
`SetTunnelTrack`	Assign a specific `kTunnel` Track to an axis.
Declaration bool SetTunnelTrack( const unsigned char axis, Track track ) Parameters* `axis`: The axis the Track should be assigned to; where `0` is `X`, `1` is `Y` and `2` is `Z`. `track`: An existing Track asset; use `nil` to disconnect. Return Value `true` if a `track` was either connected or disconnected; `false` if the `axis` is invalid.
`SetBoundsType`	Specify the type of CollisionBounds to use in order to attract resource(s).
Declaration void SetBoundsType( const CollisionBounds type ) Parameters `type`: The level of detail index to connect the Material too. Warning Only primary CollisionBounds types are allowed; either `kTriangleMesh` and `kConvexHull` will be ignored and treated as a `kSphere`.
`SetDistanceModelTrack`	Specify an existing Track asset to control the DistanceModel
Declaration void SetDistanceModelTrack( Track track ) Parameters* `track`: Connect an existing Track by specifying its reference; pass `nil` to disconnect.
`Evaluate`	Force the EnergyField to be re-evaluated for a specific Object.
Declaration bool Evaluate( const Object object ) Parameters* `object`: An existing Object reference. Return Value `true` if the `object` have been affected by the EnergyField; `false` if the function receive `nil` or if the Object was not affected.

FieldType

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.

Note: Visit the Energy Field Type section of the editor Manual contains demonstration of each FieldType.