Force Effect

Like what your seeing?

Support us as a GitHub Sponsor and get instant access to all our assets, exclusive tools and assets, escalated support and issue tracking and our gratitude. These articles are made possible by our GitHub Sponsors ... become a sponsor today!

Introduction

A force effect is a configurable set of rules that describe the way in which a force will be applied. Force Effects do not describe the strength of a force or the source of the force only the maths used to apply the force to a body.

Force Effects can be used to create tractor beams, repulsed bombs, gravity wells and more and Force Effects can be configured to apply to specific or ignore specific subjects. The Force Effect its self is defined as a Scriptable Object in your Asset folder; you can create a new Force Effect configuration via

Create > Physics > Effects

This will create a new Scriptable Object which exposes any of the relevant configuration values for that effect.

An example of a wind effect

Each effect has unique uses and configuration and is applied in a unique way ... the following articles describe the effects included with the kit.

Related Topics

Force Effect SourceHeathen KB

Force Effect RecieverHeathen KB

Custom Effects

The Force Effect system was designed to be high customizable. You can create your own unique types of Force Effects by creating a script that that derives from the ForceEffect class.

[CreateAssetMenu(menuName = "Physics/Effects/Custom")]
public class CustomEffect : ForceEffect
{
    public override void AngularEffect(Vector3 origin, float strength, PhysicsData subject)
    {
        //Do work
    }
    
    public override void LinearEffect(Vector3 origin, float strength, PhysicsData subject)
    {
        //Do work
    }
}

Angular Effect

This is only invoked for subjects that are listening for angular effects and is meant to modify the torque of the subject.

Origin

This is the origin of the effect as a point in world space. For Force Effect Fields this would be the point in space where the field originates, for Fore Effect Directions this will always be a point in space 1 unit vector away from the subject in the direction the force is applied.

Strength

This is the strength of the effect