Surface Effector 2D
Switch to ScriptingThe Surface Effector 2D applies tangent forces along the surfaces of collidersAn 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 used by the effector in an attempt to match a specified speed along the surface. This is analogous to a conveyor belt.
Colliders that you use with the effector would typically be set as non-triggers so that other colliders can come into contact with the surface.
Properties
| 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. |
| Speed | The speed to be maintained along the surface. |
| Speed Variation | A random increase in the speed (anywhere between 0 and the Speed Variation value) will be applied to the speed. If a negative number is entered here, a random reduction in the speed will be applied. |
| Force Scale | Allows scaling of the force that is applied when the effector attempts to attain the specified speed along the surface. If 0 then no force is applied is is effectively disabled. If 1 then the full force is applied. It can be thought of as how fast the target object is modified to meet the specified speed with lower values being slower and higher values being quicker. Care should be taken however as applying the full force will easily counteract any other forces being applied to the target object such as jump or other movement forces. For this reason, a value less than 1 is advised. |
| Use Contact Force | Should the force be applied at the point of contact between the surface and the target collider? Using contact forces can cause the target object to rotate whereas not using contact forces won’t. |
| Use Friction | Should friction be used when contacting the surface? |
| Use Bounce | Should bounce be used when contacting the surface? |
SurfaceEffector2D