class in UnityEngine
/
Inherits from:Effector2D
/
Implemented in:UnityEngine.Physics2DModule
Applies forces to simulate buoyancy, fluid-flow and fluid drag.
When any Collider2D overlap the area defined by the effector, calculations are made to determine if they are below the surfaceLevel. If they are not, no forces are applied. If they are then the effector will apply buoyancy forces in an attempt to move the Collider2D to the surfaceLevel i.e. they will float.
This effector is designed primarily to work with Collider2D that are set as triggers so that Collider2D can overlap the defined area and have buoyancy forces applied to them.
| angularDrag | A force applied to slow angular movement of any Collider2D in contact with the effector. |
| density | The density of the fluid used to calculate the buoyancy forces. |
| flowAngle | The angle of the force used to similate fluid flow. |
| flowMagnitude | The magnitude of the force used to similate fluid flow. |
| flowVariation | The random variation of the force used to similate fluid flow. |
| linearDrag | A force applied to slow linear movement of any Collider2D in contact with the effector. |
| surfaceLevel | Defines an arbitrary horizontal line that represents the fluid surface level. |
| enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
| isActiveAndEnabled | Has the Behaviour had active and enabled called? |
| gameObject | The game object this component is attached to. A component is always attached to a game object. |
| tag | The tag of this game object. |
| transform | The Transform attached to this GameObject. |
| colliderMask | The mask used to select specific layers allowed to interact with the effector. |
| useColliderMask | Should the collider-mask be used or the global collision matrix? |
| hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
| name | The name of the object. |
| BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
| CompareTag | Is this game object tagged with tag ? |
| GetComponent | Returns the component of Type type if the GameObject has one attached, null if it doesn't. Will also return disabled components. |
| GetComponentInChildren | Returns the component of Type type in the GameObject or any of its children using depth first search. |
| GetComponentInParent | Returns the component of Type type in the GameObject or any of its parents. |
| GetComponents | Returns all components of Type type in the GameObject. |
| GetComponentsInChildren | Returns all components of Type type in the GameObject or any of its children. Works recursively. |
| GetComponentsInParent | Returns all components of Type type in the GameObject or any of its parents. |
| SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
| SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
| TryGetComponent | Gets the component of the specified type, if it exists. |
| GetInstanceID | Gets the instance ID of the object. |
| ToString | Returns the name of the object. |
| Destroy | Removes a GameObject, component or asset. |
| DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
| DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
| FindObjectOfType | Returns the first active loaded object of Type type. |
| FindObjectsOfType | Gets a list of all loaded objects of Type type. |
| Instantiate | Clones the object original and returns the clone. |
| bool | Does the object exist? |
| operator != | Compares if two objects refer to a different object. |
| operator == | Compares two object references to see if they refer to the same object. |