unity-atoms/docs/api/unityatoms.monohooks.md

789 lines
23 KiB
Markdown
Raw Permalink Normal View History

2019-10-15 19:43:51 -04:00
---
id: unityatoms.monohooks
title: UnityAtoms.MonoHooks
hide_title: true
sidebar_label: UnityAtoms.MonoHooks
---
# Namespace - `UnityAtoms.MonoHooks`
## `Collider2DGameObjectAction`
2020-12-29 18:47:17 -05:00
Action of type `Collider2DGameObject`. Inherits from `AtomAction<Collider2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `Collider2DGameObjectPairAction`
2020-03-02 14:12:38 -05:00
Action of type `Collider2DGameObjectPair`. Inherits from `AtomAction<Collider2DGameObjectPair>`.
2020-03-02 14:12:38 -05:00
---
## `ColliderGameObjectAction`
2020-03-02 14:12:38 -05:00
Action of type `ColliderGameObject`. Inherits from `AtomAction<ColliderGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `ColliderGameObjectPairAction`
2020-12-29 18:47:17 -05:00
Action of type `ColliderGameObjectPair`. Inherits from `AtomAction<ColliderGameObjectPair>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectAction`
2020-12-29 18:47:17 -05:00
Action of type `Collision2DGameObject`. Inherits from `AtomAction<Collision2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectPairAction`
2020-03-02 14:12:38 -05:00
Action of type `Collision2DGameObjectPair`. Inherits from `AtomAction<Collision2DGameObjectPair>`.
2020-03-02 14:12:38 -05:00
---
## `CollisionGameObjectAction`
2020-12-29 18:47:17 -05:00
Action of type `CollisionGameObject`. Inherits from `AtomAction<CollisionGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectPairAction`
2020-12-29 18:47:17 -05:00
Action of type `CollisionGameObjectPair`. Inherits from `AtomAction<CollisionGameObjectPair>`.
2020-12-29 18:47:17 -05:00
---
## `SetCollider2DGameObjectVariableValue`
2020-03-02 14:12:38 -05:00
Set variable value Action of type `Collider2DGameObject`. Inherits from `SetVariableValue<Collider2DGameObject, Collider2DGameObjectPair, Collider2DGameObjectVariable, Collider2DGameObjectConstant, Collider2DGameObjectReference, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectVariableInstancer>`.
2020-03-02 14:12:38 -05:00
---
## `SetColliderGameObjectVariableValue`
2020-03-02 14:12:38 -05:00
Set variable value Action of type `ColliderGameObject`. Inherits from `SetVariableValue<ColliderGameObject, ColliderGameObjectPair, ColliderGameObjectVariable, ColliderGameObjectConstant, ColliderGameObjectReference, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectVariableInstancer>`.
2020-03-02 14:12:38 -05:00
---
## `SetCollision2DGameObjectVariableValue`
2020-12-29 18:47:17 -05:00
Set variable value Action of type `Collision2DGameObject`. Inherits from `SetVariableValue<Collision2DGameObject, Collision2DGameObjectPair, Collision2DGameObjectVariable, Collision2DGameObjectConstant, Collision2DGameObjectReference, Collision2DGameObjectEvent, Collision2DGameObjectPairEvent, Collision2DGameObjectVariableInstancer>`.
2020-12-29 18:47:17 -05:00
---
## `SetCollisionGameObjectVariableValue`
2020-03-02 14:12:38 -05:00
Set variable value Action of type `CollisionGameObject`. Inherits from `SetVariableValue<CollisionGameObject, CollisionGameObjectPair, CollisionGameObjectVariable, CollisionGameObjectConstant, CollisionGameObjectReference, CollisionGameObjectEvent, CollisionGameObjectPairEvent, CollisionGameObjectVariableInstancer>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectCondition`
2020-12-29 18:47:17 -05:00
Condition of type `Collider2DGameObject`. Inherits from `AtomCondition<Collider2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectCondition`
2020-12-29 18:47:17 -05:00
Condition of type `ColliderGameObject`. Inherits from `AtomCondition<ColliderGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectCondition`
2020-03-02 14:12:38 -05:00
Condition of type `Collision2DGameObject`. Inherits from `AtomCondition<Collision2DGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `CollisionGameObjectCondition`
2020-03-02 14:12:38 -05:00
Condition of type `CollisionGameObject`. Inherits from `AtomCondition<CollisionGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectConstant`
2020-12-29 18:47:17 -05:00
Constant of type `Collider2DGameObject`. Inherits from `AtomBaseVariable<Collider2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectConstant`
2020-12-29 18:47:17 -05:00
Constant of type `ColliderGameObject`. Inherits from `AtomBaseVariable<ColliderGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectConstant`
2020-12-29 18:47:17 -05:00
Constant of type `Collision2DGameObject`. Inherits from `AtomBaseVariable<Collision2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectConstant`
2020-03-02 14:12:38 -05:00
Constant of type `CollisionGameObject`. Inherits from `AtomBaseVariable<CollisionGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectEventInstancer`
2020-03-02 14:12:38 -05:00
Event Instancer of type `Collider2DGameObject`. Inherits from `AtomEventInstancer<Collider2DGameObject, Collider2DGameObjectEvent>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectPairEventInstancer`
2020-03-02 14:12:38 -05:00
Event Instancer of type `Collider2DGameObjectPair`. Inherits from `AtomEventInstancer<Collider2DGameObjectPair, Collider2DGameObjectPairEvent>`.
2020-03-02 14:12:38 -05:00
---
## `ColliderGameObjectEventInstancer`
2020-12-29 18:47:17 -05:00
Event Instancer of type `ColliderGameObject`. Inherits from `AtomEventInstancer<ColliderGameObject, ColliderGameObjectEvent>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectPairEventInstancer`
2020-03-02 14:12:38 -05:00
Event Instancer of type `ColliderGameObjectPair`. Inherits from `AtomEventInstancer<ColliderGameObjectPair, ColliderGameObjectPairEvent>`.
2020-03-02 14:12:38 -05:00
---
## `Collision2DGameObjectEventInstancer`
2020-12-29 18:47:17 -05:00
Event Instancer of type `Collision2DGameObject`. Inherits from `AtomEventInstancer<Collision2DGameObject, Collision2DGameObjectEvent>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectPairEventInstancer`
2020-12-29 18:47:17 -05:00
Event Instancer of type `Collision2DGameObjectPair`. Inherits from `AtomEventInstancer<Collision2DGameObjectPair, Collision2DGameObjectPairEvent>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectEventInstancer`
2020-12-29 18:47:17 -05:00
Event Instancer of type `CollisionGameObject`. Inherits from `AtomEventInstancer<CollisionGameObject, CollisionGameObjectEvent>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectPairEventInstancer`
2020-03-02 14:12:38 -05:00
Event Instancer of type `CollisionGameObjectPair`. Inherits from `AtomEventInstancer<CollisionGameObjectPair, CollisionGameObjectPairEvent>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectEventReferenceListener`
2020-03-02 14:12:38 -05:00
Event Reference Listener of type `Collider2DGameObject`. Inherits from `AtomEventReferenceListener<Collider2DGameObject, Collider2DGameObjectEvent, Collider2DGameObjectEventReference, Collider2DGameObjectUnityEvent>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectPairEventReferenceListener`
2020-03-02 14:12:38 -05:00
Event Reference Listener of type `Collider2DGameObjectPair`. Inherits from `AtomEventReferenceListener<Collider2DGameObjectPair, Collider2DGameObjectPairEvent, Collider2DGameObjectPairEventReference, Collider2DGameObjectPairUnityEvent>`.
2020-03-02 14:12:38 -05:00
---
## `ColliderGameObjectEventReferenceListener`
2020-12-29 18:47:17 -05:00
Event Reference Listener of type `ColliderGameObject`. Inherits from `AtomEventReferenceListener<ColliderGameObject, ColliderGameObjectEvent, ColliderGameObjectEventReference, ColliderGameObjectUnityEvent>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectPairEventReferenceListener`
2020-03-02 14:12:38 -05:00
Event Reference Listener of type `ColliderGameObjectPair`. Inherits from `AtomEventReferenceListener<ColliderGameObjectPair, ColliderGameObjectPairEvent, ColliderGameObjectPairEventReference, ColliderGameObjectPairUnityEvent>`.
2020-03-02 14:12:38 -05:00
---
## `Collision2DGameObjectEventReferenceListener`
2020-12-29 18:47:17 -05:00
Event Reference Listener of type `Collision2DGameObject`. Inherits from `AtomEventReferenceListener<Collision2DGameObject, Collision2DGameObjectEvent, Collision2DGameObjectEventReference, Collision2DGameObjectUnityEvent>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectPairEventReferenceListener`
2020-03-02 14:12:38 -05:00
Event Reference Listener of type `Collision2DGameObjectPair`. Inherits from `AtomEventReferenceListener<Collision2DGameObjectPair, Collision2DGameObjectPairEvent, Collision2DGameObjectPairEventReference, Collision2DGameObjectPairUnityEvent>`.
2020-03-02 14:12:38 -05:00
---
## `CollisionGameObjectEventReferenceListener`
2020-12-29 18:47:17 -05:00
Event Reference Listener of type `CollisionGameObject`. Inherits from `AtomEventReferenceListener<CollisionGameObject, CollisionGameObjectEvent, CollisionGameObjectEventReference, CollisionGameObjectUnityEvent>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectPairEventReferenceListener`
2020-03-02 14:12:38 -05:00
Event Reference Listener of type `CollisionGameObjectPair`. Inherits from `AtomEventReferenceListener<CollisionGameObjectPair, CollisionGameObjectPairEvent, CollisionGameObjectPairEventReference, CollisionGameObjectPairUnityEvent>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectEventReference`
2020-12-29 18:47:17 -05:00
Event Reference of type `Collider2DGameObject`. Inherits from `AtomEventReference<Collider2DGameObject, Collider2DGameObjectVariable, Collider2DGameObjectEvent, Collider2DGameObjectVariableInstancer, Collider2DGameObjectEventInstancer>`.
2020-12-29 18:47:17 -05:00
---
## `Collider2DGameObjectPairEventReference`
2020-12-29 18:47:17 -05:00
Event Reference of type `Collider2DGameObjectPair`. Inherits from `AtomEventReference<Collider2DGameObjectPair, Collider2DGameObjectVariable, Collider2DGameObjectPairEvent, Collider2DGameObjectVariableInstancer, Collider2DGameObjectPairEventInstancer>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectEventReference`
2020-03-02 14:12:38 -05:00
Event Reference of type `ColliderGameObject`. Inherits from `AtomEventReference<ColliderGameObject, ColliderGameObjectVariable, ColliderGameObjectEvent, ColliderGameObjectVariableInstancer, ColliderGameObjectEventInstancer>`.
2020-03-02 14:12:38 -05:00
---
## `ColliderGameObjectPairEventReference`
2020-12-29 18:47:17 -05:00
Event Reference of type `ColliderGameObjectPair`. Inherits from `AtomEventReference<ColliderGameObjectPair, ColliderGameObjectVariable, ColliderGameObjectPairEvent, ColliderGameObjectVariableInstancer, ColliderGameObjectPairEventInstancer>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectEventReference`
2020-03-02 14:12:38 -05:00
Event Reference of type `Collision2DGameObject`. Inherits from `AtomEventReference<Collision2DGameObject, Collision2DGameObjectVariable, Collision2DGameObjectEvent, Collision2DGameObjectVariableInstancer, Collision2DGameObjectEventInstancer>`.
2020-03-02 14:12:38 -05:00
---
## `Collision2DGameObjectPairEventReference`
2020-12-29 18:47:17 -05:00
Event Reference of type `Collision2DGameObjectPair`. Inherits from `AtomEventReference<Collision2DGameObjectPair, Collision2DGameObjectVariable, Collision2DGameObjectPairEvent, Collision2DGameObjectVariableInstancer, Collision2DGameObjectPairEventInstancer>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectEventReference`
2020-12-29 18:47:17 -05:00
Event Reference of type `CollisionGameObject`. Inherits from `AtomEventReference<CollisionGameObject, CollisionGameObjectVariable, CollisionGameObjectEvent, CollisionGameObjectVariableInstancer, CollisionGameObjectEventInstancer>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectPairEventReference`
2020-03-02 14:12:38 -05:00
Event Reference of type `CollisionGameObjectPair`. Inherits from `AtomEventReference<CollisionGameObjectPair, CollisionGameObjectVariable, CollisionGameObjectPairEvent, CollisionGameObjectVariableInstancer, CollisionGameObjectPairEventInstancer>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectEvent`
2020-03-02 14:12:38 -05:00
Event of type `Collider2DGameObject`. Inherits from `AtomEvent<Collider2DGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectPairEvent`
2020-03-02 14:12:38 -05:00
Event of type `Collider2DGameObjectPair`. Inherits from `AtomEvent<Collider2DGameObjectPair>`.
2020-03-02 14:12:38 -05:00
---
## `ColliderGameObjectEvent`
2020-12-29 18:47:17 -05:00
Event of type `ColliderGameObject`. Inherits from `AtomEvent<ColliderGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectPairEvent`
2020-03-02 14:12:38 -05:00
Event of type `ColliderGameObjectPair`. Inherits from `AtomEvent<ColliderGameObjectPair>`.
2020-03-02 14:12:38 -05:00
---
## `Collision2DGameObjectEvent`
2020-12-29 18:47:17 -05:00
Event of type `Collision2DGameObject`. Inherits from `AtomEvent<Collision2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectPairEvent`
2019-10-15 19:43:51 -04:00
Event of type `Collision2DGameObjectPair`. Inherits from `AtomEvent<Collision2DGameObjectPair>`.
2019-10-15 19:43:51 -04:00
---
## `CollisionGameObjectEvent`
2020-03-02 14:12:38 -05:00
Event of type `CollisionGameObject`. Inherits from `AtomEvent<CollisionGameObject>`.
2020-03-02 14:12:38 -05:00
2019-10-15 19:43:51 -04:00
---
## `CollisionGameObjectPairEvent`
2019-10-15 19:43:51 -04:00
Event of type `CollisionGameObjectPair`. Inherits from `AtomEvent<CollisionGameObjectPair>`.
2019-10-15 19:43:51 -04:00
---
## `Collider2DGameObjectCollider2DGameObjectFunction`
2020-01-23 17:42:09 -05:00
Function x 2 of type `Collider2DGameObject`. Inherits from `AtomFunction<Collider2DGameObject, Collider2DGameObject>`.
2019-10-15 19:43:51 -04:00
---
## `ColliderGameObjectColliderGameObjectFunction`
2019-10-15 19:43:51 -04:00
Function x 2 of type `ColliderGameObject`. Inherits from `AtomFunction<ColliderGameObject, ColliderGameObject>`.
2019-10-15 19:43:51 -04:00
---
## `Collision2DGameObjectCollision2DGameObjectFunction`
2019-10-15 19:43:51 -04:00
Function x 2 of type `Collision2DGameObject`. Inherits from `AtomFunction<Collision2DGameObject, Collision2DGameObject>`.
2020-01-23 17:42:09 -05:00
---
## `CollisionGameObjectCollisionGameObjectFunction`
2020-01-23 17:42:09 -05:00
Function x 2 of type `CollisionGameObject`. Inherits from `AtomFunction<CollisionGameObject, CollisionGameObject>`.
2020-01-23 17:42:09 -05:00
---
## `Collider2DHook`
2020-01-23 17:42:09 -05:00
Base class for all `MonoHook`s of type `Collider2D`.
2020-01-23 17:42:09 -05:00
### Properties
2020-01-23 17:42:09 -05:00
#### `EventWithGameObject`
2020-01-23 17:42:09 -05:00
Event including a GameObject reference.
2019-10-15 19:43:51 -04:00
---
## `ColliderHook`
2020-12-29 18:47:17 -05:00
Base class for all `MonoHook`s of type `Collider`.
2020-12-29 18:47:17 -05:00
### Properties
2020-12-29 18:47:17 -05:00
#### `EventWithGameObject`
2020-12-29 18:47:17 -05:00
Event including a GameObject reference.
2020-12-29 18:47:17 -05:00
---
## `Collision2DHook`
2020-12-29 18:47:17 -05:00
Base class for all `MonoHook`s of type `Collision2D`.
2020-12-29 18:47:17 -05:00
### Properties
2020-12-29 18:47:17 -05:00
#### `EventWithGameObject`
2020-12-29 18:47:17 -05:00
Event including a GameObject reference.
2020-12-29 18:47:17 -05:00
---
## `CollisionHook`
2020-12-29 18:47:17 -05:00
Base class for all `MonoHook`s of type `Collision`.
2020-12-29 18:47:17 -05:00
### Properties
#### `EventWithGameObject`
Event including a GameObject reference.
---
2020-03-02 14:12:38 -05:00
## `MonoHook<E,EV,F>`
2019-10-15 19:43:51 -04:00
#### Type Parameters
2020-03-02 14:12:38 -05:00
- `E` - Event of type `AtomEvent<EV>`
2019-10-15 19:43:51 -04:00
- `EV` - Event value type
- `F` - Function type `AtomFunction<GameObject, GameObject>`
Generic base class for all Mono Hooks.
### Variables
2020-03-02 14:12:38 -05:00
#### `_selectGameObjectReference`
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
Selector function for the Event `EventWithGameObjectReference`. Makes it possible to for example select the parent GameObject and pass that a long to the `EventWithGameObjectReference`.
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
### Properties
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
#### `Event`
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
The Event
2019-10-15 19:43:51 -04:00
---
## `OnAwakeHook`
2020-12-29 18:47:17 -05:00
Mono Hook for [`Awake`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Awake.html).
2020-12-29 18:47:17 -05:00
### Variables
#### `_listener`
2020-12-29 18:47:17 -05:00
Listener
2020-12-29 18:47:17 -05:00
---
#### `_gameObjectListener`
2020-12-29 18:47:17 -05:00
Listener with GameObject reference
2020-12-29 18:47:17 -05:00
---
## `OnButtonClickHook`
2020-12-29 18:47:17 -05:00
Mono Hook for On Button Click
2020-12-29 18:47:17 -05:00
---
## `OnCollision2DHook`
2019-10-15 19:43:51 -04:00
Mono Hook for [`OnCollisionEnter2D`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnCollisionEnter2D.html), [`OnCollisionExit2D`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnCollisionExit2D.html) and [`OnCollisionStay2D`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnCollisionStay2D.html)
2019-10-15 19:43:51 -04:00
### Variables
2019-10-15 19:43:51 -04:00
#### `_collisionOnEnter`
2019-10-15 19:43:51 -04:00
Set to true if Event should be triggered on `OnCollisionEnter2D`
2019-10-15 19:43:51 -04:00
---
#### `_collisionOnExit`
2019-10-15 19:43:51 -04:00
Set to true if Event should be triggered on `OnCollisionExit2D`
2019-10-15 19:43:51 -04:00
---
#### `_collisionOnStay`
2019-10-15 19:43:51 -04:00
Set to true if Event should be triggered on `OnCollisionStay2D`
2019-10-15 19:43:51 -04:00
---
## `OnCollisionHook`
2020-12-29 18:47:17 -05:00
Mono Hook for [`OnCollisionEnter`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnCollisionEnter.html), [`OnCollisionExit`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnCollisionExit.html) and [`OnCollisionStay`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnCollisionStay.html)
2020-12-29 18:47:17 -05:00
### Variables
2020-12-29 18:47:17 -05:00
#### `_collisionOnEnter`
2020-12-29 18:47:17 -05:00
Set to true if Event should be triggered on `OnCollisionEnter`
2020-12-29 18:47:17 -05:00
---
#### `_collisionOnExit`
2019-10-15 19:43:51 -04:00
Set to true if Event should be triggered on `OnCollisionExit`
2019-10-15 19:43:51 -04:00
---
2020-03-02 14:12:38 -05:00
#### `_collisionOnStay`
2020-03-02 14:12:38 -05:00
Set to true if Event should be triggered on `OnCollisionStay`
2020-03-02 14:12:38 -05:00
2019-10-15 19:43:51 -04:00
---
## `OnDestroyHook`
2019-10-15 19:43:51 -04:00
Mono Hook for [`OnDestroy`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDestroy.html)
2019-10-15 19:43:51 -04:00
---
2019-10-15 19:43:51 -04:00
## `OnFixedUpdateHook`
2019-10-15 19:43:51 -04:00
Mono Hook for [`FixedUpdate`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.FixedUpdate.html)
2019-10-15 19:43:51 -04:00
---
## `OnLateUpdateHook`
2019-10-15 19:43:51 -04:00
Mono Hook for [`LateUpdate`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.LateUpdate.html)
---
## `OnPointerDownHook`
Mono Hook for `OnPointerDown`
2019-10-15 19:43:51 -04:00
---
2020-01-23 17:42:09 -05:00
## `OnStartHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Mono Hook for [`Start`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Start.html)
2019-10-15 19:43:51 -04:00
---
## `OnTrigger2DHook`
2019-10-15 19:43:51 -04:00
Mono Hook for [`OnTriggerEnter2D`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnTriggerEnter2D.html), [`OnTriggerExit2D`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnTriggerExit2D.html) and [`OnTriggerStay2D`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnTriggerStay2D.html)
2019-10-15 19:43:51 -04:00
2020-02-23 18:59:35 -05:00
### Variables
2019-10-15 19:43:51 -04:00
#### `_triggerOnEnter`
2019-10-15 19:43:51 -04:00
Set to true if Event should be triggered on `OnTriggerEnter2D`
2019-10-15 19:43:51 -04:00
---
#### `_triggerOnExit`
2019-10-15 19:43:51 -04:00
Set to true if Event should be triggered on `OnTriggerExit2D`
2019-10-15 19:43:51 -04:00
---
#### `_triggerOnStay`
2019-10-15 19:43:51 -04:00
Set to true if Event should be triggered on `OnTriggerStay2D`
2019-10-15 19:43:51 -04:00
---
## `OnTriggerHook`
2020-12-29 18:47:17 -05:00
Mono Hook for [`OnTriggerEnter`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnTriggerEnter.html), [`OnTriggerExit`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnTriggerExit.html) and [`OnTriggerStay`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnTriggerStay.html)
2020-12-29 18:47:17 -05:00
### Variables
2020-12-29 18:47:17 -05:00
#### `_triggerOnEnter`
2020-12-29 18:47:17 -05:00
Set to true if Event should be triggered on `OnTriggerEnter`
2020-12-29 18:47:17 -05:00
---
#### `_triggerOnExit`
2020-12-29 18:47:17 -05:00
Set to true if Event should be triggered on `OnTriggerExit`
2020-12-29 18:47:17 -05:00
---
#### `_triggerOnStay`
2020-12-29 18:47:17 -05:00
Set to true if Event should be triggered on `OnTriggerStay`
2020-12-29 18:47:17 -05:00
---
## `OnUpdateHook`
2020-03-02 14:12:38 -05:00
Mono Hook for [`Update`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Update.html)
2020-03-02 14:12:38 -05:00
---
## `VoidHook`
2020-12-29 18:47:17 -05:00
Base class for all `MonoHook`s of type `AtomEventBase`.
2020-12-29 18:47:17 -05:00
### Variables
2020-12-29 18:47:17 -05:00
#### `_event`
2020-12-29 18:47:17 -05:00
The Event
2020-12-29 18:47:17 -05:00
---
#### `_eventWithGameObjectReference`
2020-03-02 14:12:38 -05:00
Event including a GameObject reference.
2020-03-02 14:12:38 -05:00
---
#### `_selectGameObjectReference`
2020-12-29 18:47:17 -05:00
Selector function for the Event `EventWithGameObjectReference`. Makes it possible to for example select the parent GameObject and pass that a long to the `EventWithGameObjectReference`.
2020-12-29 18:47:17 -05:00
---
## `Collider2DGameObjectPair`
2020-03-02 14:12:38 -05:00
IPair of type `<Collider2DGameObject>`. Inherits from `IPair<Collider2DGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `ColliderGameObjectPair`
2020-03-02 14:12:38 -05:00
IPair of type `<ColliderGameObject>`. Inherits from `IPair<ColliderGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `Collision2DGameObjectPair`
2020-12-29 18:47:17 -05:00
IPair of type `<Collision2DGameObject>`. Inherits from `IPair<Collision2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectPair`
2020-12-29 18:47:17 -05:00
IPair of type `<CollisionGameObject>`. Inherits from `IPair<CollisionGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `Collider2DGameObjectReference`
2020-03-21 18:03:14 -04:00
Reference of type `Collider2DGameObject`. Inherits from `EquatableAtomReference<Collider2DGameObject, Collider2DGameObjectPair, Collider2DGameObjectConstant, Collider2DGameObjectVariable, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction, Collider2DGameObjectVariableInstancer, AtomCollection, AtomList>`.
2020-03-21 18:03:14 -04:00
---
## `ColliderGameObjectReference`
2020-12-29 18:47:17 -05:00
Reference of type `ColliderGameObject`. Inherits from `EquatableAtomReference<ColliderGameObject, ColliderGameObjectPair, ColliderGameObjectConstant, ColliderGameObjectVariable, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction, ColliderGameObjectVariableInstancer, AtomCollection, AtomList>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectReference`
2020-03-02 14:12:38 -05:00
Reference of type `Collision2DGameObject`. Inherits from `EquatableAtomReference<Collision2DGameObject, Collision2DGameObjectPair, Collision2DGameObjectConstant, Collision2DGameObjectVariable, Collision2DGameObjectEvent, Collision2DGameObjectPairEvent, Collision2DGameObjectCollision2DGameObjectFunction, Collision2DGameObjectVariableInstancer, AtomCollection, AtomList>`.
2020-03-02 14:12:38 -05:00
---
## `CollisionGameObjectReference`
2020-12-29 18:47:17 -05:00
Reference of type `CollisionGameObject`. Inherits from `EquatableAtomReference<CollisionGameObject, CollisionGameObjectPair, CollisionGameObjectConstant, CollisionGameObjectVariable, CollisionGameObjectEvent, CollisionGameObjectPairEvent, CollisionGameObjectCollisionGameObjectFunction, CollisionGameObjectVariableInstancer, AtomCollection, AtomList>`.
2020-12-29 18:47:17 -05:00
---
2020-03-21 18:03:14 -04:00
## `SyncCollider2DGameObjectVariableInstancerToCollection`
2020-03-02 14:12:38 -05:00
2020-03-21 18:03:14 -04:00
Adds Variable Instancer's Variable of type Collider2DGameObject to a Collection or List on OnEnable and removes it on OnDestroy.
---
## `SyncColliderGameObjectVariableInstancerToCollection`
Adds Variable Instancer's Variable of type ColliderGameObject to a Collection or List on OnEnable and removes it on OnDestroy.
2020-03-02 14:12:38 -05:00
---
## `SyncCollision2DGameObjectVariableInstancerToCollection`
Adds Variable Instancer's Variable of type Collision2DGameObject to a Collection or List on OnEnable and removes it on OnDestroy.
---
2020-12-29 18:47:17 -05:00
## `SyncCollisionGameObjectVariableInstancerToCollection`
Adds Variable Instancer's Variable of type CollisionGameObject to a Collection or List on OnEnable and removes it on OnDestroy.
---
## `Collider2DGameObjectPairUnityEvent`
2020-03-02 14:12:38 -05:00
None generic Unity Event of type `Collider2DGameObjectPair`. Inherits from `UnityEvent<Collider2DGameObjectPair>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectUnityEvent`
2020-12-29 18:47:17 -05:00
None generic Unity Event of type `Collider2DGameObject`. Inherits from `UnityEvent<Collider2DGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectPairUnityEvent`
2020-12-29 18:47:17 -05:00
None generic Unity Event of type `ColliderGameObjectPair`. Inherits from `UnityEvent<ColliderGameObjectPair>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectUnityEvent`
2020-12-29 18:47:17 -05:00
None generic Unity Event of type `ColliderGameObject`. Inherits from `UnityEvent<ColliderGameObject>`.
2020-12-29 18:47:17 -05:00
---
## `Collision2DGameObjectPairUnityEvent`
2019-10-15 19:43:51 -04:00
None generic Unity Event of type `Collision2DGameObjectPair`. Inherits from `UnityEvent<Collision2DGameObjectPair>`.
2019-10-15 19:43:51 -04:00
---
## `Collision2DGameObjectUnityEvent`
2019-10-15 19:43:51 -04:00
None generic Unity Event of type `Collision2DGameObject`. Inherits from `UnityEvent<Collision2DGameObject>`.
2020-03-02 14:12:38 -05:00
---
## `CollisionGameObjectPairUnityEvent`
2020-03-02 14:12:38 -05:00
None generic Unity Event of type `CollisionGameObjectPair`. Inherits from `UnityEvent<CollisionGameObjectPair>`.
2020-03-02 14:12:38 -05:00
---
## `CollisionGameObjectUnityEvent`
2020-12-29 18:47:17 -05:00
None generic Unity Event of type `CollisionGameObject`. Inherits from `UnityEvent<CollisionGameObject>`.
---
## `Collider2DGameObjectValueList`
Value List of type `Collider2DGameObject`. Inherits from `AtomValueList<Collider2DGameObject, Collider2DGameObjectEvent>`.
2020-12-29 18:47:17 -05:00
---
2020-03-02 14:12:38 -05:00
## `ColliderGameObjectValueList`
Value List of type `ColliderGameObject`. Inherits from `AtomValueList<ColliderGameObject, ColliderGameObjectEvent>`.
---
## `Collision2DGameObjectValueList`
Value List of type `Collision2DGameObject`. Inherits from `AtomValueList<Collision2DGameObject, Collision2DGameObjectEvent>`.
---
2020-12-29 18:47:17 -05:00
## `CollisionGameObjectValueList`
Value List of type `CollisionGameObject`. Inherits from `AtomValueList<CollisionGameObject, CollisionGameObjectEvent>`.
---
## `Collider2DGameObjectVariableInstancer`
2020-12-29 18:47:17 -05:00
Variable Instancer of type `Collider2DGameObject`. Inherits from `AtomVariableInstancer<Collider2DGameObjectVariable, Collider2DGameObjectPair, Collider2DGameObject, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectVariableInstancer`
2020-03-02 14:12:38 -05:00
Variable Instancer of type `ColliderGameObject`. Inherits from `AtomVariableInstancer<ColliderGameObjectVariable, ColliderGameObjectPair, ColliderGameObject, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction>`.
2020-03-02 14:12:38 -05:00
---
## `Collision2DGameObjectVariableInstancer`
2020-12-29 18:47:17 -05:00
Variable Instancer of type `Collision2DGameObject`. Inherits from `AtomVariableInstancer<Collision2DGameObjectVariable, Collision2DGameObjectPair, Collision2DGameObject, Collision2DGameObjectEvent, Collision2DGameObjectPairEvent, Collision2DGameObjectCollision2DGameObjectFunction>`.
2020-12-29 18:47:17 -05:00
---
## `CollisionGameObjectVariableInstancer`
2020-03-02 14:12:38 -05:00
Variable Instancer of type `CollisionGameObject`. Inherits from `AtomVariableInstancer<CollisionGameObjectVariable, CollisionGameObjectPair, CollisionGameObject, CollisionGameObjectEvent, CollisionGameObjectPairEvent, CollisionGameObjectCollisionGameObjectFunction>`.
2020-03-02 14:12:38 -05:00
---
## `Collider2DGameObjectVariable`
2020-12-29 18:47:17 -05:00
Variable of type `Collider2DGameObject`. Inherits from `EquatableAtomVariable<Collider2DGameObject, Collider2DGameObjectPair, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction>`.
2020-12-29 18:47:17 -05:00
---
## `ColliderGameObjectVariable`
2020-03-02 14:12:38 -05:00
Variable of type `ColliderGameObject`. Inherits from `EquatableAtomVariable<ColliderGameObject, ColliderGameObjectPair, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction>`.
---
## `Collision2DGameObjectVariable`
Variable of type `Collision2DGameObject`. Inherits from `EquatableAtomVariable<Collision2DGameObject, Collision2DGameObjectPair, Collision2DGameObjectEvent, Collision2DGameObjectPairEvent, Collision2DGameObjectCollision2DGameObjectFunction>`.
---
## `CollisionGameObjectVariable`
Variable of type `CollisionGameObject`. Inherits from `EquatableAtomVariable<CollisionGameObject, CollisionGameObjectPair, CollisionGameObjectEvent, CollisionGameObjectPairEvent, CollisionGameObjectCollisionGameObjectFunction>`.
2019-10-15 19:43:51 -04:00
---