caleb-brown/unity-atoms
1
0
Fork 0
mirror of https://github.com/unity-atoms/unity-atoms.git synced 2025-01-22 16:18:24 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
v4.4.4
unity-atoms/docs/api/unityatoms.monohooks.md
Miika Lönnqvist 3b39e6a2f1
Prepare for release of 4.4.4 (#343) 
* Update CHANGELOG

* Update version in documentation to 4.4.4

* Remove reference to Examples directory

* Update package-lock.json

* Update API documentation
2022-04-17 22:52:38 +02:00

23 KiB
Raw Permalink Blame History

id title hide_title sidebar_label
unityatoms.monohooks UnityAtoms.MonoHooks true UnityAtoms.MonoHooks

Namespace - UnityAtoms.MonoHooks

Collider2DGameObjectAction

Action of type Collider2DGameObject. Inherits from AtomAction<Collider2DGameObject>.

Collider2DGameObjectPairAction

Action of type Collider2DGameObjectPair. Inherits from AtomAction<Collider2DGameObjectPair>.

ColliderGameObjectAction

Action of type ColliderGameObject. Inherits from AtomAction<ColliderGameObject>.

ColliderGameObjectPairAction

Action of type ColliderGameObjectPair. Inherits from AtomAction<ColliderGameObjectPair>.

Collision2DGameObjectAction

Action of type Collision2DGameObject. Inherits from AtomAction<Collision2DGameObject>.

Collision2DGameObjectPairAction

Action of type Collision2DGameObjectPair. Inherits from AtomAction<Collision2DGameObjectPair>.

CollisionGameObjectAction

Action of type CollisionGameObject. Inherits from AtomAction<CollisionGameObject>.

CollisionGameObjectPairAction

Action of type CollisionGameObjectPair. Inherits from AtomAction<CollisionGameObjectPair>.

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>.

SetCollision2DGameObjectVariableValue

Set variable value Action of type Collision2DGameObject. Inherits from SetVariableValue<Collision2DGameObject, Collision2DGameObjectPair, Collision2DGameObjectVariable, Collision2DGameObjectConstant, Collision2DGameObjectReference, Collision2DGameObjectEvent, Collision2DGameObjectPairEvent, Collision2DGameObjectVariableInstancer>.

SetCollisionGameObjectVariableValue

Set variable value Action of type CollisionGameObject. Inherits from SetVariableValue<CollisionGameObject, CollisionGameObjectPair, CollisionGameObjectVariable, CollisionGameObjectConstant, CollisionGameObjectReference, CollisionGameObjectEvent, CollisionGameObjectPairEvent, CollisionGameObjectVariableInstancer>.

Collider2DGameObjectCondition

Condition of type Collider2DGameObject. Inherits from AtomCondition<Collider2DGameObject>.

ColliderGameObjectCondition

Condition of type ColliderGameObject. Inherits from AtomCondition<ColliderGameObject>.

Collision2DGameObjectCondition

Condition of type Collision2DGameObject. Inherits from AtomCondition<Collision2DGameObject>.

CollisionGameObjectCondition

Condition of type CollisionGameObject. Inherits from AtomCondition<CollisionGameObject>.

Collider2DGameObjectConstant

Constant of type Collider2DGameObject. Inherits from AtomBaseVariable<Collider2DGameObject>.

ColliderGameObjectConstant

Constant of type ColliderGameObject. Inherits from AtomBaseVariable<ColliderGameObject>.

Collision2DGameObjectConstant

Constant of type Collision2DGameObject. Inherits from AtomBaseVariable<Collision2DGameObject>.

CollisionGameObjectConstant

Constant of type CollisionGameObject. Inherits from AtomBaseVariable<CollisionGameObject>.

Collider2DGameObjectEventInstancer

Event Instancer of type Collider2DGameObject. Inherits from AtomEventInstancer<Collider2DGameObject, Collider2DGameObjectEvent>.

Collider2DGameObjectPairEventInstancer

Event Instancer of type Collider2DGameObjectPair. Inherits from AtomEventInstancer<Collider2DGameObjectPair, Collider2DGameObjectPairEvent>.

ColliderGameObjectEventInstancer

Event Instancer of type ColliderGameObject. Inherits from AtomEventInstancer<ColliderGameObject, ColliderGameObjectEvent>.

ColliderGameObjectPairEventInstancer

Event Instancer of type ColliderGameObjectPair. Inherits from AtomEventInstancer<ColliderGameObjectPair, ColliderGameObjectPairEvent>.

Collision2DGameObjectEventInstancer

Event Instancer of type Collision2DGameObject. Inherits from AtomEventInstancer<Collision2DGameObject, Collision2DGameObjectEvent>.

Collision2DGameObjectPairEventInstancer

Event Instancer of type Collision2DGameObjectPair. Inherits from AtomEventInstancer<Collision2DGameObjectPair, Collision2DGameObjectPairEvent>.

CollisionGameObjectEventInstancer

Event Instancer of type CollisionGameObject. Inherits from AtomEventInstancer<CollisionGameObject, CollisionGameObjectEvent>.

CollisionGameObjectPairEventInstancer

Event Instancer of type CollisionGameObjectPair. Inherits from AtomEventInstancer<CollisionGameObjectPair, CollisionGameObjectPairEvent>.

Collider2DGameObjectEventReferenceListener

Event Reference Listener of type Collider2DGameObject. Inherits from AtomEventReferenceListener<Collider2DGameObject, Collider2DGameObjectEvent, Collider2DGameObjectEventReference, Collider2DGameObjectUnityEvent>.

Collider2DGameObjectPairEventReferenceListener

Event Reference Listener of type Collider2DGameObjectPair. Inherits from AtomEventReferenceListener<Collider2DGameObjectPair, Collider2DGameObjectPairEvent, Collider2DGameObjectPairEventReference, Collider2DGameObjectPairUnityEvent>.

ColliderGameObjectEventReferenceListener

Event Reference Listener of type ColliderGameObject. Inherits from AtomEventReferenceListener<ColliderGameObject, ColliderGameObjectEvent, ColliderGameObjectEventReference, ColliderGameObjectUnityEvent>.

ColliderGameObjectPairEventReferenceListener

Event Reference Listener of type ColliderGameObjectPair. Inherits from AtomEventReferenceListener<ColliderGameObjectPair, ColliderGameObjectPairEvent, ColliderGameObjectPairEventReference, ColliderGameObjectPairUnityEvent>.

Collision2DGameObjectEventReferenceListener

Event Reference Listener of type Collision2DGameObject. Inherits from AtomEventReferenceListener<Collision2DGameObject, Collision2DGameObjectEvent, Collision2DGameObjectEventReference, Collision2DGameObjectUnityEvent>.

Collision2DGameObjectPairEventReferenceListener

Event Reference Listener of type Collision2DGameObjectPair. Inherits from AtomEventReferenceListener<Collision2DGameObjectPair, Collision2DGameObjectPairEvent, Collision2DGameObjectPairEventReference, Collision2DGameObjectPairUnityEvent>.

CollisionGameObjectEventReferenceListener

Event Reference Listener of type CollisionGameObject. Inherits from AtomEventReferenceListener<CollisionGameObject, CollisionGameObjectEvent, CollisionGameObjectEventReference, CollisionGameObjectUnityEvent>.

CollisionGameObjectPairEventReferenceListener

Event Reference Listener of type CollisionGameObjectPair. Inherits from AtomEventReferenceListener<CollisionGameObjectPair, CollisionGameObjectPairEvent, CollisionGameObjectPairEventReference, CollisionGameObjectPairUnityEvent>.

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>.

ColliderGameObjectPairEventReference

Event Reference of type ColliderGameObjectPair. Inherits from AtomEventReference<ColliderGameObjectPair, ColliderGameObjectVariable, ColliderGameObjectPairEvent, ColliderGameObjectVariableInstancer, ColliderGameObjectPairEventInstancer>.

Collision2DGameObjectEventReference

Event Reference of type Collision2DGameObject. Inherits from AtomEventReference<Collision2DGameObject, Collision2DGameObjectVariable, Collision2DGameObjectEvent, Collision2DGameObjectVariableInstancer, Collision2DGameObjectEventInstancer>.

Collision2DGameObjectPairEventReference

Event Reference of type Collision2DGameObjectPair. Inherits from AtomEventReference<Collision2DGameObjectPair, Collision2DGameObjectVariable, Collision2DGameObjectPairEvent, Collision2DGameObjectVariableInstancer, Collision2DGameObjectPairEventInstancer>.

CollisionGameObjectEventReference

Event Reference of type CollisionGameObject. Inherits from AtomEventReference<CollisionGameObject, CollisionGameObjectVariable, CollisionGameObjectEvent, CollisionGameObjectVariableInstancer, CollisionGameObjectEventInstancer>.

CollisionGameObjectPairEventReference

Event Reference of type CollisionGameObjectPair. Inherits from AtomEventReference<CollisionGameObjectPair, CollisionGameObjectVariable, CollisionGameObjectPairEvent, CollisionGameObjectVariableInstancer, CollisionGameObjectPairEventInstancer>.

Collider2DGameObjectEvent

Event of type Collider2DGameObject. Inherits from AtomEvent<Collider2DGameObject>.

Collider2DGameObjectPairEvent

Event of type Collider2DGameObjectPair. Inherits from AtomEvent<Collider2DGameObjectPair>.

ColliderGameObjectEvent

Event of type ColliderGameObject. Inherits from AtomEvent<ColliderGameObject>.

ColliderGameObjectPairEvent

Event of type ColliderGameObjectPair. Inherits from AtomEvent<ColliderGameObjectPair>.

Collision2DGameObjectEvent

Event of type Collision2DGameObject. Inherits from AtomEvent<Collision2DGameObject>.

Collision2DGameObjectPairEvent

Event of type Collision2DGameObjectPair. Inherits from AtomEvent<Collision2DGameObjectPair>.

CollisionGameObjectEvent

Event of type CollisionGameObject. Inherits from AtomEvent<CollisionGameObject>.

CollisionGameObjectPairEvent

Event of type CollisionGameObjectPair. Inherits from AtomEvent<CollisionGameObjectPair>.

Collider2DGameObjectCollider2DGameObjectFunction

Function x 2 of type Collider2DGameObject. Inherits from AtomFunction<Collider2DGameObject, Collider2DGameObject>.

ColliderGameObjectColliderGameObjectFunction

Function x 2 of type ColliderGameObject. Inherits from AtomFunction<ColliderGameObject, ColliderGameObject>.

Collision2DGameObjectCollision2DGameObjectFunction

Function x 2 of type Collision2DGameObject. Inherits from AtomFunction<Collision2DGameObject, Collision2DGameObject>.

CollisionGameObjectCollisionGameObjectFunction

Function x 2 of type CollisionGameObject. Inherits from AtomFunction<CollisionGameObject, CollisionGameObject>.

Collider2DHook

Base class for all MonoHooks of type Collider2D.

Properties

EventWithGameObject

Event including a GameObject reference.

ColliderHook

Base class for all MonoHooks of type Collider.

Properties

EventWithGameObject

Event including a GameObject reference.

Collision2DHook

Base class for all MonoHooks of type Collision2D.

Properties

EventWithGameObject

Event including a GameObject reference.

CollisionHook

Base class for all MonoHooks of type Collision.

Properties

EventWithGameObject

Event including a GameObject reference.

MonoHook<E,EV,F>

Type Parameters

  • E - Event of type AtomEvent<EV>
  • EV - Event value type
  • F - Function type AtomFunction<GameObject, GameObject>

Generic base class for all Mono Hooks.

Variables

_selectGameObjectReference

Selector function for the Event EventWithGameObjectReference. Makes it possible to for example select the parent GameObject and pass that a long to the EventWithGameObjectReference.

Properties

Event

The Event

OnAwakeHook

Mono Hook for Awake.

Variables

_listener

Listener

_gameObjectListener

Listener with GameObject reference

OnButtonClickHook

Mono Hook for On Button Click

OnCollision2DHook

Mono Hook for OnCollisionEnter2D, OnCollisionExit2D and OnCollisionStay2D

Variables

_collisionOnEnter

Set to true if Event should be triggered on OnCollisionEnter2D

_collisionOnExit

Set to true if Event should be triggered on OnCollisionExit2D

_collisionOnStay

Set to true if Event should be triggered on OnCollisionStay2D

OnCollisionHook

Mono Hook for OnCollisionEnter, OnCollisionExit and OnCollisionStay

Variables

_collisionOnEnter

Set to true if Event should be triggered on OnCollisionEnter

_collisionOnExit

Set to true if Event should be triggered on OnCollisionExit

_collisionOnStay

Set to true if Event should be triggered on OnCollisionStay

OnDestroyHook

Mono Hook for OnDestroy

OnFixedUpdateHook

Mono Hook for FixedUpdate

OnLateUpdateHook

Mono Hook for LateUpdate

OnPointerDownHook

Mono Hook for OnPointerDown

OnStartHook

Mono Hook for Start

OnTrigger2DHook

Mono Hook for OnTriggerEnter2D, OnTriggerExit2D and OnTriggerStay2D

Variables

_triggerOnEnter

Set to true if Event should be triggered on OnTriggerEnter2D

_triggerOnExit

Set to true if Event should be triggered on OnTriggerExit2D

_triggerOnStay

Set to true if Event should be triggered on OnTriggerStay2D

OnTriggerHook

Mono Hook for OnTriggerEnter, OnTriggerExit and OnTriggerStay

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

OnUpdateHook

Mono Hook for Update

VoidHook

Base class for all MonoHooks of type AtomEventBase.

Variables

_event

The Event

_eventWithGameObjectReference

Event including a GameObject reference.

_selectGameObjectReference

Selector function for the Event EventWithGameObjectReference. Makes it possible to for example select the parent GameObject and pass that a long to the EventWithGameObjectReference.

Collider2DGameObjectPair

IPair of type <Collider2DGameObject>. Inherits from IPair<Collider2DGameObject>.

ColliderGameObjectPair

IPair of type <ColliderGameObject>. Inherits from IPair<ColliderGameObject>.

Collision2DGameObjectPair

IPair of type <Collision2DGameObject>. Inherits from IPair<Collision2DGameObject>.

CollisionGameObjectPair

IPair of type <CollisionGameObject>. Inherits from IPair<CollisionGameObject>.

Collider2DGameObjectReference

Reference of type Collider2DGameObject. Inherits from EquatableAtomReference<Collider2DGameObject, Collider2DGameObjectPair, Collider2DGameObjectConstant, Collider2DGameObjectVariable, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction, Collider2DGameObjectVariableInstancer, AtomCollection, AtomList>.

ColliderGameObjectReference

Reference of type ColliderGameObject. Inherits from EquatableAtomReference<ColliderGameObject, ColliderGameObjectPair, ColliderGameObjectConstant, ColliderGameObjectVariable, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction, ColliderGameObjectVariableInstancer, AtomCollection, AtomList>.

Collision2DGameObjectReference

Reference of type Collision2DGameObject. Inherits from EquatableAtomReference<Collision2DGameObject, Collision2DGameObjectPair, Collision2DGameObjectConstant, Collision2DGameObjectVariable, Collision2DGameObjectEvent, Collision2DGameObjectPairEvent, Collision2DGameObjectCollision2DGameObjectFunction, Collision2DGameObjectVariableInstancer, AtomCollection, AtomList>.

CollisionGameObjectReference

Reference of type CollisionGameObject. Inherits from EquatableAtomReference<CollisionGameObject, CollisionGameObjectPair, CollisionGameObjectConstant, CollisionGameObjectVariable, CollisionGameObjectEvent, CollisionGameObjectPairEvent, CollisionGameObjectCollisionGameObjectFunction, CollisionGameObjectVariableInstancer, AtomCollection, AtomList>.

SyncCollider2DGameObjectVariableInstancerToCollection

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.

SyncCollision2DGameObjectVariableInstancerToCollection

Adds Variable Instancer's Variable of type Collision2DGameObject to a Collection or List on OnEnable and removes it on OnDestroy.

SyncCollisionGameObjectVariableInstancerToCollection

Adds Variable Instancer's Variable of type CollisionGameObject to a Collection or List on OnEnable and removes it on OnDestroy.

Collider2DGameObjectPairUnityEvent

None generic Unity Event of type Collider2DGameObjectPair. Inherits from UnityEvent<Collider2DGameObjectPair>.

Collider2DGameObjectUnityEvent

None generic Unity Event of type Collider2DGameObject. Inherits from UnityEvent<Collider2DGameObject>.

ColliderGameObjectPairUnityEvent

None generic Unity Event of type ColliderGameObjectPair. Inherits from UnityEvent<ColliderGameObjectPair>.

ColliderGameObjectUnityEvent

None generic Unity Event of type ColliderGameObject. Inherits from UnityEvent<ColliderGameObject>.

Collision2DGameObjectPairUnityEvent

None generic Unity Event of type Collision2DGameObjectPair. Inherits from UnityEvent<Collision2DGameObjectPair>.

Collision2DGameObjectUnityEvent

None generic Unity Event of type Collision2DGameObject. Inherits from UnityEvent<Collision2DGameObject>.

CollisionGameObjectPairUnityEvent

None generic Unity Event of type CollisionGameObjectPair. Inherits from UnityEvent<CollisionGameObjectPair>.

CollisionGameObjectUnityEvent

None generic Unity Event of type CollisionGameObject. Inherits from UnityEvent<CollisionGameObject>.

Collider2DGameObjectValueList

Value List of type Collider2DGameObject. Inherits from AtomValueList<Collider2DGameObject, Collider2DGameObjectEvent>.

ColliderGameObjectValueList

Value List of type ColliderGameObject. Inherits from AtomValueList<ColliderGameObject, ColliderGameObjectEvent>.

Collision2DGameObjectValueList

Value List of type Collision2DGameObject. Inherits from AtomValueList<Collision2DGameObject, Collision2DGameObjectEvent>.

CollisionGameObjectValueList

Value List of type CollisionGameObject. Inherits from AtomValueList<CollisionGameObject, CollisionGameObjectEvent>.

Collider2DGameObjectVariableInstancer

Variable Instancer of type Collider2DGameObject. Inherits from AtomVariableInstancer<Collider2DGameObjectVariable, Collider2DGameObjectPair, Collider2DGameObject, Collider2DGameObjectEvent, Collider2DGameObjectPairEvent, Collider2DGameObjectCollider2DGameObjectFunction>.

ColliderGameObjectVariableInstancer

Variable Instancer of type ColliderGameObject. Inherits from AtomVariableInstancer<ColliderGameObjectVariable, ColliderGameObjectPair, ColliderGameObject, ColliderGameObjectEvent, ColliderGameObjectPairEvent, ColliderGameObjectColliderGameObjectFunction>.

Collision2DGameObjectVariableInstancer

Variable Instancer of type Collision2DGameObject. Inherits from AtomVariableInstancer<Collision2DGameObjectVariable, Collision2DGameObjectPair, Collision2DGameObject, Collision2DGameObjectEvent, Collision2DGameObjectPairEvent, Collision2DGameObjectCollision2DGameObjectFunction>.

CollisionGameObjectVariableInstancer

Variable Instancer of type CollisionGameObject. Inherits from AtomVariableInstancer<CollisionGameObjectVariable, CollisionGameObjectPair, CollisionGameObject, CollisionGameObjectEvent, CollisionGameObjectPairEvent, CollisionGameObjectCollisionGameObjectFunction>.

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>.

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>.