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

429 lines
12 KiB
Markdown
Raw 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`
2020-03-02 14:12:38 -05:00
## `Collider2DGameObjectEventReferenceListener`
Event Reference Listener of type `Collider2DGameObject`. Inherits from `AtomEventReferenceListener<Collider2DGameObject, Collider2DGameObjectAction, Collider2DGameObjectEvent, Collider2DGameObjectEventReference, Collider2DGameObjectUnityEvent>`.
---
## `ColliderGameObjectEventReferenceListener`
Event Reference Listener of type `ColliderGameObject`. Inherits from `AtomEventReferenceListener<ColliderGameObject, ColliderGameObjectAction, ColliderGameObjectEvent, ColliderGameObjectEventReference, ColliderGameObjectUnityEvent>`.
---
## `Collider2DGameObjectPairEventReferenceListener`
Event Reference Listener of type `Collider2DGameObjectPair`. Inherits from `AtomEventReferenceListener<Collider2DGameObjectPair, Collider2DGameObjectPairAction, Collider2DGameObjectPairEvent, Collider2DGameObjectPairEventReference, Collider2DGameObjectPairUnityEvent>`.
---
## `ColliderGameObjectPairEventReferenceListener`
Event Reference Listener of type `ColliderGameObjectPair`. Inherits from `AtomEventReferenceListener<ColliderGameObjectPair, ColliderGameObjectPairAction, ColliderGameObjectPairEvent, ColliderGameObjectPairEventReference, ColliderGameObjectPairUnityEvent>`.
---
## `ColliderGameObjectReference`
Reference of type `ColliderGameObject`. Inherits from `EquatableAtomReference<ColliderGameObject, ColliderGameObjectPair, ColliderGameObjectConstant, ColliderGameObjectVariable, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction, ColliderGameObjectVariableInstancer>`.
---
## `Collider2DGameObjectReference`
Reference of type `Collider2DGameObject`. Inherits from `EquatableAtomReference<Collider2DGameObject, Collider2DGameObjectPair, Collider2DGameObjectConstant, Collider2DGameObjectVariable, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction, Collider2DGameObjectVariableInstancer>`.
---
## `Collider2DGameObjectPair`
IPair of type `<Collider2DGameObject>`. Inherits from `IPair<Collider2DGameObject>`.
---
## `ColliderGameObjectPair`
IPair of type `<ColliderGameObject>`. Inherits from `IPair<ColliderGameObject>`.
---
## `Collider2DGameObjectUnityEvent`
None generic Unity Event of type `Collider2DGameObject`. Inherits from `UnityEvent<Collider2DGameObject>`.
---
## `Collider2DGameObjectPairUnityEvent`
None generic Unity Event of type `Collider2DGameObjectPair`. Inherits from `UnityEvent<Collider2DGameObjectPair>`.
---
## `ColliderGameObjectPairUnityEvent`
None generic Unity Event of type `ColliderGameObjectPair`. Inherits from `UnityEvent<ColliderGameObjectPair>`.
---
## `ColliderGameObjectUnityEvent`
None generic Unity Event of type `ColliderGameObject`. Inherits from `UnityEvent<ColliderGameObject>`.
---
## `ColliderGameObjectConstant`
Constant of type `ColliderGameObject`. Inherits from `AtomBaseVariable<ColliderGameObject>`.
---
## `Collider2DGameObjectConstant`
Constant of type `Collider2DGameObject`. Inherits from `AtomBaseVariable<Collider2DGameObject>`.
---
## `ColliderGameObjectPairEventReference`
Event Reference of type `ColliderGameObjectPair`. Inherits from `AtomEventReference<ColliderGameObjectPair, ColliderGameObjectVariable, ColliderGameObjectPairEvent, ColliderGameObjectVariableInstancer, ColliderGameObjectPairEventInstancer>`.
---
## `Collider2DGameObjectEventReference`
Event Reference of type `Collider2DGameObject`. Inherits from `AtomEventReference<Collider2DGameObject, Collider2DGameObjectVariable, Collider2DGameObjectEvent, Collider2DGameObjectVariableInstancer, Collider2DGameObjectEventInstancer>`.
---
## `Collider2DGameObjectPairEventReference`
Event Reference of type `Collider2DGameObjectPair`. Inherits from `AtomEventReference<Collider2DGameObjectPair, Collider2DGameObjectVariable, Collider2DGameObjectPairEvent, Collider2DGameObjectVariableInstancer, Collider2DGameObjectPairEventInstancer>`.
---
## `ColliderGameObjectEventReference`
Event Reference of type `ColliderGameObject`. Inherits from `AtomEventReference<ColliderGameObject, ColliderGameObjectVariable, ColliderGameObjectEvent, ColliderGameObjectVariableInstancer, ColliderGameObjectEventInstancer>`.
---
## `ColliderGameObjectVariableInstancer`
Variable Instancer of type `ColliderGameObject`. Inherits from `AtomVariableInstancer<ColliderGameObjectVariable, ColliderGameObjectPair, ColliderGameObject, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction>`.
---
## `Collider2DGameObjectVariableInstancer`
Variable Instancer of type `Collider2DGameObject`. Inherits from `AtomVariableInstancer<Collider2DGameObjectVariable, Collider2DGameObjectPair, Collider2DGameObject, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction>`.
---
## `ColliderGameObjectEventInstancer`
Event Instancer of type `ColliderGameObject`. Inherits from `AtomEventInstancer<ColliderGameObject, ColliderGameObjectEvent>`.
---
## `Collider2DGameObjectPairEventInstancer`
Event Instancer of type `Collider2DGameObjectPair`. Inherits from `AtomEventInstancer<Collider2DGameObjectPair, Collider2DGameObjectPairEvent>`.
---
## `ColliderGameObjectPairEventInstancer`
Event Instancer of type `ColliderGameObjectPair`. Inherits from `AtomEventInstancer<ColliderGameObjectPair, ColliderGameObjectPairEvent>`.
---
## `Collider2DGameObjectEventInstancer`
Event Instancer of type `Collider2DGameObject`. Inherits from `AtomEventInstancer<Collider2DGameObject, Collider2DGameObjectEvent>`.
---
## `Collider2DGameObjectVariable`
Variable of type `Collider2DGameObject`. Inherits from `EquatableAtomVariable<Collider2DGameObject, Collider2DGameObjectPair, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction>`.
---
## `ColliderGameObjectVariable`
Variable of type `ColliderGameObject`. Inherits from `EquatableAtomVariable<ColliderGameObject, ColliderGameObjectPair, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction>`.
---
2020-01-23 17:42:09 -05:00
## `OnDestroyHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Mono Hook for [`OnDestroy`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDestroy.html)
2019-10-15 19:43:51 -04:00
---
2020-01-23 17:42:09 -05:00
## `ColliderHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Base class for all `MonoHook`s of type `Collider`.
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
### Properties
#### `EventWithGameObject`
Event including a GameObject reference.
2019-10-15 19:43:51 -04:00
---
2020-01-23 17:42:09 -05:00
## `OnUpdateHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Mono Hook for [`Update`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Update.html)
2019-10-15 19:43:51 -04:00
---
2020-01-23 17:42:09 -05:00
## `OnTrigger2DHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05: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)
### Variables
#### `_triggerOnEnter`
Set to true if Event should be triggered on `OnTriggerEnter2D`
2019-10-15 19:43:51 -04:00
---
2020-01-23 17:42:09 -05:00
#### `_triggerOnExit`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Set to true if Event should be triggered on `OnTriggerExit2D`
2019-10-15 19:43:51 -04:00
---
2020-01-23 17:42:09 -05:00
#### `_triggerOnStay`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Set to true if Event should be triggered on `OnTriggerStay2D`
---
## `OnTriggerHook`
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)
### Variables
#### `_triggerOnEnter`
Set to true if Event should be triggered on `OnTriggerEnter`
---
#### `_triggerOnExit`
Set to true if Event should be triggered on `OnTriggerExit`
---
#### `_triggerOnStay`
Set to true if Event should be triggered on `OnTriggerStay`
2019-10-15 19:43:51 -04:00
---
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
---
2020-01-23 17:42:09 -05:00
## `OnLateUpdateHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Mono Hook for [`LateUpdate`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.LateUpdate.html)
2019-10-15 19:43:51 -04:00
---
## `OnButtonClickHook`
Mono Hook for On Button Click
---
## `OnFixedUpdateHook`
Mono Hook for [`FixedUpdate`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.FixedUpdate.html)
---
## `OnPointerDownHook`
Mono Hook for `OnPointerDown`
---
2020-01-23 17:42:09 -05:00
## `Collider2DHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Base class for all `MonoHook`s of type `Collider2D`.
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
### Properties
#### `EventWithGameObject`
Event including a GameObject reference.
2019-10-15 19:43:51 -04:00
---
2020-01-23 17:42:09 -05:00
## `OnAwakeHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Mono Hook for [`Awake`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Awake.html).
2019-10-15 19:43:51 -04:00
### Variables
2020-01-23 17:42:09 -05:00
#### `_listener`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Listener
2019-10-15 19:43:51 -04:00
---
2020-02-23 18:59:35 -05:00
#### `_gameObjectListener`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Listener with GameObject reference
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
---
2020-01-23 17:42:09 -05:00
## `VoidHook`
2019-10-15 19:43:51 -04:00
2020-01-23 17:42:09 -05:00
Base class for all `MonoHook`s of type `Void`.
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
2020-02-23 18:59:35 -05:00
#### `_event`
2019-10-15 19:43:51 -04:00
2020-02-23 18:59:35 -05:00
The Event
2019-10-15 19:43:51 -04:00
---
2020-02-23 18:59:35 -05:00
#### `_eventWithGameObjectReference`
2019-10-15 19:43:51 -04:00
2020-02-23 18:59:35 -05:00
Event including a GameObject reference.
2019-10-15 19:43:51 -04:00
---
2020-02-23 18:59:35 -05:00
#### `_selectGameObjectReference`
2019-10-15 19:43:51 -04:00
2020-02-23 18:59:35 -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
## `Collider2DGameObjectAction`
Action of type `Collider2DGameObject`. Inherits from `AtomAction<Collider2DGameObject>`.
---
## `Collider2DGameObjectPairAction`
Action of type `Collider2DGameObjectPair`. Inherits from `AtomAction<Collider2DGameObjectPair>`.
---
## `ColliderGameObjectPairAction`
Action of type `ColliderGameObjectPair`. Inherits from `AtomAction<ColliderGameObjectPair>`.
---
## `ColliderGameObjectAction`
Action of type `ColliderGameObject`. Inherits from `AtomAction<ColliderGameObject>`.
---
## `ColliderGameObjectColliderGameObjectFunction`
Function x 2 of type `ColliderGameObject`. Inherits from `AtomFunction<ColliderGameObject, ColliderGameObject>`.
---
## `Collider2DGameObjectCollider2DGameObjectFunction`
Function x 2 of type `Collider2DGameObject`. Inherits from `AtomFunction<Collider2DGameObject, Collider2DGameObject>`.
---
## `ColliderGameObjectPairEvent`
Event of type `ColliderGameObjectPair`. Inherits from `AtomEvent<ColliderGameObjectPair>`.
---
2020-02-23 18:59:35 -05:00
## `ColliderGameObjectEvent`
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
Event of type `ColliderGameObject`. Inherits from `AtomEvent<ColliderGameObject>`.
2019-10-15 19:43:51 -04:00
---
2020-02-23 18:59:35 -05:00
## `Collider2DGameObjectEvent`
2019-10-15 19:43:51 -04:00
2020-03-02 14:12:38 -05:00
Event of type `Collider2DGameObject`. Inherits from `AtomEvent<Collider2DGameObject>`.
---
## `Collider2DGameObjectPairEvent`
Event of type `Collider2DGameObjectPair`. Inherits from `AtomEvent<Collider2DGameObjectPair>`.
---
## `ColliderGameObjectValueList`
Value List of type `ColliderGameObject`. Inherits from `AtomValueList<ColliderGameObject, ColliderGameObjectEvent>`.
---
## `Collider2DGameObjectValueList`
Value List of type `Collider2DGameObject`. Inherits from `AtomValueList<Collider2DGameObject, Collider2DGameObjectEvent>`.
---
## `SetCollider2DGameObjectVariableValue`
Set variable value Action of type `Collider2DGameObject`. Inherits from `SetVariableValue<Collider2DGameObject, Collider2DGameObjectPair, Collider2DGameObjectVariable, Collider2DGameObjectConstant, Collider2DGameObjectReference, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectVariableInstancer>`.
---
## `SetColliderGameObjectVariableValue`
Set variable value Action of type `ColliderGameObject`. Inherits from `SetVariableValue<ColliderGameObject, ColliderGameObjectPair, ColliderGameObjectVariable, ColliderGameObjectConstant, ColliderGameObjectReference, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectVariableInstancer>`.
2019-10-15 19:43:51 -04:00
---