The Point Effector 2D applies forces to attract/repulse against a source point which can be defined as the position of the rigid-body or the center of a collider used by the effector. When another (target) collider comes into contact with the effector then a force is applied to the target. Where the force is applied and how it is calculated can be controlled.
Colliders that you use with the effector would typically be set as triggers so that other colliders can overlap with it to have forces applied however, non-triggers will still work but forces will only be applied when colliders come into contact with it.
Property: | Function: |
---|---|
Use Collider Mask | Should the ‘Collider Mask’ property be used? If not then the global collisionA collision occurs when the physics engine detects that the colliders of two GameObjects make contact or overlap, when at least one has a Rigidbody component and is in motion. More info See in Glossary matrix will be used as is the default for all colliders. |
Collider Mask | The mask used to select specific layers allowed to interact with the effector. |
Force Magnitude | The magnitude of the force to be applied. |
Force Variation | The variation of the magnitude of the force to be applied. |
Distance Scale | The scale applied to the distance between the source and target. When calculating the distance, it is scaled by this amount allowing the effective distance to be changed which controls the magnitude of the force applied. |
Drag | The linear drag to apply to rigid-bodies. |
Angular Drag | The angular drag to apply to rigid-bodies. |
Force Source | The force source is the point that attracts or repels target objects. The distance from the target is defined from this point. |
ColliderAn invisible shape that is used to handle physical collisions for an object. A collider doesn’t need to be exactly the same shape as the object’s mesh - a rough approximation is often more efficient and indistinguishable in gameplay. More info See in Glossary |
The source point is defined as the current position of the collider. |
RigidbodyA component that allows a GameObject to be affected by simulated gravity and other forces. More info See in Glossary |
The source point is defined as the current position of the rigidbody. |
Force Target | The force target is the point on a target object where the effector applies any force. The distance to the source is defined from this point. |
Collider | The target point is defined as the current position of the collider. Applying force here can generate torque (cause the target to rotate) if the collider isn’t positioned at the center-of-mass. |
Rigidbody | The target point is defined as the current center-of-mass of the rigidbody. Applying force here will never generate torque (cause the target to rotate). |
Force Mode | How the force is calculated. |
Constant | The force is applied ignoring how far apart the source and target are. |
Inverse Linear | The force is applied as a function of the inverse-linear distance between the source and target. When the source and target are in the same position then the full force is applied but it falls-off linearly as they move apart. |
Inverse Squared | The force is applied as a function of the inverse-squred distance between the source and target. When the source and target are in the same position then the full force is applied but it falls-off squared as they move apart. This is similar to real-world gravity. |
PointEffector2D
Did you find this page useful? Please give it a rating:
Thanks for rating this page!
What kind of problem would you like to report?
Thanks for letting us know! This page has been marked for review based on your feedback.
If you have time, you can provide more information to help us fix the problem faster.
Provide more information
You've told us this page needs code samples. If you'd like to help us further, you could provide a code sample, or tell us about what kind of code sample you'd like to see:
You've told us there are code samples on this page which don't work. If you know how to fix it, or have something better we could use instead, please let us know:
You've told us there is information missing from this page. Please tell us more about what's missing:
You've told us there is incorrect information on this page. If you know what we should change to make it correct, please tell us:
You've told us this page has unclear or confusing information. Please tell us more about what you found unclear or confusing, or let us know how we could make it clearer:
You've told us there is a spelling or grammar error on this page. Please tell us what's wrong:
You've told us this page has a problem. Please tell us more about what's wrong:
Thank you for helping to make the Unity documentation better!
Your feedback has been submitted as a ticket for our documentation team to review.
We are not able to reply to every ticket submitted.