From 3b39e6a2f17a1c948e0a11d170c9e4ddd0554511 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Miika=20L=C3=B6nnqvist?= Date: Sun, 17 Apr 2022 22:52:38 +0200 Subject: [PATCH] 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 --- .gitignore | 5 +- CHANGELOG.md | 36 +- CONTRIBUTING.md | 5 +- Packages/BaseAtoms/package.json | 4 +- Packages/Core/package.json | 2 +- Packages/FSM/package.json | 6 +- Packages/InputSystem/package.json | 6 +- Packages/Mobile/package.json | 6 +- Packages/MonoHooks/package.json | 6 +- Packages/SceneMgmt/package.json | 6 +- Packages/Tags/package.json | 6 +- Packages/UI/package.json | 6 +- README.md | 18 +- docs/api/unityatoms.baseatoms.editor.md | 1212 +++--- docs/api/unityatoms.baseatoms.md | 4526 ++++++++++----------- docs/api/unityatoms.editor.md | 324 +- docs/api/unityatoms.fsm.editor.md | 32 +- docs/api/unityatoms.fsm.md | 120 +- docs/api/unityatoms.inputsystem.editor.md | 24 +- docs/api/unityatoms.inputsystem.md | 32 +- docs/api/unityatoms.md | 1768 ++++---- docs/api/unityatoms.mobile.editor.md | 56 +- docs/api/unityatoms.mobile.md | 240 +- docs/api/unityatoms.monohooks.editor.md | 244 +- docs/api/unityatoms.monohooks.md | 868 ++-- docs/api/unityatoms.scenemgmt.editor.md | 56 +- docs/api/unityatoms.scenemgmt.md | 248 +- docs/api/unityatoms.tags.md | 288 +- docs/introduction/installation.md | 18 +- package-lock.json | 631 ++- package.json | 2 +- 31 files changed, 5733 insertions(+), 5068 deletions(-) diff --git a/.gitignore b/.gitignore index c1940679..bb79dd83 100644 --- a/.gitignore +++ b/.gitignore @@ -51,4 +51,7 @@ node_modules /docs/**/*.meta /scripts/**/*.meta /website/**/*.meta -/*.meta \ No newline at end of file +/*.meta + +# Ignore Examples directory if used +/Examples \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index 937bb240..5512a005 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,21 +6,47 @@ πŸ’… = Polish πŸš€ = New features -# 4.4.4 (TODO: UPDATE THE DATE ON MERGE DAY) +# 4.4.4 (March 15, 2022) + +- [@Casey-Hofland](https://github.com/Casey-Hofland) has left Unity Atoms as a maintainer. We wish Casey all the best and thank him for his contributions and help! +- [@ThimoDEV](https://github.com/ThimoDEV) has joined as maintainer of Unity Atoms! πŸ₯³ ## πŸ› Bug fixes -- [#300](https://github.com/unity-atoms/unity-atoms/pull/300) Fixed Serialization on AtomCollections. +- [#340](https://github.com/unity-atoms/unity-atoms/pull/340) Fix NullReferenceException when Event Reference Listeners event reference is not set ([@ThimoDEV](https://github.com/ThimoDEV)) +- [#280](https://github.com/unity-atoms/unity-atoms/pull/289) Fix hasChildren display in AtomReferences ([@Casey-Hofland](https://github.com/Casey-Hofland)) +- [#270](https://github.com/unity-atoms/unity-atoms/pull/270) Fix ChangedOnOnEnable not triggered ([@simonbucher](https://github.com/simonbucher)) +- [#297](https://github.com/unity-atoms/unity-atoms/pull/297) Fix FiniteStateMachine not listening to Raise Event To Complete Transition ([@Kyrw](https://github.com/Kyrw)) +- [#306](https://github.com/unity-atoms/unity-atoms/pull/306) Fix in case no object was tagged FindByTag throwing an exception instead of returning null ([@soraphis](https://github.com/soraphis)) +- [#314](https://github.com/unity-atoms/unity-atoms/pull/314) Fix Drawer trying to create field for public Action ([@ThimoDEV](https://github.com/ThimoDEV)) +- [#309](https://github.com/unity-atoms/unity-atoms/pull/309) Fix the null check on Base events in AtomVariableInstancer not accounting for Base itself and not creating runtime AtomEvents ([@ThimoDEV](https://github.com/ThimoDEV)) +- [#310](https://github.com/unity-atoms/unity-atoms/pull/310) Fix void event instancer stopping working after a deactivate/activate cycle ([@ThimoDEV](https://github.com/ThimoDEV)) +- [#311](https://github.com/unity-atoms/unity-atoms/pull/311) Fix ulong variable throwing error when the value being edited in play mode ([@ThimoDEV](https://github.com/ThimoDEV)) +- [#312](https://github.com/unity-atoms/unity-atoms/pull/312) Remove duplicate definition of GameObjectGameObjectFunction in MonoHooks package ([@ThimoDEV](https://github.com/ThimoDEV)) +- [#313](https://github.com/unity-atoms/unity-atoms/pull/313) Fix default Changed and ChangedWithHistory events not created at runtime ([@ThimoDEV](https://github.com/ThimoDEV)) +- [#278](https://github.com/unity-atoms/unity-atoms/pull/278) Fix conditions not serializing in Unity 2019 ([@miikalo](https://github.com/miikalo)) +- [#300](https://github.com/unity-atoms/unity-atoms/pull/300) Fixed Serialization on AtomCollections. ([@Kyrw](https://github.com/Kyrw)) ## πŸ“ Documentation +- [#294](https://github.com/unity-atoms/unity-atoms/pull/294) Add missing scoped registry in install docs ([@ahSOLO](https://github.com/ahSOLO)) +- [#280](https://github.com/unity-atoms/unity-atoms/pull/280) Update link in UniRx tutorial ([@miikalo](https://github.com/miikalo)) +- [#267](https://github.com/unity-atoms/unity-atoms/pull/267) Updated documentation and tutorials on the website for v4 ([@miikalo](https://github.com/miikalo)) - A "Smooth Workflow" section has been added under the CONTRIBUTING.md to explain how one can easily start contributing to Atoms whilst working from inside Unity. This was an issue as the atoms repository is not naturally compatible with Unity. ([@Casey-Hofland](https://github.com/Casey-Hofland)) +## 🏠 Internal + +- [#320](https://github.com/unity-atoms/unity-atoms/pull/320) Change private to protected in 'list' variable in AtomValueList ([@ThimoDEV](https://github.com/ThimoDEV)) ## πŸƒβ€β™€ Performance -- [#276](https://github.com/unity-atoms/unity-atoms/issues/276) This AtomGenerator has been improved to take no longer than about a single reimport. ([@Casey-Hofland](https://github.com/Casey-Hofland)) +- [#329](https://github.com/unity-atoms/unity-atoms/pull/329) Fix unnecessary allocations when debug mode disabled ([@soraphis](https://github.com/soraphis)) +- [#276](https://github.com/unity-atoms/unity-atoms/issues/276) The AtomGenerator has been improved to take no longer than about a single reimport ([@Casey-Hofland](https://github.com/Casey-Hofland)) -# 4.4.3 (Mars 7, 2021) +## πŸ’… Polish + +- [#284](https://github.com/unity-atoms/unity-atoms/pull/284) Fixed specifying package dependencies ([@lumpn](https://github.com/lumpn)) + +# 4.4.3 (March 7, 2021) ## πŸ› Bug fixes @@ -49,7 +75,7 @@ # 4.4.0 (December 30, 2020) -- ([@miikalo](https://github.com/miikalo) has joined as maintainer of Unity Atoms! πŸ₯³ +- [@miikalo](https://github.com/miikalo) has joined as maintainer of Unity Atoms! πŸ₯³ ## πŸ› Bug fixes diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e8668f8..a59d5d10 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,10 +6,7 @@ Thanks for considering contributing to Unity Atoms ❀️ Read the guidelines be Unity Atoms is a [monorepo](https://en.wikipedia.org/wiki/Monorepo). Basically that means that there are several packages / projects contained in one repository. -- Packages - contains all the different packages. -- Examples - this folder is a Unity project folder that contains examples. This folder is not included in the distribution of Unity Atoms. - -The reason for this project structure is that we want to include examples in the repo (needing a Unity project), but there are at the same time currently some restrictions when using the UPM regarding how to import it to your project. +- Packages - contains all the different packages ### UPM doesn't allow... diff --git a/Packages/BaseAtoms/package.json b/Packages/BaseAtoms/package.json index 24babb72..84d96bf8 100644 --- a/Packages/BaseAtoms/package.json +++ b/Packages/BaseAtoms/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-base-atoms", "displayName": "Unity Atoms Base Atoms", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "Base set of Atoms based on Unity Atoms Core.", "keywords": [ @@ -22,6 +22,6 @@ "dependencies": { "com.unity.modules.physics": "1.0.0", "com.unity.modules.physics2d": "1.0.0", - "com.unity-atoms.unity-atoms-core": "4.4.3" + "com.unity-atoms.unity-atoms-core": "4.4.4" } } diff --git a/Packages/Core/package.json b/Packages/Core/package.json index a4851e04..b5276d34 100644 --- a/Packages/Core/package.json +++ b/Packages/Core/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-core", "displayName": "Unity Atoms Core", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "Tiny modular pieces utilizing the power of Scriptable Objects", "keywords": [ diff --git a/Packages/FSM/package.json b/Packages/FSM/package.json index 17e031cd..fca2de33 100644 --- a/Packages/FSM/package.json +++ b/Packages/FSM/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-fsm", "displayName": "Unity Atoms FSM", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "Simple FSM using Unity Atoms.", "keywords": [ @@ -20,7 +20,7 @@ "/Documentation.meta" ], "dependencies": { - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3" + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4" } } diff --git a/Packages/InputSystem/package.json b/Packages/InputSystem/package.json index a19acc2e..5120c280 100644 --- a/Packages/InputSystem/package.json +++ b/Packages/InputSystem/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-input-system", "displayName": "Unity Atoms Input System", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "Unity Atoms with Unity's Input System.", "keywords": [ @@ -18,8 +18,8 @@ "/Editor.meta" ], "dependencies": { - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3", + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4", "com.unity.inputsystem": "1.0.1" } } diff --git a/Packages/Mobile/package.json b/Packages/Mobile/package.json index f309eb82..1dbccaff 100644 --- a/Packages/Mobile/package.json +++ b/Packages/Mobile/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-mobile", "displayName": "Unity Atoms Mobile", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "Unity Atoms for your mobile project.", "keywords": [ @@ -20,7 +20,7 @@ "/Documentation.meta" ], "dependencies": { - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3" + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4" } } diff --git a/Packages/MonoHooks/package.json b/Packages/MonoHooks/package.json index 3ada965b..efd8f102 100644 --- a/Packages/MonoHooks/package.json +++ b/Packages/MonoHooks/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-mono-hooks", "displayName": "Unity Atoms Mono Hooks", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "Hook into Unity's lifecycle methods with Atom Events.", "keywords": [ @@ -21,7 +21,7 @@ ], "dependencies": { "com.unity.ugui": "1.0.0", - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3" + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4" } } diff --git a/Packages/SceneMgmt/package.json b/Packages/SceneMgmt/package.json index f9df2ba5..6414b9cb 100644 --- a/Packages/SceneMgmt/package.json +++ b/Packages/SceneMgmt/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-scene-mgmt", "displayName": "Unity Atoms Scene Mgmt", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "Unity Atoms to manage your scenes.", "keywords": [ @@ -20,7 +20,7 @@ "/Documentation.meta" ], "dependencies": { - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3" + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4" } } diff --git a/Packages/Tags/package.json b/Packages/Tags/package.json index 49a3b1c5..31bd1366 100644 --- a/Packages/Tags/package.json +++ b/Packages/Tags/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-tags", "displayName": "Unity Atoms Tags", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "A replacement to UnityΒ΄s tags based on Unity Atoms.", "keywords": [ @@ -18,7 +18,7 @@ "/Documentation.meta" ], "dependencies": { - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3" + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4" } } diff --git a/Packages/UI/package.json b/Packages/UI/package.json index d7c14917..209786aa 100644 --- a/Packages/UI/package.json +++ b/Packages/UI/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms-ui", "displayName": "Unity Atoms UI", - "version": "4.4.3", + "version": "4.4.4", "unity": "2018.3", "description": "UI system using Unity Atoms.", "keywords": [ @@ -18,7 +18,7 @@ "/Documentation.meta" ], "dependencies": { - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3" + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4" } } diff --git a/README.md b/README.md index 4bef326d..7d5b1dc3 100644 --- a/README.md +++ b/README.md @@ -56,15 +56,15 @@ Add the following to your `manifest.json` (which is located under your project l ], "dependencies": { ... - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3", - "com.unity-atoms.unity-atoms-fsm": "4.4.3", - "com.unity-atoms.unity-atoms-mobile": "4.4.3", - "com.unity-atoms.unity-atoms-mono-hooks": "4.4.3", - "com.unity-atoms.unity-atoms-tags": "4.4.3", - "com.unity-atoms.unity-atoms-scene-mgmt": "4.4.3", - "com.unity-atoms.unity-atoms-ui": "4.4.3", - "com.unity-atoms.unity-atoms-input-system": "4.4.3", + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4", + "com.unity-atoms.unity-atoms-fsm": "4.4.4", + "com.unity-atoms.unity-atoms-mobile": "4.4.4", + "com.unity-atoms.unity-atoms-mono-hooks": "4.4.4", + "com.unity-atoms.unity-atoms-tags": "4.4.4", + "com.unity-atoms.unity-atoms-scene-mgmt": "4.4.4", + "com.unity-atoms.unity-atoms-ui": "4.4.4", + "com.unity-atoms.unity-atoms-input-system": "4.4.4", ... } } diff --git a/docs/api/unityatoms.baseatoms.editor.md b/docs/api/unityatoms.baseatoms.editor.md index bec9802e..8f896a42 100644 --- a/docs/api/unityatoms.baseatoms.editor.md +++ b/docs/api/unityatoms.baseatoms.editor.md @@ -7,339 +7,117 @@ sidebar_label: UnityAtoms.BaseAtoms.Editor # Namespace - `UnityAtoms.BaseAtoms.Editor` -## `Collider2DEventInstancerEditor` +## `AtomCollectionReferenceDrawer` -Event property drawer of type `Collider2D`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +A custom property drawer for AtomCollectionReference. Makes it possible to choose between a Collection or a Collection Instancer. --- -## `Vector2EventInstancerEditor` +## `AtomListDrawer` -Event property drawer of type `Vector2`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +A custom property drawer for AtomBaseVariableList. --- -## `VoidEventInstancerEditor` +## `AtomListReferenceDrawer` -Event property drawer of type `Void`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +A custom property drawer for AtomListReference. Makes it possible to choose between a List or a List Instancer. --- -## `Vector3EventInstancerEditor` +## `SerializableDictionaryDrawer`3` -Event property drawer of type `Vector3`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +A custom property drawer for SerializableDictionary. --- -## `BoolEventInstancerEditor` +## `StringReferenceAtomBaseVariableDictionaryDrawer` -Event property drawer of type `bool`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +SerializableDictionary property drawer for type . Inherits from `SerializableDictionaryDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `AtomBaseVariableEventInstancerEditor` +## `BoolConstantDrawer` -Event property drawer of type `AtomBaseVariable`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `bool`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `FloatEventInstancerEditor` +## `Collider2DConstantDrawer` -Event property drawer of type `float`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `Collider2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `StringEventInstancerEditor` +## `ColliderConstantDrawer` -Event property drawer of type `string`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `Collider`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `GameObjectEventInstancerEditor` +## `Collision2DConstantDrawer` -Event property drawer of type `GameObject`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `Collision2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `IntEventInstancerEditor` +## `CollisionConstantDrawer` -Event property drawer of type `int`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `ColliderEventInstancerEditor` +## `ColorConstantDrawer` -Event property drawer of type `Collider`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `Color`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `ColorEventInstancerEditor` +## `DoubleConstantDrawer` -Event property drawer of type `Color`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `double`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `StringVariableEditor` +## `FloatConstantDrawer` -Variable Inspector of type `string`. Inherits from `AtomVariableEditor` +Constant property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `IntVariableEditor` +## `GameObjectConstantDrawer` -Variable Inspector of type `int`. Inherits from `AtomVariableEditor` +Constant property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `CollisionVariableEditor` +## `IntConstantDrawer` -Variable Inspector of type `Collision`. Inherits from `AtomVariableEditor` +Constant property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `GameObjectVariableEditor` +## `QuaternionConstantDrawer` -Variable Inspector of type `GameObject`. Inherits from `AtomVariableEditor` +Constant property drawer of type `Quaternion`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `ColliderVariableEditor` +## `StringConstantDrawer` -Variable Inspector of type `Collider`. Inherits from `AtomVariableEditor` +Constant property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `BoolVariableEditor` +## `Vector2ConstantDrawer` -Variable Inspector of type `bool`. Inherits from `AtomVariableEditor` +Constant property drawer of type `Vector2`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `Collision2DVariableEditor` +## `Vector3ConstantDrawer` -Variable Inspector of type `Collision2D`. Inherits from `AtomVariableEditor` - ---- - -## `Vector2VariableEditor` - -Variable Inspector of type `Vector2`. Inherits from `AtomVariableEditor` - ---- - -## `Collider2DVariableEditor` - -Variable Inspector of type `Collider2D`. Inherits from `AtomVariableEditor` - ---- - -## `QuaternionVariableEditor` - -Variable Inspector of type `Quaternion`. Inherits from `AtomVariableEditor` - ---- - -## `Vector3VariableEditor` - -Variable Inspector of type `Vector3`. Inherits from `AtomVariableEditor` - ---- - -## `DoubleVariableEditor` - -Variable Inspector of type `double`. Inherits from `AtomVariableEditor` - ---- - -## `FloatVariableEditor` - -Variable Inspector of type `float`. Inherits from `AtomVariableEditor` - ---- - -## `ColorVariableEditor` - -Variable Inspector of type `Color`. Inherits from `AtomVariableEditor` - ---- - -## `QuaternionEventEditor` - -Event property drawer of type `Quaternion`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `BoolEventEditor` - -Event property drawer of type `bool`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColorPairEventEditor` - -Event property drawer of type `ColorPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `DoublePairEventEditor` - -Event property drawer of type `DoublePair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderEventEditor` - -Event property drawer of type `Collider`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `IntPairEventEditor` - -Event property drawer of type `IntPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColorEventEditor` - -Event property drawer of type `Color`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector2EventEditor` - -Event property drawer of type `Vector2`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `IntEventEditor` - -Event property drawer of type `int`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `BoolPairEventEditor` - -Event property drawer of type `BoolPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `DoubleEventEditor` - -Event property drawer of type `double`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DEventEditor` - -Event property drawer of type `Collider2D`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `FloatPairEventEditor` - -Event property drawer of type `FloatPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector2PairEventEditor` - -Event property drawer of type `Vector2Pair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `QuaternionPairEventEditor` - -Event property drawer of type `QuaternionPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DPairEventEditor` - -Event property drawer of type `Collider2DPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `VoidEventEditor` - -Event property drawer of type `Void`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `AtomBaseVariableEventEditor` - -Event property drawer of type `AtomBaseVariable`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector3PairEventEditor` - -Event property drawer of type `Vector3Pair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `FloatEventEditor` - -Event property drawer of type `float`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionPairEventEditor` - -Event property drawer of type `CollisionPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `StringEventEditor` - -Event property drawer of type `string`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `GameObjectPairEventEditor` - -Event property drawer of type `GameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `GameObjectEventEditor` - -Event property drawer of type `GameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionEventEditor` - -Event property drawer of type `Collision`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderPairEventEditor` - -Event property drawer of type `ColliderPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector3EventEditor` - -Event property drawer of type `Vector3`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DPairEventEditor` - -Event property drawer of type `Collision2DPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `StringPairEventEditor` - -Event property drawer of type `StringPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DEventEditor` - -Event property drawer of type `Collision2D`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `Vector3`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -355,177 +133,45 @@ A custom property drawer for Void BaseEventReferences. Makes it possible to choo --- -## `Collider2DConstantDrawer` +## `AtomBaseVariableEventDrawer` -Constant property drawer of type `Collider2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `AtomBaseVariable`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `Vector2ConstantDrawer` +## `BoolEventDrawer` -Constant property drawer of type `Vector2`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `bool`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `Collision2DConstantDrawer` +## `BoolPairEventDrawer` -Constant property drawer of type `Collision2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `BoolPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `QuaternionConstantDrawer` +## `Collider2DEventDrawer` -Constant property drawer of type `Quaternion`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `Collider2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `FloatConstantDrawer` +## `Collider2DPairEventDrawer` -Constant property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `Collider2DPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `DoubleConstantDrawer` +## `ColliderEventDrawer` -Constant property drawer of type `double`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `Collider`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `Vector3ConstantDrawer` +## `ColliderPairEventDrawer` -Constant property drawer of type `Vector3`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColorConstantDrawer` - -Constant property drawer of type `Color`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `StringConstantDrawer` - -Constant property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `IntConstantDrawer` - -Constant property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `GameObjectConstantDrawer` - -Constant property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderConstantDrawer` - -Constant property drawer of type `Collider`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `BoolConstantDrawer` - -Constant property drawer of type `bool`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionConstantDrawer` - -Constant property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColorVariableDrawer` - -Variable property drawer of type `Color`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector3VariableDrawer` - -Variable property drawer of type `Vector3`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `DoubleVariableDrawer` - -Variable property drawer of type `double`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `FloatVariableDrawer` - -Variable property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `QuaternionVariableDrawer` - -Variable property drawer of type `Quaternion`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector2VariableDrawer` - -Variable property drawer of type `Vector2`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DVariableDrawer` - -Variable property drawer of type `Collision2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DVariableDrawer` - -Variable property drawer of type `Collider2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionVariableDrawer` - -Variable property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `GameObjectVariableDrawer` - -Variable property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `BoolVariableDrawer` - -Variable property drawer of type `bool`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderVariableDrawer` - -Variable property drawer of type `Collider`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `IntVariableDrawer` - -Variable property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `StringVariableDrawer` - -Variable property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `StringPairEventDrawer` - -Event property drawer of type `StringPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `ColliderPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -541,15 +187,9 @@ Event property drawer of type `Collision2DPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `FloatEventDrawer` - -Event property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -559,183 +199,117 @@ Event property drawer of type `CollisionPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `GameObjectEventDrawer` - -Event property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionEventDrawer` - -Event property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderPairEventDrawer` - -Event property drawer of type `ColliderPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `StringEventDrawer` - -Event property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `GameObjectPairEventDrawer` - -Event property drawer of type `GameObjectPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `AtomBaseVariableEventDrawer` - -Event property drawer of type `AtomBaseVariable`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector2PairEventDrawer` - -Event property drawer of type `Vector2Pair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `QuaternionPairEventDrawer` - -Event property drawer of type `QuaternionPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DPairEventDrawer` - -Event property drawer of type `Collider2DPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `VoidEventDrawer` - -Event property drawer of type `Void`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `DoubleEventDrawer` - -Event property drawer of type `double`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DEventDrawer` - -Event property drawer of type `Collider2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `FloatPairEventDrawer` - -Event property drawer of type `FloatPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `IntEventDrawer` - -Event property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `BoolPairEventDrawer` - -Event property drawer of type `BoolPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `DoublePairEventDrawer` - -Event property drawer of type `DoublePair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderEventDrawer` - -Event property drawer of type `Collider`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector2EventDrawer` - -Event property drawer of type `Vector2`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `IntPairEventDrawer` - -Event property drawer of type `IntPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - ## `ColorEventDrawer` Event property drawer of type `Color`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `BoolEventDrawer` - -Event property drawer of type `bool`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `QuaternionEventDrawer` - -Event property drawer of type `Quaternion`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - ## `ColorPairEventDrawer` Event property drawer of type `ColorPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `AtomListReferenceDrawer` +## `DoubleEventDrawer` -A custom property drawer for AtomListReference. Makes it possible to choose between a List or a List Instancer. +Event property drawer of type `double`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `StringReferenceAtomBaseVariableDictionaryDrawer` +## `DoublePairEventDrawer` -SerializableDictionary property drawer for type . Inherits from `SerializableDictionaryDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `DoublePair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `AtomCollectionReferenceDrawer` +## `FloatEventDrawer` -A custom property drawer for AtomCollectionReference. Makes it possible to choose between a Collection or a Collection Instancer. +Event property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `SerializableDictionaryDrawer`3` +## `FloatPairEventDrawer` -A custom property drawer for SerializableDictionary. +Event property drawer of type `FloatPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `AtomListDrawer` +## `GameObjectEventDrawer` -A custom property drawer for AtomBaseVariableList. +Event property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `FloatValueListDrawer` +## `GameObjectPairEventDrawer` -Value List property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `GameObjectPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `IntEventDrawer` + +Event property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `IntPairEventDrawer` + +Event property drawer of type `IntPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `QuaternionEventDrawer` + +Event property drawer of type `Quaternion`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `QuaternionPairEventDrawer` + +Event property drawer of type `QuaternionPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `StringEventDrawer` + +Event property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `StringPairEventDrawer` + +Event property drawer of type `StringPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector2EventDrawer` + +Event property drawer of type `Vector2`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector2PairEventDrawer` + +Event property drawer of type `Vector2Pair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector3EventDrawer` + +Event property drawer of type `Vector3`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector3PairEventDrawer` + +Event property drawer of type `Vector3Pair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `VoidEventDrawer` + +Event property drawer of type `Void`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -745,51 +319,9 @@ Value List property drawer of type `bool`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `IntValueListDrawer` - -Value List property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColorValueListDrawer` - -Value List property drawer of type `Color`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `StringValueListDrawer` - -Value List property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DValueListDrawer` - -Value List property drawer of type `Collision2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Vector3ValueListDrawer` - -Value List property drawer of type `Vector3`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionValueListDrawer` - -Value List property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `GameObjectValueListDrawer` - -Value List property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Value List property drawer of type `Collider2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -799,9 +331,45 @@ Value List property drawer of type `Collider`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Value List property drawer of type `Collision2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `CollisionValueListDrawer` + +Value List property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColorValueListDrawer` + +Value List property drawer of type `Color`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `DoubleValueListDrawer` + +Value List property drawer of type `double`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `FloatValueListDrawer` + +Value List property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `GameObjectValueListDrawer` + +Value List property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `IntValueListDrawer` + +Value List property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -811,9 +379,357 @@ Value List property drawer of type `Quaternion`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Value List property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector2ValueListDrawer` + +Value List property drawer of type `Vector2`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector3ValueListDrawer` + +Value List property drawer of type `Vector3`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `BoolVariableDrawer` + +Variable property drawer of type `bool`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collider2DVariableDrawer` + +Variable property drawer of type `Collider2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColliderVariableDrawer` + +Variable property drawer of type `Collider`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collision2DVariableDrawer` + +Variable property drawer of type `Collision2D`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `CollisionVariableDrawer` + +Variable property drawer of type `Collision`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColorVariableDrawer` + +Variable property drawer of type `Color`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `DoubleVariableDrawer` + +Variable property drawer of type `double`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `FloatVariableDrawer` + +Variable property drawer of type `float`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `GameObjectVariableDrawer` + +Variable property drawer of type `GameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `IntVariableDrawer` + +Variable property drawer of type `int`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `QuaternionVariableDrawer` + +Variable property drawer of type `Quaternion`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `StringVariableDrawer` + +Variable property drawer of type `string`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector2VariableDrawer` + +Variable property drawer of type `Vector2`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector3VariableDrawer` + +Variable property drawer of type `Vector3`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `AtomBaseVariableEventInstancerEditor` + +Event property drawer of type `AtomBaseVariable`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `BoolEventInstancerEditor` + +Event property drawer of type `bool`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collider2DEventInstancerEditor` + +Event property drawer of type `Collider2D`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColliderEventInstancerEditor` + +Event property drawer of type `Collider`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColorEventInstancerEditor` + +Event property drawer of type `Color`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `FloatEventInstancerEditor` + +Event property drawer of type `float`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `GameObjectEventInstancerEditor` + +Event property drawer of type `GameObject`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `IntEventInstancerEditor` + +Event property drawer of type `int`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `StringEventInstancerEditor` + +Event property drawer of type `string`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector2EventInstancerEditor` + +Event property drawer of type `Vector2`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector3EventInstancerEditor` + +Event property drawer of type `Vector3`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `VoidEventInstancerEditor` + +Event property drawer of type `Void`. Inherits from `AtomEventInstancerEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `AtomBaseVariableEventEditor` + +Event property drawer of type `AtomBaseVariable`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `BoolEventEditor` + +Event property drawer of type `bool`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `BoolPairEventEditor` + +Event property drawer of type `BoolPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collider2DEventEditor` + +Event property drawer of type `Collider2D`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collider2DPairEventEditor` + +Event property drawer of type `Collider2DPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColliderEventEditor` + +Event property drawer of type `Collider`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColliderPairEventEditor` + +Event property drawer of type `ColliderPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collision2DEventEditor` + +Event property drawer of type `Collision2D`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collision2DPairEventEditor` + +Event property drawer of type `Collision2DPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `CollisionEventEditor` + +Event property drawer of type `Collision`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `CollisionPairEventEditor` + +Event property drawer of type `CollisionPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColorEventEditor` + +Event property drawer of type `Color`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColorPairEventEditor` + +Event property drawer of type `ColorPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `DoubleEventEditor` + +Event property drawer of type `double`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `DoublePairEventEditor` + +Event property drawer of type `DoublePair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `FloatEventEditor` + +Event property drawer of type `float`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `FloatPairEventEditor` + +Event property drawer of type `FloatPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `GameObjectEventEditor` + +Event property drawer of type `GameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `GameObjectPairEventEditor` + +Event property drawer of type `GameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `IntEventEditor` + +Event property drawer of type `int`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `IntPairEventEditor` + +Event property drawer of type `IntPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `QuaternionEventEditor` + +Event property drawer of type `Quaternion`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `QuaternionPairEventEditor` + +Event property drawer of type `QuaternionPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `StringEventEditor` + +Event property drawer of type `string`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `StringPairEventEditor` + +Event property drawer of type `StringPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector2EventEditor` + +Event property drawer of type `Vector2`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector2PairEventEditor` + +Event property drawer of type `Vector2Pair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector3EventEditor` + +Event property drawer of type `Vector3`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Vector3PairEventEditor` + +Event property drawer of type `Vector3Pair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `VoidEventEditor` + +Event property drawer of type `Void`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -834,3 +750,87 @@ Custom editor for ClampFloat. Custom editor for ClampInt. --- + +## `BoolVariableEditor` + +Variable Inspector of type `bool`. Inherits from `AtomVariableEditor` + +--- + +## `Collider2DVariableEditor` + +Variable Inspector of type `Collider2D`. Inherits from `AtomVariableEditor` + +--- + +## `ColliderVariableEditor` + +Variable Inspector of type `Collider`. Inherits from `AtomVariableEditor` + +--- + +## `Collision2DVariableEditor` + +Variable Inspector of type `Collision2D`. Inherits from `AtomVariableEditor` + +--- + +## `CollisionVariableEditor` + +Variable Inspector of type `Collision`. Inherits from `AtomVariableEditor` + +--- + +## `ColorVariableEditor` + +Variable Inspector of type `Color`. Inherits from `AtomVariableEditor` + +--- + +## `DoubleVariableEditor` + +Variable Inspector of type `double`. Inherits from `AtomVariableEditor` + +--- + +## `FloatVariableEditor` + +Variable Inspector of type `float`. Inherits from `AtomVariableEditor` + +--- + +## `GameObjectVariableEditor` + +Variable Inspector of type `GameObject`. Inherits from `AtomVariableEditor` + +--- + +## `IntVariableEditor` + +Variable Inspector of type `int`. Inherits from `AtomVariableEditor` + +--- + +## `QuaternionVariableEditor` + +Variable Inspector of type `Quaternion`. Inherits from `AtomVariableEditor` + +--- + +## `StringVariableEditor` + +Variable Inspector of type `string`. Inherits from `AtomVariableEditor` + +--- + +## `Vector2VariableEditor` + +Variable Inspector of type `Vector2`. Inherits from `AtomVariableEditor` + +--- + +## `Vector3VariableEditor` + +Variable Inspector of type `Vector3`. Inherits from `AtomVariableEditor` + +--- diff --git a/docs/api/unityatoms.baseatoms.md b/docs/api/unityatoms.baseatoms.md index 878dbcfa..bbf7320d 100644 --- a/docs/api/unityatoms.baseatoms.md +++ b/docs/api/unityatoms.baseatoms.md @@ -7,875 +7,273 @@ sidebar_label: UnityAtoms.BaseAtoms # Namespace - `UnityAtoms.BaseAtoms` -## `BoolPairEventReferenceListener` +## `AtomBaseVariableAction` -Event Reference Listener of type `BoolPair`. Inherits from `AtomEventReferenceListener`. +Action of type `AtomBaseVariable`. Inherits from `AtomAction`. --- -## `CollisionPairEventReferenceListener` +## `BoolAction` -Event Reference Listener of type `CollisionPair`. Inherits from `AtomEventReferenceListener`. +Action of type `bool`. Inherits from `AtomAction`. --- -## `Collider2DPairEventReferenceListener` +## `BoolPairAction` -Event Reference Listener of type `Collider2DPair`. Inherits from `AtomEventReferenceListener`. +Action of type `BoolPair`. Inherits from `AtomAction`. --- -## `CollisionEventReferenceListener` +## `Collider2DAction` -Event Reference Listener of type `Collision`. Inherits from `AtomEventReferenceListener`. +Action of type `Collider2D`. Inherits from `AtomAction`. --- -## `IntEventReferenceListener` +## `Collider2DPairAction` -Event Reference Listener of type `int`. Inherits from `AtomEventReferenceListener`. +Action of type `Collider2DPair`. Inherits from `AtomAction`. --- -## `Collision2DPairEventReferenceListener` +## `ColliderAction` -Event Reference Listener of type `Collision2DPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Collider`. Inherits from `AtomAction`. --- -## `ColliderEventReferenceListener` +## `ColliderPairAction` -Event Reference Listener of type `Collider`. Inherits from `AtomEventReferenceListener`. +Action of type `ColliderPair`. Inherits from `AtomAction`. --- -## `Collision2DEventReferenceListener` +## `Collision2DAction` -Event Reference Listener of type `Collision2D`. Inherits from `AtomEventReferenceListener`. +Action of type `Collision2D`. Inherits from `AtomAction`. --- -## `IntPairEventReferenceListener` +## `Collision2DPairAction` -Event Reference Listener of type `IntPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Collision2DPair`. Inherits from `AtomAction`. --- -## `QuaternionPairEventReferenceListener` +## `CollisionAction` -Event Reference Listener of type `QuaternionPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Collision`. Inherits from `AtomAction`. --- -## `Vector3PairEventReferenceListener` +## `CollisionPairAction` -Event Reference Listener of type `Vector3Pair`. Inherits from `AtomEventReferenceListener`. +Action of type `CollisionPair`. Inherits from `AtomAction`. --- -## `BoolEventReferenceListener` +## `ColorAction` -Event Reference Listener of type `bool`. Inherits from `AtomEventReferenceListener`. +Action of type `Color`. Inherits from `AtomAction`. --- -## `Collider2DEventReferenceListener` +## `ColorPairAction` -Event Reference Listener of type `Collider2D`. Inherits from `AtomEventReferenceListener`. +Action of type `ColorPair`. Inherits from `AtomAction`. --- -## `DoubleEventReferenceListener` +## `DoubleAction` -Event Reference Listener of type `double`. Inherits from `AtomEventReferenceListener`. +Action of type `double`. Inherits from `AtomAction`. --- -## `DoublePairEventReferenceListener` +## `DoublePairAction` -Event Reference Listener of type `DoublePair`. Inherits from `AtomEventReferenceListener`. +Action of type `DoublePair`. Inherits from `AtomAction`. --- -## `Vector2PairEventReferenceListener` +## `FloatAction` -Event Reference Listener of type `Vector2Pair`. Inherits from `AtomEventReferenceListener`. +Action of type `float`. Inherits from `AtomAction`. --- -## `StringPairEventReferenceListener` +## `FloatPairAction` -Event Reference Listener of type `StringPair`. Inherits from `AtomEventReferenceListener`. +Action of type `FloatPair`. Inherits from `AtomAction`. --- -## `ColorEventReferenceListener` +## `GameObjectAction` -Event Reference Listener of type `Color`. Inherits from `AtomEventReferenceListener`. +Action of type `GameObject`. Inherits from `AtomAction`. --- -## `Vector2EventReferenceListener` +## `GameObjectPairAction` -Event Reference Listener of type `Vector2`. Inherits from `AtomEventReferenceListener`. +Action of type `GameObjectPair`. Inherits from `AtomAction`. --- -## `FloatEventReferenceListener` +## `IntAction` -Event Reference Listener of type `float`. Inherits from `AtomEventReferenceListener`. +Action of type `int`. Inherits from `AtomAction`. --- -## `QuaternionEventReferenceListener` +## `IntPairAction` -Event Reference Listener of type `Quaternion`. Inherits from `AtomEventReferenceListener`. +Action of type `IntPair`. Inherits from `AtomAction`. --- -## `Vector3EventReferenceListener` +## `QuaternionAction` -Event Reference Listener of type `Vector3`. Inherits from `AtomEventReferenceListener`. +Action of type `Quaternion`. Inherits from `AtomAction`. --- -## `GameObjectEventReferenceListener` +## `QuaternionPairAction` -Event Reference Listener of type `GameObject`. Inherits from `AtomEventReferenceListener`. +Action of type `QuaternionPair`. Inherits from `AtomAction`. --- -## `FloatPairEventReferenceListener` +## `StringAction` -Event Reference Listener of type `FloatPair`. Inherits from `AtomEventReferenceListener`. +Action of type `string`. Inherits from `AtomAction`. --- -## `ColliderPairEventReferenceListener` +## `StringPairAction` -Event Reference Listener of type `ColliderPair`. Inherits from `AtomEventReferenceListener`. +Action of type `StringPair`. Inherits from `AtomAction`. --- -## `ColorPairEventReferenceListener` +## `Vector2Action` -Event Reference Listener of type `ColorPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Vector2`. Inherits from `AtomAction`. --- -## `StringEventReferenceListener` +## `Vector2PairAction` -Event Reference Listener of type `string`. Inherits from `AtomEventReferenceListener`. +Action of type `Vector2Pair`. Inherits from `AtomAction`. --- -## `GameObjectPairEventReferenceListener` +## `Vector3Action` -Event Reference Listener of type `GameObjectPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Vector3`. Inherits from `AtomAction`. --- -## `FloatReference` +## `Vector3PairAction` -Reference of type `float`. Inherits from `EquatableAtomReference`. +Action of type `Vector3Pair`. Inherits from `AtomAction`. --- -## `Collision2DReference` +## `SetBoolVariableValue` -Reference of type `Collision2D`. Inherits from `AtomReference`. +Set variable value Action of type `bool`. Inherits from `SetVariableValue`. --- -## `Vector2Reference` +## `SetCollider2DVariableValue` -Reference of type `Vector2`. Inherits from `EquatableAtomReference`. +Set variable value Action of type `Collider2D`. Inherits from `SetVariableValue`. --- -## `BoolReference` +## `SetColliderVariableValue` -Reference of type `bool`. Inherits from `EquatableAtomReference`. +Set variable value Action of type `Collider`. Inherits from `SetVariableValue`. --- -## `ColorReference` +## `SetCollision2DVariableValue` -Reference of type `Color`. Inherits from `EquatableAtomReference`. - -### Methods - -#### `SetAlpha(System.Single)` - -Set Alpha of Color by value. - -##### Parameters - -- `value` - New alpha value. - ---- - -#### `SetAlpha(UnityAtoms.AtomBaseVariable{System.Single})` - -Set Alpha of Color by Variable value. - -##### Parameters - -- `variable` - New alpha Variable value. - ---- - -## `ColliderReference` - -Reference of type `Collider`. Inherits from `AtomReference`. - ---- - -## `IntReference` - -Reference of type `int`. Inherits from `EquatableAtomReference`. - ---- - -## `CollisionReference` - -Reference of type `Collision`. Inherits from `AtomReference`. - ---- - -## `QuaternionReference` - -Reference of type `Quaternion`. Inherits from `EquatableAtomReference`. - ---- - -## `Collider2DReference` - -Reference of type `Collider2D`. Inherits from `AtomReference`. - ---- - -## `GameObjectReference` - -Reference of type `GameObject`. Inherits from `AtomReference`. - ---- - -## `Vector3Reference` - -Reference of type `Vector3`. Inherits from `EquatableAtomReference`. - ---- - -## `StringReference` - -Reference of type `string`. Inherits from `EquatableAtomReference`. - ---- - -## `DoubleReference` - -Reference of type `double`. Inherits from `EquatableAtomReference`. - ---- - -## `CollisionPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `GameObjectPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `Vector3Pair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `Collider2DPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `ColorPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `DoublePair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `ColliderPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `IntPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `Vector2Pair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `FloatPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `QuaternionPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `Collision2DPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `BoolPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `StringPair` - -IPair of type ``. Inherits from `IPair`. - ---- - -## `BoolPairUnityEvent` - -None generic Unity Event of type `BoolPair`. Inherits from `UnityEvent`. - ---- - -## `ColliderPairUnityEvent` - -None generic Unity Event of type `ColliderPair`. Inherits from `UnityEvent`. - ---- - -## `GameObjectPairUnityEvent` - -None generic Unity Event of type `GameObjectPair`. Inherits from `UnityEvent`. - ---- - -## `DoubleUnityEvent` - -None generic Unity Event of type `double`. Inherits from `UnityEvent`. - ---- - -## `GameObjectUnityEvent` - -None generic Unity Event of type `GameObject`. Inherits from `UnityEvent`. - ---- - -## `CollisionPairUnityEvent` - -None generic Unity Event of type `CollisionPair`. Inherits from `UnityEvent`. - ---- - -## `Collider2DUnityEvent` - -None generic Unity Event of type `Collider2D`. Inherits from `UnityEvent`. - ---- - -## `ColliderUnityEvent` - -None generic Unity Event of type `Collider`. Inherits from `UnityEvent`. - ---- - -## `BoolUnityEvent` - -None generic Unity Event of type `bool`. Inherits from `UnityEvent`. - ---- - -## `VoidUnityEvent` - -None generic Unity Event of type `Void`. Inherits from `UnityEvent`. - ---- - -## `IntPairUnityEvent` - -None generic Unity Event of type `IntPair`. Inherits from `UnityEvent`. - ---- - -## `Vector2UnityEvent` - -None generic Unity Event of type `Vector2`. Inherits from `UnityEvent`. - ---- - -## `FloatUnityEvent` - -None generic Unity Event of type `float`. Inherits from `UnityEvent`. - ---- - -## `IntUnityEvent` - -None generic Unity Event of type `int`. Inherits from `UnityEvent`. - ---- - -## `CollisionUnityEvent` - -None generic Unity Event of type `Collision`. Inherits from `UnityEvent`. - ---- - -## `Vector3UnityEvent` - -None generic Unity Event of type `Vector3`. Inherits from `UnityEvent`. - ---- - -## `StringPairUnityEvent` - -None generic Unity Event of type `StringPair`. Inherits from `UnityEvent`. - ---- - -## `ColorPairUnityEvent` - -None generic Unity Event of type `ColorPair`. Inherits from `UnityEvent`. - ---- - -## `ColorUnityEvent` - -None generic Unity Event of type `Color`. Inherits from `UnityEvent`. - ---- - -## `AtomBaseVariableUnityEvent` - -None generic Unity Event of type `AtomBaseVariable`. Inherits from `UnityEvent`. - ---- - -## `StringUnityEvent` - -None generic Unity Event of type `string`. Inherits from `UnityEvent`. - ---- - -## `DoublePairUnityEvent` - -None generic Unity Event of type `DoublePair`. Inherits from `UnityEvent`. - ---- - -## `FloatPairUnityEvent` - -None generic Unity Event of type `FloatPair`. Inherits from `UnityEvent`. - ---- - -## `Vector3PairUnityEvent` - -None generic Unity Event of type `Vector3Pair`. Inherits from `UnityEvent`. - ---- - -## `Collision2DUnityEvent` - -None generic Unity Event of type `Collision2D`. Inherits from `UnityEvent`. - ---- - -## `QuaternionPairUnityEvent` - -None generic Unity Event of type `QuaternionPair`. Inherits from `UnityEvent`. - ---- - -## `Collider2DPairUnityEvent` - -None generic Unity Event of type `Collider2DPair`. Inherits from `UnityEvent`. - ---- - -## `QuaternionUnityEvent` - -None generic Unity Event of type `Quaternion`. Inherits from `UnityEvent`. - ---- - -## `Collision2DPairUnityEvent` - -None generic Unity Event of type `Collision2DPair`. Inherits from `UnityEvent`. - ---- - -## `Vector2PairUnityEvent` - -None generic Unity Event of type `Vector2Pair`. Inherits from `UnityEvent`. - ---- - -## `GameObjectConstant` - -Constant of type `GameObject`. Inherits from `AtomBaseVariable`. - ---- - -## `Collider2DConstant` - -Constant of type `Collider2D`. Inherits from `AtomBaseVariable`. - ---- - -## `QuaternionConstant` - -Constant of type `Quaternion`. Inherits from `AtomBaseVariable`. - ---- - -## `Collision2DConstant` - -Constant of type `Collision2D`. Inherits from `AtomBaseVariable`. - ---- - -## `BoolConstant` - -Constant of type `bool`. Inherits from `AtomBaseVariable`. - ---- - -## `Vector2Constant` - -Constant of type `Vector2`. Inherits from `AtomBaseVariable`. - ---- - -## `ColliderConstant` - -Constant of type `Collider`. Inherits from `AtomBaseVariable`. - ---- - -## `IntConstant` - -Constant of type `int`. Inherits from `AtomBaseVariable`. - ---- - -## `CollisionConstant` - -Constant of type `Collision`. Inherits from `AtomBaseVariable`. - ---- - -## `FloatConstant` - -Constant of type `float`. Inherits from `AtomBaseVariable`. - ---- - -## `StringConstant` - -Constant of type `string`. Inherits from `AtomBaseVariable`. - ---- - -## `DoubleConstant` - -Constant of type `double`. Inherits from `AtomBaseVariable`. - ---- - -## `ColorConstant` - -Constant of type `Color`. Inherits from `AtomBaseVariable`. - ---- - -## `Vector3Constant` - -Constant of type `Vector3`. Inherits from `AtomBaseVariable`. - ---- - -## `ColorPairEventReference` - -Event Reference of type `ColorPair`. Inherits from `AtomEventReference`. - ---- - -## `StringEventReference` - -Event Reference of type `string`. Inherits from `AtomEventReference`. - ---- - -## `CollisionPairEventReference` - -Event Reference of type `CollisionPair`. Inherits from `AtomEventReference`. - ---- - -## `Collider2DPairEventReference` - -Event Reference of type `Collider2DPair`. Inherits from `AtomEventReference`. - ---- - -## `DoublePairEventReference` - -Event Reference of type `DoublePair`. Inherits from `AtomEventReference`. - ---- - -## `IntEventReference` - -Event Reference of type `int`. Inherits from `AtomEventReference`. - ---- - -## `Collision2DPairEventReference` - -Event Reference of type `Collision2DPair`. Inherits from `AtomEventReference`. - ---- - -## `CollisionEventReference` - -Event Reference of type `Collision`. Inherits from `AtomEventReference`. - ---- - -## `ColliderEventReference` - -Event Reference of type `Collider`. Inherits from `AtomEventReference`. - ---- - -## `BoolEventReference` - -Event Reference of type `bool`. Inherits from `AtomEventReference`. - ---- - -## `GameObjectEventReference` - -Event Reference of type `GameObject`. Inherits from `AtomEventReference`. - ---- - -## `ColliderPairEventReference` - -Event Reference of type `ColliderPair`. Inherits from `AtomEventReference`. - ---- - -## `Vector2EventReference` - -Event Reference of type `Vector2`. Inherits from `AtomEventReference`. - ---- - -## `BoolPairEventReference` - -Event Reference of type `BoolPair`. Inherits from `AtomEventReference`. - ---- - -## `Collision2DEventReference` - -Event Reference of type `Collision2D`. Inherits from `AtomEventReference`. - ---- - -## `StringPairEventReference` - -Event Reference of type `StringPair`. Inherits from `AtomEventReference`. - ---- - -## `Collider2DEventReference` - -Event Reference of type `Collider2D`. Inherits from `AtomEventReference`. - ---- - -## `QuaternionPairEventReference` - -Event Reference of type `QuaternionPair`. Inherits from `AtomEventReference`. - ---- - -## `QuaternionEventReference` - -Event Reference of type `Quaternion`. Inherits from `AtomEventReference`. - ---- - -## `IntPairEventReference` - -Event Reference of type `IntPair`. Inherits from `AtomEventReference`. - ---- - -## `Vector2PairEventReference` - -Event Reference of type `Vector2Pair`. Inherits from `AtomEventReference`. - ---- - -## `FloatPairEventReference` - -Event Reference of type `FloatPair`. Inherits from `AtomEventReference`. - ---- - -## `Vector3EventReference` - -Event Reference of type `Vector3`. Inherits from `AtomEventReference`. - ---- - -## `DoubleEventReference` - -Event Reference of type `double`. Inherits from `AtomEventReference`. - ---- - -## `FloatEventReference` - -Event Reference of type `float`. Inherits from `AtomEventReference`. - ---- - -## `Vector3PairEventReference` - -Event Reference of type `Vector3Pair`. Inherits from `AtomEventReference`. - ---- - -## `GameObjectPairEventReference` - -Event Reference of type `GameObjectPair`. Inherits from `AtomEventReference`. - ---- - -## `ColorEventReference` - -Event Reference of type `Color`. Inherits from `AtomEventReference`. - ---- - -## `Vector2VariableInstancer` - -Variable Instancer of type `Vector2`. Inherits from `AtomVariableInstancer`. - ---- - -## `Collision2DVariableInstancer` - -Variable Instancer of type `Collision2D`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `Collision2D`. Inherits from `SetVariableValue`. --- -## `Vector3VariableInstancer` +## `SetCollisionVariableValue` -Variable Instancer of type `Vector3`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `Collision`. Inherits from `SetVariableValue`. --- -## `FloatVariableInstancer` +## `SetColorVariableValue` -Variable Instancer of type `float`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `Color`. Inherits from `SetVariableValue`. --- -## `BoolVariableInstancer` +## `SetDoubleVariableValue` -Variable Instancer of type `bool`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `double`. Inherits from `SetVariableValue`. --- -## `Collider2DVariableInstancer` +## `SetFloatVariableValue` -Variable Instancer of type `Collider2D`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `float`. Inherits from `SetVariableValue`. --- -## `CollisionVariableInstancer` +## `SetGameObjectVariableValue` -Variable Instancer of type `Collision`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `GameObject`. Inherits from `SetVariableValue`. --- -## `GameObjectVariableInstancer` +## `SetIntVariableValue` -Variable Instancer of type `GameObject`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `int`. Inherits from `SetVariableValue`. --- -## `ColorVariableInstancer` +## `SetQuaternionVariableValue` -Variable Instancer of type `Color`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `Quaternion`. Inherits from `SetVariableValue`. --- -## `ColliderVariableInstancer` +## `SetStringVariableValue` -Variable Instancer of type `Collider`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `string`. Inherits from `SetVariableValue`. --- -## `IntVariableInstancer` +## `SetVector2VariableValue` -Variable Instancer of type `int`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `Vector2`. Inherits from `SetVariableValue`. --- -## `QuaternionVariableInstancer` +## `SetVector3VariableValue` -Variable Instancer of type `Quaternion`. Inherits from `AtomVariableInstancer`. +Set variable value Action of type `Vector3`. Inherits from `SetVariableValue`. --- -## `StringVariableInstancer` +## `AtomBaseVariableBaseEventReferenceListener` -Variable Instancer of type `string`. Inherits from `AtomVariableInstancer`. +Event Reference Listener of type `AtomBaseVariable`. Inherits from `AtomEventReferenceListener`. --- -## `DoubleVariableInstancer` +## `VoidBaseEventReferenceListener` -Variable Instancer of type `double`. Inherits from `AtomVariableInstancer`. +Event Reference Listener of type `Void`. Inherits from `AtomEventReferenceListener`. --- @@ -957,1315 +355,6 @@ Get or set the Event used by the Event Reference. --- -## `Vector3EventInstancer` - -Event Instancer of type `Vector3`. Inherits from `AtomEventInstancer`. - ---- - -## `DoubleEventInstancer` - -Event Instancer of type `double`. Inherits from `AtomEventInstancer`. - ---- - -## `FloatEventInstancer` - -Event Instancer of type `float`. Inherits from `AtomEventInstancer`. - ---- - -## `Vector3PairEventInstancer` - -Event Instancer of type `Vector3Pair`. Inherits from `AtomEventInstancer`. - ---- - -## `GameObjectPairEventInstancer` - -Event Instancer of type `GameObjectPair`. Inherits from `AtomEventInstancer`. - ---- - -## `VoidEventInstancer` - -Event Instancer of type `Void`. Inherits from `AtomEventInstancer`. - ---- - -## `AtomBaseVariableEventInstancer` - -Event Instancer of type `AtomBaseVariable`. Inherits from `AtomEventInstancer`. - ---- - -## `ColorEventInstancer` - -Event Instancer of type `Color`. Inherits from `AtomEventInstancer`. - ---- - -## `Vector2EventInstancer` - -Event Instancer of type `Vector2`. Inherits from `AtomEventInstancer`. - ---- - -## `BoolPairEventInstancer` - -Event Instancer of type `BoolPair`. Inherits from `AtomEventInstancer`. - ---- - -## `Collision2DEventInstancer` - -Event Instancer of type `Collision2D`. Inherits from `AtomEventInstancer`. - ---- - -## `StringPairEventInstancer` - -Event Instancer of type `StringPair`. Inherits from `AtomEventInstancer`. - ---- - -## `Collider2DEventInstancer` - -Event Instancer of type `Collider2D`. Inherits from `AtomEventInstancer`. - ---- - -## `QuaternionPairEventInstancer` - -Event Instancer of type `QuaternionPair`. Inherits from `AtomEventInstancer`. - ---- - -## `QuaternionEventInstancer` - -Event Instancer of type `Quaternion`. Inherits from `AtomEventInstancer`. - ---- - -## `IntPairEventInstancer` - -Event Instancer of type `IntPair`. Inherits from `AtomEventInstancer`. - ---- - -## `Vector2PairEventInstancer` - -Event Instancer of type `Vector2Pair`. Inherits from `AtomEventInstancer`. - ---- - -## `FloatPairEventInstancer` - -Event Instancer of type `FloatPair`. Inherits from `AtomEventInstancer`. - ---- - -## `Collision2DPairEventInstancer` - -Event Instancer of type `Collision2DPair`. Inherits from `AtomEventInstancer`. - ---- - -## `CollisionEventInstancer` - -Event Instancer of type `Collision`. Inherits from `AtomEventInstancer`. - ---- - -## `ColliderEventInstancer` - -Event Instancer of type `Collider`. Inherits from `AtomEventInstancer`. - ---- - -## `BoolEventInstancer` - -Event Instancer of type `bool`. Inherits from `AtomEventInstancer`. - ---- - -## `GameObjectEventInstancer` - -Event Instancer of type `GameObject`. Inherits from `AtomEventInstancer`. - ---- - -## `ColliderPairEventInstancer` - -Event Instancer of type `ColliderPair`. Inherits from `AtomEventInstancer`. - ---- - -## `ColorPairEventInstancer` - -Event Instancer of type `ColorPair`. Inherits from `AtomEventInstancer`. - ---- - -## `CollisionPairEventInstancer` - -Event Instancer of type `CollisionPair`. Inherits from `AtomEventInstancer`. - ---- - -## `StringEventInstancer` - -Event Instancer of type `string`. Inherits from `AtomEventInstancer`. - ---- - -## `Collider2DPairEventInstancer` - -Event Instancer of type `Collider2DPair`. Inherits from `AtomEventInstancer`. - ---- - -## `DoublePairEventInstancer` - -Event Instancer of type `DoublePair`. Inherits from `AtomEventInstancer`. - ---- - -## `IntEventInstancer` - -Event Instancer of type `int`. Inherits from `AtomEventInstancer`. - ---- - -## `Collision2DVariable` - -Variable of type `Collision2D`. Inherits from `AtomVariable`. - ---- - -## `BoolVariable` - -Variable of type `bool`. Inherits from `EquatableAtomVariable`. - ---- - -## `Vector2Variable` - -Variable of type `Vector2`. Inherits from `EquatableAtomVariable`. - -### Methods - -#### `MultiplyBy(System.Single)` - -Multiply variable by value. - -##### Parameters - -- `value` - Value to multiple by. - ---- - -#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Single})` - -Multiply variable by Variable value. - -##### Parameters - -- `variable` - Variable with value to multiple by. - ---- - -#### `DivideBy(System.Single)` - -Divide Variable by value. - -##### Parameters - -- `value` - Value to divide by. - ---- - -#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Single})` - -Divide Variable by Variable value. - -##### Parameters - -- `variable` - Variable value to divide by. - ---- - -## `ColliderVariable` - -Variable of type `Collider`. Inherits from `AtomVariable`. - ---- - -## `IntVariable` - -Variable of type `int`. Inherits from `EquatableAtomVariable`. - -### Methods - -#### `Add(System.Int32)` - -Add value to Variable. - -##### Parameters - -- `value` - Value to add. - ---- - -#### `Add(UnityAtoms.AtomBaseVariable{System.Int32})` - -Add variable value to Variable. - -##### Parameters - -- `variable` - Variable with value to add. - ---- - -#### `Subtract(System.Int32)` - -Subtract value from Variable. - -##### Parameters - -- `value` - Value to subtract. - ---- - -#### `Subtract(UnityAtoms.AtomBaseVariable{System.Int32})` - -Subtract variable value from Variable. - -##### Parameters - -- `variable` - Variable with value to subtract. - ---- - -#### `MultiplyBy(System.Int32)` - -Multiply variable by value. - -##### Parameters - -- `value` - Value to multiple by. - ---- - -#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Int32})` - -Multiply variable by Variable value. - -##### Parameters - -- `variable` - Variable with value to multiple by. - ---- - -#### `DivideBy(System.Int32)` - -Divide Variable by value. - -##### Parameters - -- `value` - Value to divide by. - ---- - -#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Int32})` - -Divide Variable by Variable value. - -##### Parameters - -- `variable` - Variable value to divide by. - ---- - -## `CollisionVariable` - -Variable of type `Collision`. Inherits from `AtomVariable`. - ---- - -## `FloatVariable` - -Variable of type `float`. Inherits from `EquatableAtomVariable`. - -### Methods - -#### `Add(System.Single)` - -Add value to Variable. - -##### Parameters - -- `value` - Value to add. - ---- - -#### `Add(UnityAtoms.AtomBaseVariable{System.Single})` - -Add variable value to Variable. - -##### Parameters - -- `variable` - Variable with value to add. - ---- - -#### `Subtract(System.Single)` - -Subtract value from Variable. - -##### Parameters - -- `value` - Value to subtract. - ---- - -#### `Subtract(UnityAtoms.AtomBaseVariable{System.Single})` - -Subtract variable value from Variable. - -##### Parameters - -- `variable` - Variable with value to subtract. - ---- - -#### `MultiplyBy(System.Single)` - -Multiply variable by value. - -##### Parameters - -- `value` - Value to multiple by. - ---- - -#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Single})` - -Multiply variable by Variable value. - -##### Parameters - -- `variable` - Variable with value to multiple by. - ---- - -#### `DivideBy(System.Single)` - -Divide Variable by value. - -##### Parameters - -- `value` - Value to divide by. - ---- - -#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Single})` - -Divide Variable by Variable value. - -##### Parameters - -- `variable` - Variable value to divide by. - ---- - -## `StringVariable` - -Variable of type `string`. Inherits from `EquatableAtomVariable`. - ---- - -## `GameObjectVariable` - -Variable of type `GameObject`. Inherits from `AtomVariable`. - ---- - -## `Collider2DVariable` - -Variable of type `Collider2D`. Inherits from `AtomVariable`. - ---- - -## `QuaternionVariable` - -Variable of type `Quaternion`. Inherits from `EquatableAtomVariable`. - ---- - -## `ColorVariable` - -Variable of type `Color`. Inherits from `EquatableAtomVariable`. - -### Methods - -#### `SetAlpha(System.Single)` - -Set Alpha of Color by value. - -##### Parameters - -- `value` - New alpha value. - ---- - -#### `SetAlpha(UnityAtoms.AtomBaseVariable{System.Single})` - -Set Alpha of Color by Variable value. - -##### Parameters - -- `variable` - New alpha Variable value. - ---- - -## `Vector3Variable` - -Variable of type `Vector3`. Inherits from `EquatableAtomVariable`. - -### Methods - -#### `MultiplyBy(System.Single)` - -Multiply variable by value. - -##### Parameters - -- `value` - Value to multiple by. - ---- - -#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Single})` - -Multiply variable by Variable value. - -##### Parameters - -- `variable` - Variable with value to multiple by. - ---- - -#### `DivideBy(System.Single)` - -Divide Variable by value. - -##### Parameters - -- `value` - Value to divide by. - ---- - -#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Single})` - -Divide Variable by Variable value. - -##### Parameters - -- `variable` - Variable value to divide by. - ---- - -## `DoubleVariable` - -Variable of type `double`. Inherits from `EquatableAtomVariable`. - ---- - -## `Vector2Condition` - -Condition of type `Vector2`. Inherits from `AtomCondition`. - ---- - -## `FloatCondition` - -Condition of type `float`. Inherits from `AtomCondition`. - ---- - -## `Collision2DCondition` - -Condition of type `Collision2D`. Inherits from `AtomCondition`. - ---- - -## `CollisionCondition` - -Condition of type `Collision`. Inherits from `AtomCondition`. - ---- - -## `QuaternionCondition` - -Condition of type `Quaternion`. Inherits from `AtomCondition`. - ---- - -## `ColliderCondition` - -Condition of type `Collider`. Inherits from `AtomCondition`. - ---- - -## `IntCondition` - -Condition of type `int`. Inherits from `AtomCondition`. - ---- - -## `ColorCondition` - -Condition of type `Color`. Inherits from `AtomCondition`. - ---- - -## `BoolCondition` - -Condition of type `bool`. Inherits from `AtomCondition`. - ---- - -## `Collider2DCondition` - -Condition of type `Collider2D`. Inherits from `AtomCondition`. - ---- - -## `GameObjectCondition` - -Condition of type `GameObject`. Inherits from `AtomCondition`. - ---- - -## `Vector3Condition` - -Condition of type `Vector3`. Inherits from `AtomCondition`. - ---- - -## `StringCondition` - -Condition of type `string`. Inherits from `AtomCondition`. - ---- - -## `DoubleCondition` - -Condition of type `double`. Inherits from `AtomCondition`. - ---- - -## `AtomBaseVariableAction` - -Action of type `AtomBaseVariable`. Inherits from `AtomAction`. - ---- - -## `GameObjectAction` - -Action of type `GameObject`. Inherits from `AtomAction`. - ---- - -## `Vector2PairAction` - -Action of type `Vector2Pair`. Inherits from `AtomAction`. - ---- - -## `Vector2Action` - -Action of type `Vector2`. Inherits from `AtomAction`. - ---- - -## `Vector3Action` - -Action of type `Vector3`. Inherits from `AtomAction`. - ---- - -## `FloatPairAction` - -Action of type `FloatPair`. Inherits from `AtomAction`. - ---- - -## `ColorAction` - -Action of type `Color`. Inherits from `AtomAction`. - ---- - -## `CollisionPairAction` - -Action of type `CollisionPair`. Inherits from `AtomAction`. - ---- - -## `IntPairAction` - -Action of type `IntPair`. Inherits from `AtomAction`. - ---- - -## `Vector3PairAction` - -Action of type `Vector3Pair`. Inherits from `AtomAction`. - ---- - -## `ColliderAction` - -Action of type `Collider`. Inherits from `AtomAction`. - ---- - -## `StringAction` - -Action of type `string`. Inherits from `AtomAction`. - ---- - -## `Collider2DPairAction` - -Action of type `Collider2DPair`. Inherits from `AtomAction`. - ---- - -## `BoolPairAction` - -Action of type `BoolPair`. Inherits from `AtomAction`. - ---- - -## `ColliderPairAction` - -Action of type `ColliderPair`. Inherits from `AtomAction`. - ---- - -## `BoolAction` - -Action of type `bool`. Inherits from `AtomAction`. - ---- - -## `GameObjectPairAction` - -Action of type `GameObjectPair`. Inherits from `AtomAction`. - ---- - -## `DoubleAction` - -Action of type `double`. Inherits from `AtomAction`. - ---- - -## `DoublePairAction` - -Action of type `DoublePair`. Inherits from `AtomAction`. - ---- - -## `Collision2DPairAction` - -Action of type `Collision2DPair`. Inherits from `AtomAction`. - ---- - -## `QuaternionAction` - -Action of type `Quaternion`. Inherits from `AtomAction`. - ---- - -## `QuaternionPairAction` - -Action of type `QuaternionPair`. Inherits from `AtomAction`. - ---- - -## `IntAction` - -Action of type `int`. Inherits from `AtomAction`. - ---- - -## `CollisionAction` - -Action of type `Collision`. Inherits from `AtomAction`. - ---- - -## `StringPairAction` - -Action of type `StringPair`. Inherits from `AtomAction`. - ---- - -## `ColorPairAction` - -Action of type `ColorPair`. Inherits from `AtomAction`. - ---- - -## `FloatAction` - -Action of type `float`. Inherits from `AtomAction`. - ---- - -## `Collider2DAction` - -Action of type `Collider2D`. Inherits from `AtomAction`. - ---- - -## `Collision2DAction` - -Action of type `Collision2D`. Inherits from `AtomAction`. - ---- - -## `FloatFloatFunction` - -Function x 2 of type `float`. Inherits from `AtomFunction`. - ---- - -## `Vector3Vector3Function` - -Function x 2 of type `Vector3`. Inherits from `AtomFunction`. - ---- - -## `IntIntFunction` - -Function x 2 of type `int`. Inherits from `AtomFunction`. - ---- - -## `BoolBoolFunction` - -Function x 2 of type `bool`. Inherits from `AtomFunction`. - ---- - -## `Collider2DCollider2DFunction` - -Function x 2 of type `Collider2D`. Inherits from `AtomFunction`. - ---- - -## `Vector2Vector2Function` - -Function x 2 of type `Vector2`. Inherits from `AtomFunction`. - ---- - -## `GameObjectGameObjectFunction` - -Function x 2 of type `GameObject`. Inherits from `AtomFunction`. - ---- - -## `Collision2DCollision2DFunction` - -Function x 2 of type `Collision2D`. Inherits from `AtomFunction`. - ---- - -## `CollisionCollisionFunction` - -Function x 2 of type `Collision`. Inherits from `AtomFunction`. - ---- - -## `DoubleDoubleFunction` - -Function x 2 of type `double`. Inherits from `AtomFunction`. - ---- - -## `QuaternionQuaternionFunction` - -Function x 2 of type `Quaternion`. Inherits from `AtomFunction`. - ---- - -## `StringStringFunction` - -Function x 2 of type `string`. Inherits from `AtomFunction`. - ---- - -## `ColorColorFunction` - -Function x 2 of type `Color`. Inherits from `AtomFunction`. - ---- - -## `ColliderColliderFunction` - -Function x 2 of type `Collider`. Inherits from `AtomFunction`. - ---- - -## `SyncCollider2DVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Collider2D to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncGameObjectVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type GameObject to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncDoubleVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type double to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncColliderVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Collider to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncVector2VariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Vector2 to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncBoolVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type bool to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncQuaternionVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Quaternion to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncCollisionVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Collision to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncVector3VariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Vector3 to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncFloatVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type float to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncStringVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type string to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncColorVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Color to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncCollision2DVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Collision2D to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncIntVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type int to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `FloatPairEvent` - -Event of type `FloatPair`. Inherits from `AtomEvent`. - ---- - -## `DoubleEvent` - -Event of type `double`. Inherits from `AtomEvent`. - ---- - -## `Collision2DPairEvent` - -Event of type `Collision2DPair`. Inherits from `AtomEvent`. - ---- - -## `Vector2PairEvent` - -Event of type `Vector2Pair`. Inherits from `AtomEvent`. - ---- - -## `ColliderEvent` - -Event of type `Collider`. Inherits from `AtomEvent`. - ---- - -## `GameObjectEvent` - -Event of type `GameObject`. Inherits from `AtomEvent`. - ---- - -## `CollisionEvent` - -Event of type `Collision`. Inherits from `AtomEvent`. - ---- - -## `BoolPairEvent` - -Event of type `BoolPair`. Inherits from `AtomEvent`. - ---- - -## `Collision2DEvent` - -Event of type `Collision2D`. Inherits from `AtomEvent`. - ---- - -## `ColorPairEvent` - -Event of type `ColorPair`. Inherits from `AtomEvent`. - ---- - -## `ColliderPairEvent` - -Event of type `ColliderPair`. Inherits from `AtomEvent`. - ---- - -## `IntPairEvent` - -Event of type `IntPair`. Inherits from `AtomEvent`. - ---- - -## `CollisionPairEvent` - -Event of type `CollisionPair`. Inherits from `AtomEvent`. - ---- - -## `QuaternionPairEvent` - -Event of type `QuaternionPair`. Inherits from `AtomEvent`. - ---- - -## `GameObjectPairEvent` - -Event of type `GameObjectPair`. Inherits from `AtomEvent`. - ---- - -## `Vector3Event` - -Event of type `Vector3`. Inherits from `AtomEvent`. - ---- - -## `Collider2DPairEvent` - -Event of type `Collider2DPair`. Inherits from `AtomEvent`. - ---- - -## `BoolEvent` - -Event of type `bool`. Inherits from `AtomEvent`. - ---- - -## `StringEvent` - -Event of type `string`. Inherits from `AtomEvent`. - ---- - -## `Vector3PairEvent` - -Event of type `Vector3Pair`. Inherits from `AtomEvent`. - ---- - -## `AtomBaseVariableEvent` - -Event of type `AtomBaseVariable`. Inherits from `AtomEvent`. - ---- - -## `ColorEvent` - -Event of type `Color`. Inherits from `AtomEvent`. - ---- - -## `VoidEvent` - -Event of type `Void`. Inherits from `AtomEvent`. - ---- - -## `Vector2Event` - -Event of type `Vector2`. Inherits from `AtomEvent`. - ---- - -## `QuaternionEvent` - -Event of type `Quaternion`. Inherits from `AtomEvent`. - ---- - -## `DoublePairEvent` - -Event of type `DoublePair`. Inherits from `AtomEvent`. - ---- - -## `StringPairEvent` - -Event of type `StringPair`. Inherits from `AtomEvent`. - ---- - -## `FloatEvent` - -Event of type `float`. Inherits from `AtomEvent`. - ---- - -## `Collider2DEvent` - -Event of type `Collider2D`. Inherits from `AtomEvent`. - ---- - -## `IntEvent` - -Event of type `int`. Inherits from `AtomEvent`. - ---- - -## `AtomBaseVariableBaseEventReferenceListener` - -Event Reference Listener of type `AtomBaseVariable`. Inherits from `AtomEventReferenceListener`. - ---- - -## `VoidBaseEventReferenceListener` - -Event Reference Listener of type `Void`. Inherits from `AtomEventReferenceListener`. - ---- - -## `AtomListInstancer` - -AtomList Instancer that creates an in memory copy of a List at runtime. - ---- - -## `StringReferenceAtomBaseVariableDictionary` - -A SerializableDictionary of type StringReference and AtomBaseVariable. Used by AtomCollection. - -### Methods - -#### `Get(System.String)` - -Generic getter. - -#### Type Parameters - -- `T` - The expected type of the value you want to retrieve. - -##### Parameters - -- `key` - The key associated with the value you want to retrieve. - -##### Returns - -The value of type T if found, otherwise null. - ---- - -#### `Get(UnityAtoms.AtomBaseVariable{System.String})` - -Generic getter. - -#### Type Parameters - -- `T` - The expected type of the value you want to retrieve. - -##### Parameters - -- `key` - The key associated with the value you want to retrieve. - -##### Returns - -The value of type T if found, otherwise null. - ---- - -#### `Add(System.String,UnityAtoms.AtomBaseVariable)` - -Add value and its associated key to the dictionary. - -##### Parameters - -- `key` - The key associated with the value. -- `value` - The value to add. - ---- - -#### `Add(UnityAtoms.AtomBaseVariable{System.String},UnityAtoms.AtomBaseVariable)` - -Add value and its associated key to the dictionary. - -##### Parameters - -- `key` - The key associated with the value. -- `value` - The value to add. - ---- - -#### `Remove(System.String)` - -Remove item by key from the collection. - -##### Parameters - -- `key` - The key that you want to remove. - -##### Returns - -True if it removed a value from the collection, otherwise false. - ---- - -#### `Remove(UnityAtoms.AtomBaseVariable{System.String})` - -Remove item by key from the collection. - -##### Parameters - -- `key` - The key that you want to remove. - -##### Returns - -True if it removed a value from the collection, otherwise false. - ---- - -## `SerializableDictionary` - -#### Type Parameters - -- `K` - Key type. -- `V` - Value type. - -A Serializable dictionary used by AtomCollection. - -### Variables - -#### `_duplicateKeyIndices` - -Needed in order to keep track of duplicate keys in the dictionary. - ---- - -## `AtomCollectionReferenceUsage` - -Different types of usages for an Atom Collection Reference. - ---- - -## `AtomCollectionReference` - -Reference of type `AtomCollection`. Inherits from `AtomBaseReference`. - -### Variables - -#### `_collection` - -Variable used if `Usage` is set to `COLLECTION`. - ---- - -#### `_instancer` - -Variable Instancer used if `Usage` is set to `COLLECTION_INSTANCER`. - -### Properties - -#### `Collection` - -Get the value for the Reference. - -### Methods - -#### `GetValue` - -Get value as an `IAtomCollection`. Needed in order to inject Collection References into the Variable Instancer class. - -##### Returns - -The value as an `IAtomList`. - ---- - -## `SyncListInstancerToCollection` - -Adds Variable Instancer's List to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SyncCollectionInstancerToCollection` - -Adds Variable Instancer's Collection to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - ## `AtomBaseCollectionInstancer` #### Type Parameters @@ -2283,186 +372,6 @@ Creates in memory copies of the Added, Removed and Cleared Events on OnEnable. --- -## `AtomList` - -A List of Atom Variables (AtomBaseVariable). - -### Properties - -#### `Added` - -Event for when and item is added to the list. - ---- - -#### `Removed` - -Event for when and item is removed from the list. - ---- - -#### `Cleared` - -Event for when the list is cleared. - -### Methods - -#### `GetValue` - -Get value as an `IAtomList`. Needed in order to inject Lists into the Variable Instancer class. - -##### Returns - -The value as an `IAtomList`. - ---- - -#### `ObserveAdd` - -Make the add event into an `IObservable`. Makes List's add Event compatible with for example UniRx. - -##### Returns - -The add Event as an `IObservable`. - ---- - -#### `ObserveRemove` - -Make the remove event into an `IObservable`. Makes List's remove Event compatible with for example UniRx. - -##### Returns - -The remove Event as an `IObservable`. - ---- - -#### `ObserveClear` - -Make the clear event into an `IObservable`. Makes List's clear Event compatible with for example UniRx. - -##### Returns - -The clear Event as an `IObservable`. - ---- - -## `AtomCollectionInstancer` - -AtomCollection Instancer that creates an in memory copy of a Collection at runtime. - ---- - -## `AtomListReferenceUsage` - -Different types of usages for an Atom List Reference. - ---- - -## `AtomListReference` - -Reference of type `AtomList`. Inherits from `AtomBaseReference`. - -### Variables - -#### `_list` - -Variable used if `Usage` is set to `LIST`. - ---- - -#### `_instancer` - -Variable Instancer used if `Usage` is set to `LIST_INSTANCER`. - -### Properties - -#### `List` - -Get the value for the Reference. - -### Methods - -#### `GetValue` - -Get value as an `IAtomList`. Needed in order to inject List References into the Variable Instancer class. - -##### Returns - -The value as an `IAtomList`. - ---- - -## `IWithCollectionEvents` - -Interface for all Atom Collections. - ---- - -## `AtomCollection` - -A Collection / Dictionary of Atom Variables (`AtomBaseVariable`). - -### Properties - -#### `Added` - -Event for when and item is added to the collection. - ---- - -#### `Removed` - -Event for when and item is removed from the collection. - ---- - -#### `Cleared` - -Event for when the collection is cleared. - -### Methods - -#### `GetValue` - -Get value as an `IAtomCollection`. Needed in order to inject Collection into the Variable Instancer class. - -##### Returns - -The value as an `IAtomCollection`. - ---- - -#### `ObserveAdd` - -Make the add event into an `IObservable`. Makes Collection's add Event compatible with for example UniRx. - -##### Returns - -The add Event as an `IObservable`. - ---- - -#### `ObserveRemove` - -Make the remove event into an `IObservable`. Makes Collection's remove Event compatible with for example UniRx. - -##### Returns - -The remove Event as an `IObservable`. - ---- - -#### `ObserveClear` - -Make the clear event into an `IObservable`. Makes Collection's clear Event compatible with for example UniRx. - -##### Returns - -The clear Event as an `IObservable`. - ---- - ## `AtomBaseVariableList` A List of type AtomBaseVariable. Used by AtomList. @@ -2574,6 +483,1343 @@ Clear list. --- +## `AtomCollection` + +A Collection / Dictionary of Atom Variables (`AtomBaseVariable`). + +### Properties + +#### `Added` + +Event for when and item is added to the collection. + +--- + +#### `Removed` + +Event for when and item is removed from the collection. + +--- + +#### `Cleared` + +Event for when the collection is cleared. + +### Methods + +#### `GetValue` + +Get value as an `IAtomCollection`. Needed in order to inject Collection into the Variable Instancer class. + +##### Returns + +The value as an `IAtomCollection`. + +--- + +#### `ObserveAdd` + +Make the add event into an `IObservable`. Makes Collection's add Event compatible with for example UniRx. + +##### Returns + +The add Event as an `IObservable`. + +--- + +#### `ObserveRemove` + +Make the remove event into an `IObservable`. Makes Collection's remove Event compatible with for example UniRx. + +##### Returns + +The remove Event as an `IObservable`. + +--- + +#### `ObserveClear` + +Make the clear event into an `IObservable`. Makes Collection's clear Event compatible with for example UniRx. + +##### Returns + +The clear Event as an `IObservable`. + +--- + +## `AtomCollectionInstancer` + +AtomCollection Instancer that creates an in memory copy of a Collection at runtime. + +--- + +## `AtomCollectionReferenceUsage` + +Different types of usages for an Atom Collection Reference. + +--- + +## `AtomCollectionReference` + +Reference of type `AtomCollection`. Inherits from `AtomBaseReference`. + +### Variables + +#### `_collection` + +Variable used if `Usage` is set to `COLLECTION`. + +--- + +#### `_instancer` + +Variable Instancer used if `Usage` is set to `COLLECTION_INSTANCER`. + +### Properties + +#### `Collection` + +Get the value for the Reference. + +### Methods + +#### `GetValue` + +Get value as an `IAtomCollection`. Needed in order to inject Collection References into the Variable Instancer class. + +##### Returns + +The value as an `IAtomList`. + +--- + +## `AtomList` + +A List of Atom Variables (AtomBaseVariable). + +### Properties + +#### `Added` + +Event for when and item is added to the list. + +--- + +#### `Removed` + +Event for when and item is removed from the list. + +--- + +#### `Cleared` + +Event for when the list is cleared. + +### Methods + +#### `GetValue` + +Get value as an `IAtomList`. Needed in order to inject Lists into the Variable Instancer class. + +##### Returns + +The value as an `IAtomList`. + +--- + +#### `ObserveAdd` + +Make the add event into an `IObservable`. Makes List's add Event compatible with for example UniRx. + +##### Returns + +The add Event as an `IObservable`. + +--- + +#### `ObserveRemove` + +Make the remove event into an `IObservable`. Makes List's remove Event compatible with for example UniRx. + +##### Returns + +The remove Event as an `IObservable`. + +--- + +#### `ObserveClear` + +Make the clear event into an `IObservable`. Makes List's clear Event compatible with for example UniRx. + +##### Returns + +The clear Event as an `IObservable`. + +--- + +## `AtomListInstancer` + +AtomList Instancer that creates an in memory copy of a List at runtime. + +--- + +## `AtomListReferenceUsage` + +Different types of usages for an Atom List Reference. + +--- + +## `AtomListReference` + +Reference of type `AtomList`. Inherits from `AtomBaseReference`. + +### Variables + +#### `_list` + +Variable used if `Usage` is set to `LIST`. + +--- + +#### `_instancer` + +Variable Instancer used if `Usage` is set to `LIST_INSTANCER`. + +### Properties + +#### `List` + +Get the value for the Reference. + +### Methods + +#### `GetValue` + +Get value as an `IAtomList`. Needed in order to inject List References into the Variable Instancer class. + +##### Returns + +The value as an `IAtomList`. + +--- + +## `IWithCollectionEvents` + +Interface for all Atom Collections. + +--- + +## `SerializableDictionary` + +#### Type Parameters + +- `K` - Key type. +- `V` - Value type. + +A Serializable dictionary used by AtomCollection. + +### Variables + +#### `_duplicateKeyIndices` + +Needed in order to keep track of duplicate keys in the dictionary. + +--- + +## `StringReferenceAtomBaseVariableDictionary` + +A SerializableDictionary of type StringReference and AtomBaseVariable. Used by AtomCollection. + +### Methods + +#### `Get(System.String)` + +Generic getter. + +#### Type Parameters + +- `T` - The expected type of the value you want to retrieve. + +##### Parameters + +- `key` - The key associated with the value you want to retrieve. + +##### Returns + +The value of type T if found, otherwise null. + +--- + +#### `Get(UnityAtoms.AtomBaseVariable{System.String})` + +Generic getter. + +#### Type Parameters + +- `T` - The expected type of the value you want to retrieve. + +##### Parameters + +- `key` - The key associated with the value you want to retrieve. + +##### Returns + +The value of type T if found, otherwise null. + +--- + +#### `Add(System.String,UnityAtoms.AtomBaseVariable)` + +Add value and its associated key to the dictionary. + +##### Parameters + +- `key` - The key associated with the value. +- `value` - The value to add. + +--- + +#### `Add(UnityAtoms.AtomBaseVariable{System.String},UnityAtoms.AtomBaseVariable)` + +Add value and its associated key to the dictionary. + +##### Parameters + +- `key` - The key associated with the value. +- `value` - The value to add. + +--- + +#### `Remove(System.String)` + +Remove item by key from the collection. + +##### Parameters + +- `key` - The key that you want to remove. + +##### Returns + +True if it removed a value from the collection, otherwise false. + +--- + +#### `Remove(UnityAtoms.AtomBaseVariable{System.String})` + +Remove item by key from the collection. + +##### Parameters + +- `key` - The key that you want to remove. + +##### Returns + +True if it removed a value from the collection, otherwise false. + +--- + +## `SyncCollectionInstancerToCollection` + +Adds Variable Instancer's Collection to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncListInstancerToCollection` + +Adds Variable Instancer's List to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `BoolCondition` + +Condition of type `bool`. Inherits from `AtomCondition`. + +--- + +## `Collider2DCondition` + +Condition of type `Collider2D`. Inherits from `AtomCondition`. + +--- + +## `ColliderCondition` + +Condition of type `Collider`. Inherits from `AtomCondition`. + +--- + +## `Collision2DCondition` + +Condition of type `Collision2D`. Inherits from `AtomCondition`. + +--- + +## `CollisionCondition` + +Condition of type `Collision`. Inherits from `AtomCondition`. + +--- + +## `ColorCondition` + +Condition of type `Color`. Inherits from `AtomCondition`. + +--- + +## `DoubleCondition` + +Condition of type `double`. Inherits from `AtomCondition`. + +--- + +## `FloatCondition` + +Condition of type `float`. Inherits from `AtomCondition`. + +--- + +## `GameObjectCondition` + +Condition of type `GameObject`. Inherits from `AtomCondition`. + +--- + +## `IntCondition` + +Condition of type `int`. Inherits from `AtomCondition`. + +--- + +## `QuaternionCondition` + +Condition of type `Quaternion`. Inherits from `AtomCondition`. + +--- + +## `StringCondition` + +Condition of type `string`. Inherits from `AtomCondition`. + +--- + +## `Vector2Condition` + +Condition of type `Vector2`. Inherits from `AtomCondition`. + +--- + +## `Vector3Condition` + +Condition of type `Vector3`. Inherits from `AtomCondition`. + +--- + +## `BoolConstant` + +Constant of type `bool`. Inherits from `AtomBaseVariable`. + +--- + +## `Collider2DConstant` + +Constant of type `Collider2D`. Inherits from `AtomBaseVariable`. + +--- + +## `ColliderConstant` + +Constant of type `Collider`. Inherits from `AtomBaseVariable`. + +--- + +## `Collision2DConstant` + +Constant of type `Collision2D`. Inherits from `AtomBaseVariable`. + +--- + +## `CollisionConstant` + +Constant of type `Collision`. Inherits from `AtomBaseVariable`. + +--- + +## `ColorConstant` + +Constant of type `Color`. Inherits from `AtomBaseVariable`. + +--- + +## `DoubleConstant` + +Constant of type `double`. Inherits from `AtomBaseVariable`. + +--- + +## `FloatConstant` + +Constant of type `float`. Inherits from `AtomBaseVariable`. + +--- + +## `GameObjectConstant` + +Constant of type `GameObject`. Inherits from `AtomBaseVariable`. + +--- + +## `IntConstant` + +Constant of type `int`. Inherits from `AtomBaseVariable`. + +--- + +## `QuaternionConstant` + +Constant of type `Quaternion`. Inherits from `AtomBaseVariable`. + +--- + +## `StringConstant` + +Constant of type `string`. Inherits from `AtomBaseVariable`. + +--- + +## `Vector2Constant` + +Constant of type `Vector2`. Inherits from `AtomBaseVariable`. + +--- + +## `Vector3Constant` + +Constant of type `Vector3`. Inherits from `AtomBaseVariable`. + +--- + +## `AtomBaseVariableEventInstancer` + +Event Instancer of type `AtomBaseVariable`. Inherits from `AtomEventInstancer`. + +--- + +## `BoolEventInstancer` + +Event Instancer of type `bool`. Inherits from `AtomEventInstancer`. + +--- + +## `BoolPairEventInstancer` + +Event Instancer of type `BoolPair`. Inherits from `AtomEventInstancer`. + +--- + +## `Collider2DEventInstancer` + +Event Instancer of type `Collider2D`. Inherits from `AtomEventInstancer`. + +--- + +## `Collider2DPairEventInstancer` + +Event Instancer of type `Collider2DPair`. Inherits from `AtomEventInstancer`. + +--- + +## `ColliderEventInstancer` + +Event Instancer of type `Collider`. Inherits from `AtomEventInstancer`. + +--- + +## `ColliderPairEventInstancer` + +Event Instancer of type `ColliderPair`. Inherits from `AtomEventInstancer`. + +--- + +## `Collision2DEventInstancer` + +Event Instancer of type `Collision2D`. Inherits from `AtomEventInstancer`. + +--- + +## `Collision2DPairEventInstancer` + +Event Instancer of type `Collision2DPair`. Inherits from `AtomEventInstancer`. + +--- + +## `CollisionEventInstancer` + +Event Instancer of type `Collision`. Inherits from `AtomEventInstancer`. + +--- + +## `CollisionPairEventInstancer` + +Event Instancer of type `CollisionPair`. Inherits from `AtomEventInstancer`. + +--- + +## `ColorEventInstancer` + +Event Instancer of type `Color`. Inherits from `AtomEventInstancer`. + +--- + +## `ColorPairEventInstancer` + +Event Instancer of type `ColorPair`. Inherits from `AtomEventInstancer`. + +--- + +## `DoubleEventInstancer` + +Event Instancer of type `double`. Inherits from `AtomEventInstancer`. + +--- + +## `DoublePairEventInstancer` + +Event Instancer of type `DoublePair`. Inherits from `AtomEventInstancer`. + +--- + +## `FloatEventInstancer` + +Event Instancer of type `float`. Inherits from `AtomEventInstancer`. + +--- + +## `FloatPairEventInstancer` + +Event Instancer of type `FloatPair`. Inherits from `AtomEventInstancer`. + +--- + +## `GameObjectEventInstancer` + +Event Instancer of type `GameObject`. Inherits from `AtomEventInstancer`. + +--- + +## `GameObjectPairEventInstancer` + +Event Instancer of type `GameObjectPair`. Inherits from `AtomEventInstancer`. + +--- + +## `IntEventInstancer` + +Event Instancer of type `int`. Inherits from `AtomEventInstancer`. + +--- + +## `IntPairEventInstancer` + +Event Instancer of type `IntPair`. Inherits from `AtomEventInstancer`. + +--- + +## `QuaternionEventInstancer` + +Event Instancer of type `Quaternion`. Inherits from `AtomEventInstancer`. + +--- + +## `QuaternionPairEventInstancer` + +Event Instancer of type `QuaternionPair`. Inherits from `AtomEventInstancer`. + +--- + +## `StringEventInstancer` + +Event Instancer of type `string`. Inherits from `AtomEventInstancer`. + +--- + +## `StringPairEventInstancer` + +Event Instancer of type `StringPair`. Inherits from `AtomEventInstancer`. + +--- + +## `Vector2EventInstancer` + +Event Instancer of type `Vector2`. Inherits from `AtomEventInstancer`. + +--- + +## `Vector2PairEventInstancer` + +Event Instancer of type `Vector2Pair`. Inherits from `AtomEventInstancer`. + +--- + +## `Vector3EventInstancer` + +Event Instancer of type `Vector3`. Inherits from `AtomEventInstancer`. + +--- + +## `Vector3PairEventInstancer` + +Event Instancer of type `Vector3Pair`. Inherits from `AtomEventInstancer`. + +--- + +## `VoidEventInstancer` + +Event Instancer of type `Void`. Inherits from `AtomEventInstancer`. + +--- + +## `BoolEventReferenceListener` + +Event Reference Listener of type `bool`. Inherits from `AtomEventReferenceListener`. + +--- + +## `BoolPairEventReferenceListener` + +Event Reference Listener of type `BoolPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Collider2DEventReferenceListener` + +Event Reference Listener of type `Collider2D`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Collider2DPairEventReferenceListener` + +Event Reference Listener of type `Collider2DPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `ColliderEventReferenceListener` + +Event Reference Listener of type `Collider`. Inherits from `AtomEventReferenceListener`. + +--- + +## `ColliderPairEventReferenceListener` + +Event Reference Listener of type `ColliderPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Collision2DEventReferenceListener` + +Event Reference Listener of type `Collision2D`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Collision2DPairEventReferenceListener` + +Event Reference Listener of type `Collision2DPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `CollisionEventReferenceListener` + +Event Reference Listener of type `Collision`. Inherits from `AtomEventReferenceListener`. + +--- + +## `CollisionPairEventReferenceListener` + +Event Reference Listener of type `CollisionPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `ColorEventReferenceListener` + +Event Reference Listener of type `Color`. Inherits from `AtomEventReferenceListener`. + +--- + +## `ColorPairEventReferenceListener` + +Event Reference Listener of type `ColorPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `DoubleEventReferenceListener` + +Event Reference Listener of type `double`. Inherits from `AtomEventReferenceListener`. + +--- + +## `DoublePairEventReferenceListener` + +Event Reference Listener of type `DoublePair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `FloatEventReferenceListener` + +Event Reference Listener of type `float`. Inherits from `AtomEventReferenceListener`. + +--- + +## `FloatPairEventReferenceListener` + +Event Reference Listener of type `FloatPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `GameObjectEventReferenceListener` + +Event Reference Listener of type `GameObject`. Inherits from `AtomEventReferenceListener`. + +--- + +## `GameObjectPairEventReferenceListener` + +Event Reference Listener of type `GameObjectPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `IntEventReferenceListener` + +Event Reference Listener of type `int`. Inherits from `AtomEventReferenceListener`. + +--- + +## `IntPairEventReferenceListener` + +Event Reference Listener of type `IntPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `QuaternionEventReferenceListener` + +Event Reference Listener of type `Quaternion`. Inherits from `AtomEventReferenceListener`. + +--- + +## `QuaternionPairEventReferenceListener` + +Event Reference Listener of type `QuaternionPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `StringEventReferenceListener` + +Event Reference Listener of type `string`. Inherits from `AtomEventReferenceListener`. + +--- + +## `StringPairEventReferenceListener` + +Event Reference Listener of type `StringPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Vector2EventReferenceListener` + +Event Reference Listener of type `Vector2`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Vector2PairEventReferenceListener` + +Event Reference Listener of type `Vector2Pair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Vector3EventReferenceListener` + +Event Reference Listener of type `Vector3`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Vector3PairEventReferenceListener` + +Event Reference Listener of type `Vector3Pair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `BoolEventReference` + +Event Reference of type `bool`. Inherits from `AtomEventReference`. + +--- + +## `BoolPairEventReference` + +Event Reference of type `BoolPair`. Inherits from `AtomEventReference`. + +--- + +## `Collider2DEventReference` + +Event Reference of type `Collider2D`. Inherits from `AtomEventReference`. + +--- + +## `Collider2DPairEventReference` + +Event Reference of type `Collider2DPair`. Inherits from `AtomEventReference`. + +--- + +## `ColliderEventReference` + +Event Reference of type `Collider`. Inherits from `AtomEventReference`. + +--- + +## `ColliderPairEventReference` + +Event Reference of type `ColliderPair`. Inherits from `AtomEventReference`. + +--- + +## `Collision2DEventReference` + +Event Reference of type `Collision2D`. Inherits from `AtomEventReference`. + +--- + +## `Collision2DPairEventReference` + +Event Reference of type `Collision2DPair`. Inherits from `AtomEventReference`. + +--- + +## `CollisionEventReference` + +Event Reference of type `Collision`. Inherits from `AtomEventReference`. + +--- + +## `CollisionPairEventReference` + +Event Reference of type `CollisionPair`. Inherits from `AtomEventReference`. + +--- + +## `ColorEventReference` + +Event Reference of type `Color`. Inherits from `AtomEventReference`. + +--- + +## `ColorPairEventReference` + +Event Reference of type `ColorPair`. Inherits from `AtomEventReference`. + +--- + +## `DoubleEventReference` + +Event Reference of type `double`. Inherits from `AtomEventReference`. + +--- + +## `DoublePairEventReference` + +Event Reference of type `DoublePair`. Inherits from `AtomEventReference`. + +--- + +## `FloatEventReference` + +Event Reference of type `float`. Inherits from `AtomEventReference`. + +--- + +## `FloatPairEventReference` + +Event Reference of type `FloatPair`. Inherits from `AtomEventReference`. + +--- + +## `GameObjectEventReference` + +Event Reference of type `GameObject`. Inherits from `AtomEventReference`. + +--- + +## `GameObjectPairEventReference` + +Event Reference of type `GameObjectPair`. Inherits from `AtomEventReference`. + +--- + +## `IntEventReference` + +Event Reference of type `int`. Inherits from `AtomEventReference`. + +--- + +## `IntPairEventReference` + +Event Reference of type `IntPair`. Inherits from `AtomEventReference`. + +--- + +## `QuaternionEventReference` + +Event Reference of type `Quaternion`. Inherits from `AtomEventReference`. + +--- + +## `QuaternionPairEventReference` + +Event Reference of type `QuaternionPair`. Inherits from `AtomEventReference`. + +--- + +## `StringEventReference` + +Event Reference of type `string`. Inherits from `AtomEventReference`. + +--- + +## `StringPairEventReference` + +Event Reference of type `StringPair`. Inherits from `AtomEventReference`. + +--- + +## `Vector2EventReference` + +Event Reference of type `Vector2`. Inherits from `AtomEventReference`. + +--- + +## `Vector2PairEventReference` + +Event Reference of type `Vector2Pair`. Inherits from `AtomEventReference`. + +--- + +## `Vector3EventReference` + +Event Reference of type `Vector3`. Inherits from `AtomEventReference`. + +--- + +## `Vector3PairEventReference` + +Event Reference of type `Vector3Pair`. Inherits from `AtomEventReference`. + +--- + +## `AtomBaseVariableEvent` + +Event of type `AtomBaseVariable`. Inherits from `AtomEvent`. + +--- + +## `BoolEvent` + +Event of type `bool`. Inherits from `AtomEvent`. + +--- + +## `BoolPairEvent` + +Event of type `BoolPair`. Inherits from `AtomEvent`. + +--- + +## `Collider2DEvent` + +Event of type `Collider2D`. Inherits from `AtomEvent`. + +--- + +## `Collider2DPairEvent` + +Event of type `Collider2DPair`. Inherits from `AtomEvent`. + +--- + +## `ColliderEvent` + +Event of type `Collider`. Inherits from `AtomEvent`. + +--- + +## `ColliderPairEvent` + +Event of type `ColliderPair`. Inherits from `AtomEvent`. + +--- + +## `Collision2DEvent` + +Event of type `Collision2D`. Inherits from `AtomEvent`. + +--- + +## `Collision2DPairEvent` + +Event of type `Collision2DPair`. Inherits from `AtomEvent`. + +--- + +## `CollisionEvent` + +Event of type `Collision`. Inherits from `AtomEvent`. + +--- + +## `CollisionPairEvent` + +Event of type `CollisionPair`. Inherits from `AtomEvent`. + +--- + +## `ColorEvent` + +Event of type `Color`. Inherits from `AtomEvent`. + +--- + +## `ColorPairEvent` + +Event of type `ColorPair`. Inherits from `AtomEvent`. + +--- + +## `DoubleEvent` + +Event of type `double`. Inherits from `AtomEvent`. + +--- + +## `DoublePairEvent` + +Event of type `DoublePair`. Inherits from `AtomEvent`. + +--- + +## `FloatEvent` + +Event of type `float`. Inherits from `AtomEvent`. + +--- + +## `FloatPairEvent` + +Event of type `FloatPair`. Inherits from `AtomEvent`. + +--- + +## `GameObjectEvent` + +Event of type `GameObject`. Inherits from `AtomEvent`. + +--- + +## `GameObjectPairEvent` + +Event of type `GameObjectPair`. Inherits from `AtomEvent`. + +--- + +## `IntEvent` + +Event of type `int`. Inherits from `AtomEvent`. + +--- + +## `IntPairEvent` + +Event of type `IntPair`. Inherits from `AtomEvent`. + +--- + +## `QuaternionEvent` + +Event of type `Quaternion`. Inherits from `AtomEvent`. + +--- + +## `QuaternionPairEvent` + +Event of type `QuaternionPair`. Inherits from `AtomEvent`. + +--- + +## `StringEvent` + +Event of type `string`. Inherits from `AtomEvent`. + +--- + +## `StringPairEvent` + +Event of type `StringPair`. Inherits from `AtomEvent`. + +--- + +## `Vector2Event` + +Event of type `Vector2`. Inherits from `AtomEvent`. + +--- + +## `Vector2PairEvent` + +Event of type `Vector2Pair`. Inherits from `AtomEvent`. + +--- + +## `Vector3Event` + +Event of type `Vector3`. Inherits from `AtomEvent`. + +--- + +## `Vector3PairEvent` + +Event of type `Vector3Pair`. Inherits from `AtomEvent`. + +--- + +## `VoidEvent` + +Event of type `Void`. Inherits from `AtomEvent`. + +--- + +## `BoolBoolFunction` + +Function x 2 of type `bool`. Inherits from `AtomFunction`. + +--- + +## `Collider2DCollider2DFunction` + +Function x 2 of type `Collider2D`. Inherits from `AtomFunction`. + +--- + +## `ColliderColliderFunction` + +Function x 2 of type `Collider`. Inherits from `AtomFunction`. + +--- + +## `Collision2DCollision2DFunction` + +Function x 2 of type `Collision2D`. Inherits from `AtomFunction`. + +--- + +## `CollisionCollisionFunction` + +Function x 2 of type `Collision`. Inherits from `AtomFunction`. + +--- + +## `ColorColorFunction` + +Function x 2 of type `Color`. Inherits from `AtomFunction`. + +--- + +## `DoubleDoubleFunction` + +Function x 2 of type `double`. Inherits from `AtomFunction`. + +--- + +## `FloatFloatFunction` + +Function x 2 of type `float`. Inherits from `AtomFunction`. + +--- + +## `GameObjectGameObjectFunction` + +Function x 2 of type `GameObject`. Inherits from `AtomFunction`. + +--- + +## `IntIntFunction` + +Function x 2 of type `int`. Inherits from `AtomFunction`. + +--- + +## `QuaternionQuaternionFunction` + +Function x 2 of type `Quaternion`. Inherits from `AtomFunction`. + +--- + +## `StringStringFunction` + +Function x 2 of type `string`. Inherits from `AtomFunction`. + +--- + +## `Vector2Vector2Function` + +Function x 2 of type `Vector2`. Inherits from `AtomFunction`. + +--- + +## `Vector3Vector3Function` + +Function x 2 of type `Vector3`. Inherits from `AtomFunction`. + +--- + +## `ClampFloat` + +An `AtomFunction` that clamps the value using a min and a max value and returns it. + +### Variables + +#### `Min` + +The minimum value. + +--- + +#### `Max` + +The maximum value. + +--- + +## `ClampInt` + +An `AtomFunction` that clamps the value using a min and a max value and returns it. + +### Variables + +#### `Min` + +The minimum value. + +--- + +#### `Max` + +The maximum value. + +--- + +## `SyncGameObjectToList` + +Adds a GameObject to a GameObject Value List on OnEnable and removes it on OnDestroy. + +--- + ## `SyncVariableInstancerToCollection`3` Adds a Variable from a Variable Instancer to a Collection or List on OnEnable and removes it on OnDestroy. @@ -2604,27 +1850,455 @@ If assigned the Variable from the Variable Instancer will be added to the list o --- -## `SyncGameObjectToList` +## `BoolPair` -Adds a GameObject to a GameObject Value List on OnEnable and removes it on OnDestroy. +IPair of type ``. Inherits from `IPair`. --- -## `FloatValueList` +## `Collider2DPair` -Value List of type `float`. Inherits from `AtomValueList`. +IPair of type ``. Inherits from `IPair`. --- -## `Collision2DValueList` +## `ColliderPair` -Value List of type `Collision2D`. Inherits from `AtomValueList`. +IPair of type ``. Inherits from `IPair`. --- -## `Vector2ValueList` +## `Collision2DPair` -Value List of type `Vector2`. Inherits from `AtomValueList`. +IPair of type ``. Inherits from `IPair`. + +--- + +## `CollisionPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `ColorPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `DoublePair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `FloatPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `GameObjectPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `IntPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `QuaternionPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `StringPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `Vector2Pair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `Vector3Pair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `BoolReference` + +Reference of type `bool`. Inherits from `EquatableAtomReference`. + +--- + +## `Collider2DReference` + +Reference of type `Collider2D`. Inherits from `AtomReference`. + +--- + +## `ColliderReference` + +Reference of type `Collider`. Inherits from `AtomReference`. + +--- + +## `Collision2DReference` + +Reference of type `Collision2D`. Inherits from `AtomReference`. + +--- + +## `CollisionReference` + +Reference of type `Collision`. Inherits from `AtomReference`. + +--- + +## `ColorReference` + +Reference of type `Color`. Inherits from `EquatableAtomReference`. + +### Methods + +#### `SetAlpha(System.Single)` + +Set Alpha of Color by value. + +##### Parameters + +- `value` - New alpha value. + +--- + +#### `SetAlpha(UnityAtoms.AtomBaseVariable{System.Single})` + +Set Alpha of Color by Variable value. + +##### Parameters + +- `variable` - New alpha Variable value. + +--- + +## `DoubleReference` + +Reference of type `double`. Inherits from `EquatableAtomReference`. + +--- + +## `FloatReference` + +Reference of type `float`. Inherits from `EquatableAtomReference`. + +--- + +## `GameObjectReference` + +Reference of type `GameObject`. Inherits from `AtomReference`. + +--- + +## `IntReference` + +Reference of type `int`. Inherits from `EquatableAtomReference`. + +--- + +## `QuaternionReference` + +Reference of type `Quaternion`. Inherits from `EquatableAtomReference`. + +--- + +## `StringReference` + +Reference of type `string`. Inherits from `EquatableAtomReference`. + +--- + +## `Vector2Reference` + +Reference of type `Vector2`. Inherits from `EquatableAtomReference`. + +--- + +## `Vector3Reference` + +Reference of type `Vector3`. Inherits from `EquatableAtomReference`. + +--- + +## `SyncBoolVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type bool to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncCollider2DVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Collider2D to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncColliderVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Collider to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncCollision2DVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Collision2D to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncCollisionVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Collision to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncColorVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Color to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncDoubleVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type double to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncFloatVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type float to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncGameObjectVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type GameObject to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncIntVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type int to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncQuaternionVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Quaternion to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncStringVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type string to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncVector2VariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Vector2 to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `SyncVector3VariableInstancerToCollection` + +Adds Variable Instancer's Variable of type Vector3 to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + +## `AtomBaseVariableUnityEvent` + +None generic Unity Event of type `AtomBaseVariable`. Inherits from `UnityEvent`. + +--- + +## `BoolPairUnityEvent` + +None generic Unity Event of type `BoolPair`. Inherits from `UnityEvent`. + +--- + +## `BoolUnityEvent` + +None generic Unity Event of type `bool`. Inherits from `UnityEvent`. + +--- + +## `Collider2DPairUnityEvent` + +None generic Unity Event of type `Collider2DPair`. Inherits from `UnityEvent`. + +--- + +## `Collider2DUnityEvent` + +None generic Unity Event of type `Collider2D`. Inherits from `UnityEvent`. + +--- + +## `ColliderPairUnityEvent` + +None generic Unity Event of type `ColliderPair`. Inherits from `UnityEvent`. + +--- + +## `ColliderUnityEvent` + +None generic Unity Event of type `Collider`. Inherits from `UnityEvent`. + +--- + +## `Collision2DPairUnityEvent` + +None generic Unity Event of type `Collision2DPair`. Inherits from `UnityEvent`. + +--- + +## `Collision2DUnityEvent` + +None generic Unity Event of type `Collision2D`. Inherits from `UnityEvent`. + +--- + +## `CollisionPairUnityEvent` + +None generic Unity Event of type `CollisionPair`. Inherits from `UnityEvent`. + +--- + +## `CollisionUnityEvent` + +None generic Unity Event of type `Collision`. Inherits from `UnityEvent`. + +--- + +## `ColorPairUnityEvent` + +None generic Unity Event of type `ColorPair`. Inherits from `UnityEvent`. + +--- + +## `ColorUnityEvent` + +None generic Unity Event of type `Color`. Inherits from `UnityEvent`. + +--- + +## `DoublePairUnityEvent` + +None generic Unity Event of type `DoublePair`. Inherits from `UnityEvent`. + +--- + +## `DoubleUnityEvent` + +None generic Unity Event of type `double`. Inherits from `UnityEvent`. + +--- + +## `FloatPairUnityEvent` + +None generic Unity Event of type `FloatPair`. Inherits from `UnityEvent`. + +--- + +## `FloatUnityEvent` + +None generic Unity Event of type `float`. Inherits from `UnityEvent`. + +--- + +## `GameObjectPairUnityEvent` + +None generic Unity Event of type `GameObjectPair`. Inherits from `UnityEvent`. + +--- + +## `GameObjectUnityEvent` + +None generic Unity Event of type `GameObject`. Inherits from `UnityEvent`. + +--- + +## `IntPairUnityEvent` + +None generic Unity Event of type `IntPair`. Inherits from `UnityEvent`. + +--- + +## `IntUnityEvent` + +None generic Unity Event of type `int`. Inherits from `UnityEvent`. + +--- + +## `QuaternionPairUnityEvent` + +None generic Unity Event of type `QuaternionPair`. Inherits from `UnityEvent`. + +--- + +## `QuaternionUnityEvent` + +None generic Unity Event of type `Quaternion`. Inherits from `UnityEvent`. + +--- + +## `StringPairUnityEvent` + +None generic Unity Event of type `StringPair`. Inherits from `UnityEvent`. + +--- + +## `StringUnityEvent` + +None generic Unity Event of type `string`. Inherits from `UnityEvent`. + +--- + +## `Vector2PairUnityEvent` + +None generic Unity Event of type `Vector2Pair`. Inherits from `UnityEvent`. + +--- + +## `Vector2UnityEvent` + +None generic Unity Event of type `Vector2`. Inherits from `UnityEvent`. + +--- + +## `Vector3PairUnityEvent` + +None generic Unity Event of type `Vector3Pair`. Inherits from `UnityEvent`. + +--- + +## `Vector3UnityEvent` + +None generic Unity Event of type `Vector3`. Inherits from `UnityEvent`. + +--- + +## `VoidUnityEvent` + +None generic Unity Event of type `Void`. Inherits from `UnityEvent`. --- @@ -2634,21 +2308,9 @@ Value List of type `bool`. Inherits from `AtomValueList`. --- -## `ColorValueList` +## `Collider2DValueList` -Value List of type `Color`. Inherits from `AtomValueList`. - ---- - -## `CollisionValueList` - -Value List of type `Collision`. Inherits from `AtomValueList`. - ---- - -## `QuaternionValueList` - -Value List of type `Quaternion`. Inherits from `AtomValueList`. +Value List of type `Collider2D`. Inherits from `AtomValueList`. --- @@ -2658,27 +2320,21 @@ Value List of type `Collider`. Inherits from `AtomValueList`. +Value List of type `Collision2D`. Inherits from `AtomValueList`. --- -## `GameObjectValueList` +## `CollisionValueList` -Value List of type `GameObject`. Inherits from `AtomValueList`. +Value List of type `Collision`. Inherits from `AtomValueList`. --- -## `Collider2DValueList` +## `ColorValueList` -Value List of type `Collider2D`. Inherits from `AtomValueList`. - ---- - -## `Vector3ValueList` - -Value List of type `Vector3`. Inherits from `AtomValueList`. +Value List of type `Color`. Inherits from `AtomValueList`. --- @@ -2688,128 +2344,472 @@ Value List of type `double`. Inherits from `AtomValueList`. --- +## `FloatValueList` + +Value List of type `float`. Inherits from `AtomValueList`. + +--- + +## `GameObjectValueList` + +Value List of type `GameObject`. Inherits from `AtomValueList`. + +--- + +## `IntValueList` + +Value List of type `int`. Inherits from `AtomValueList`. + +--- + +## `QuaternionValueList` + +Value List of type `Quaternion`. Inherits from `AtomValueList`. + +--- + ## `StringValueList` Value List of type `string`. Inherits from `AtomValueList`. --- -## `SetVector2VariableValue` +## `Vector2ValueList` -Set variable value Action of type `Vector2`. Inherits from `SetVariableValue`. +Value List of type `Vector2`. Inherits from `AtomValueList`. --- -## `SetColorVariableValue` +## `Vector3ValueList` -Set variable value Action of type `Color`. Inherits from `SetVariableValue`. +Value List of type `Vector3`. Inherits from `AtomValueList`. --- -## `SetQuaternionVariableValue` +## `BoolVariableInstancer` -Set variable value Action of type `Quaternion`. Inherits from `SetVariableValue`. +Variable Instancer of type `bool`. Inherits from `AtomVariableInstancer`. --- -## `SetCollider2DVariableValue` +## `Collider2DVariableInstancer` -Set variable value Action of type `Collider2D`. Inherits from `SetVariableValue`. +Variable Instancer of type `Collider2D`. Inherits from `AtomVariableInstancer`. --- -## `SetBoolVariableValue` +## `ColliderVariableInstancer` -Set variable value Action of type `bool`. Inherits from `SetVariableValue`. +Variable Instancer of type `Collider`. Inherits from `AtomVariableInstancer`. --- -## `SetDoubleVariableValue` +## `Collision2DVariableInstancer` -Set variable value Action of type `double`. Inherits from `SetVariableValue`. +Variable Instancer of type `Collision2D`. Inherits from `AtomVariableInstancer`. --- -## `SetFloatVariableValue` +## `CollisionVariableInstancer` -Set variable value Action of type `float`. Inherits from `SetVariableValue`. +Variable Instancer of type `Collision`. Inherits from `AtomVariableInstancer`. --- -## `SetVector3VariableValue` +## `ColorVariableInstancer` -Set variable value Action of type `Vector3`. Inherits from `SetVariableValue`. +Variable Instancer of type `Color`. Inherits from `AtomVariableInstancer`. --- -## `SetCollisionVariableValue` +## `DoubleVariableInstancer` -Set variable value Action of type `Collision`. Inherits from `SetVariableValue`. +Variable Instancer of type `double`. Inherits from `AtomVariableInstancer`. --- -## `SetGameObjectVariableValue` +## `FloatVariableInstancer` -Set variable value Action of type `GameObject`. Inherits from `SetVariableValue`. +Variable Instancer of type `float`. Inherits from `AtomVariableInstancer`. --- -## `SetStringVariableValue` +## `GameObjectVariableInstancer` -Set variable value Action of type `string`. Inherits from `SetVariableValue`. +Variable Instancer of type `GameObject`. Inherits from `AtomVariableInstancer`. --- -## `SetCollision2DVariableValue` +## `IntVariableInstancer` -Set variable value Action of type `Collision2D`. Inherits from `SetVariableValue`. +Variable Instancer of type `int`. Inherits from `AtomVariableInstancer`. --- -## `SetIntVariableValue` +## `QuaternionVariableInstancer` -Set variable value Action of type `int`. Inherits from `SetVariableValue`. +Variable Instancer of type `Quaternion`. Inherits from `AtomVariableInstancer`. --- -## `SetColliderVariableValue` +## `StringVariableInstancer` -Set variable value Action of type `Collider`. Inherits from `SetVariableValue`. +Variable Instancer of type `string`. Inherits from `AtomVariableInstancer`. --- -## `ClampInt` +## `Vector2VariableInstancer` -An `AtomFunction` that clamps the value using a min and a max value and returns it. - -### Variables - -#### `Min` - -The minimum value. +Variable Instancer of type `Vector2`. Inherits from `AtomVariableInstancer`. --- -#### `Max` +## `Vector3VariableInstancer` -The maximum value. +Variable Instancer of type `Vector3`. Inherits from `AtomVariableInstancer`. --- -## `ClampFloat` +## `BoolVariable` -An `AtomFunction` that clamps the value using a min and a max value and returns it. - -### Variables - -#### `Min` - -The minimum value. +Variable of type `bool`. Inherits from `EquatableAtomVariable`. --- -#### `Max` +## `Collider2DVariable` -The maximum value. +Variable of type `Collider2D`. Inherits from `AtomVariable`. + +--- + +## `ColliderVariable` + +Variable of type `Collider`. Inherits from `AtomVariable`. + +--- + +## `Collision2DVariable` + +Variable of type `Collision2D`. Inherits from `AtomVariable`. + +--- + +## `CollisionVariable` + +Variable of type `Collision`. Inherits from `AtomVariable`. + +--- + +## `ColorVariable` + +Variable of type `Color`. Inherits from `EquatableAtomVariable`. + +### Methods + +#### `SetAlpha(System.Single)` + +Set Alpha of Color by value. + +##### Parameters + +- `value` - New alpha value. + +--- + +#### `SetAlpha(UnityAtoms.AtomBaseVariable{System.Single})` + +Set Alpha of Color by Variable value. + +##### Parameters + +- `variable` - New alpha Variable value. + +--- + +## `DoubleVariable` + +Variable of type `double`. Inherits from `EquatableAtomVariable`. + +--- + +## `FloatVariable` + +Variable of type `float`. Inherits from `EquatableAtomVariable`. + +### Methods + +#### `Add(System.Single)` + +Add value to Variable. + +##### Parameters + +- `value` - Value to add. + +--- + +#### `Add(UnityAtoms.AtomBaseVariable{System.Single})` + +Add variable value to Variable. + +##### Parameters + +- `variable` - Variable with value to add. + +--- + +#### `Subtract(System.Single)` + +Subtract value from Variable. + +##### Parameters + +- `value` - Value to subtract. + +--- + +#### `Subtract(UnityAtoms.AtomBaseVariable{System.Single})` + +Subtract variable value from Variable. + +##### Parameters + +- `variable` - Variable with value to subtract. + +--- + +#### `MultiplyBy(System.Single)` + +Multiply variable by value. + +##### Parameters + +- `value` - Value to multiple by. + +--- + +#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Single})` + +Multiply variable by Variable value. + +##### Parameters + +- `variable` - Variable with value to multiple by. + +--- + +#### `DivideBy(System.Single)` + +Divide Variable by value. + +##### Parameters + +- `value` - Value to divide by. + +--- + +#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Single})` + +Divide Variable by Variable value. + +##### Parameters + +- `variable` - Variable value to divide by. + +--- + +## `GameObjectVariable` + +Variable of type `GameObject`. Inherits from `AtomVariable`. + +--- + +## `IntVariable` + +Variable of type `int`. Inherits from `EquatableAtomVariable`. + +### Methods + +#### `Add(System.Int32)` + +Add value to Variable. + +##### Parameters + +- `value` - Value to add. + +--- + +#### `Add(UnityAtoms.AtomBaseVariable{System.Int32})` + +Add variable value to Variable. + +##### Parameters + +- `variable` - Variable with value to add. + +--- + +#### `Subtract(System.Int32)` + +Subtract value from Variable. + +##### Parameters + +- `value` - Value to subtract. + +--- + +#### `Subtract(UnityAtoms.AtomBaseVariable{System.Int32})` + +Subtract variable value from Variable. + +##### Parameters + +- `variable` - Variable with value to subtract. + +--- + +#### `MultiplyBy(System.Int32)` + +Multiply variable by value. + +##### Parameters + +- `value` - Value to multiple by. + +--- + +#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Int32})` + +Multiply variable by Variable value. + +##### Parameters + +- `variable` - Variable with value to multiple by. + +--- + +#### `DivideBy(System.Int32)` + +Divide Variable by value. + +##### Parameters + +- `value` - Value to divide by. + +--- + +#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Int32})` + +Divide Variable by Variable value. + +##### Parameters + +- `variable` - Variable value to divide by. + +--- + +## `QuaternionVariable` + +Variable of type `Quaternion`. Inherits from `EquatableAtomVariable`. + +--- + +## `StringVariable` + +Variable of type `string`. Inherits from `EquatableAtomVariable`. + +--- + +## `Vector2Variable` + +Variable of type `Vector2`. Inherits from `EquatableAtomVariable`. + +### Methods + +#### `MultiplyBy(System.Single)` + +Multiply variable by value. + +##### Parameters + +- `value` - Value to multiple by. + +--- + +#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Single})` + +Multiply variable by Variable value. + +##### Parameters + +- `variable` - Variable with value to multiple by. + +--- + +#### `DivideBy(System.Single)` + +Divide Variable by value. + +##### Parameters + +- `value` - Value to divide by. + +--- + +#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Single})` + +Divide Variable by Variable value. + +##### Parameters + +- `variable` - Variable value to divide by. + +--- + +## `Vector3Variable` + +Variable of type `Vector3`. Inherits from `EquatableAtomVariable`. + +### Methods + +#### `MultiplyBy(System.Single)` + +Multiply variable by value. + +##### Parameters + +- `value` - Value to multiple by. + +--- + +#### `MultiplyBy(UnityAtoms.AtomBaseVariable{System.Single})` + +Multiply variable by Variable value. + +##### Parameters + +- `variable` - Variable with value to multiple by. + +--- + +#### `DivideBy(System.Single)` + +Divide Variable by value. + +##### Parameters + +- `value` - Value to divide by. + +--- + +#### `DivideBy(UnityAtoms.AtomBaseVariable{System.Single})` + +Divide Variable by Variable value. + +##### Parameters + +- `variable` - Variable value to divide by. --- diff --git a/docs/api/unityatoms.editor.md b/docs/api/unityatoms.editor.md index 947adaf8..5377eca4 100644 --- a/docs/api/unityatoms.editor.md +++ b/docs/api/unityatoms.editor.md @@ -7,70 +7,151 @@ sidebar_label: UnityAtoms.Editor # Namespace - `UnityAtoms.Editor` -## `EditorIconPostProcessor` +## `AtomBaseReferenceDrawer` -Postprocessor that processes all scripts using the EditorIcon attribute and assigns the matching icon guid (matching the icon query name) to the script's meta. It's a very simple solution (and very hacky), but works really great. - -### Methods - -#### `OnPostprocessAllAssets(System.String[],System.String[],System.String[],System.String[])` - -Called when new assets are imported, deleted or moved. - -##### Parameters - -- `importedAssets` - Imported assets. -- `deletedAssets` - Deleted assets. -- `movedAssets` - Moved assets. -- `movedFromAssetPaths` - Moved from asset paths. +A custom property drawer for References (Events and regular). Makes it possible to reference a resources (Variable or Event) through multiple options. --- -## `RegenereateAllAtoms` +## `AtomDrawer` -Internal utility class to regenerate all Atoms. Reachable via top menu bar and `Tools/Unity Atoms/Regenerate All Atoms`. +#### Type Parameters -### Methods +- `T` - The type of Atom the property drawer should apply to. -#### `Regenereate` - -Create the editor window. +The base Unity Atoms property drawer. Makes it possible to create and add a new Atom via Unity's inspector. Only availble in `UNITY_2018_3_OR_NEWER`. --- -## `Templating` +## `AtomEventReferenceDrawer` -Internal class used for templating when generating new Atoms using the `Generator`. +A custom property drawer for Event References. Makes it possible to choose between an Event, Event Instancer, Variable or a Variable Instancer. + +--- + +## `AtomListAttributeDrawer` + +A custom property drawer for properties using the `AtomList` attribute. + +--- + +## `AtomReferenceDrawer` + +A custom property drawer for References. Makes it possible to choose between a Value, Variable, Constant or a Variable Instancer. + +--- + +## `ReadOnlyDrawer` + +Make property read only by using the abbtribute `[ReadOnly]`. Solution taken from: https://answers.unity.com/questions/489942/how-to-make-a-readonly-property-in-inspector.html + +--- + +## `AtomEventInstancerEditor` + +#### Type Parameters + +- `T` - The type of this event.. +- `E` - Event of type T. + +Custom editor for Events. Adds the possiblity to raise an Event from Unity's Inspector. + +--- + +## `AtomEventEditor` + +#### Type Parameters + +- `T` - The type of this event.. +- `E` - Event of type T. + +Custom editor for Events. Adds the possiblity to raise an Event from Unity's Inspector. + +--- + +## `AtomVariableEditor`2` + +Custom editor for Variables. Provides a better user workflow and indicates when which variables can be edited + +--- + +## `AtomReceipe` + +Internal module class that holds that regarding an Atom type. + +--- + +## `AtomType` + +Internal module class that holds that regarding an Atom type. + +--- + +## `AtomTypes` + +Internal static class holding predefined static `AtomType`s. + +### Variables + +#### `ALL_ATOM_TYPES` + +Containes all common atom types that are usually generated for a type. + +--- + +#### `DEPENDENCY_GRAPH` + +Graph explaining all the dependencies between Atoms. + +--- + +## `Generator` + +Generator that generates new Atom types based on the input data. Used by the `GeneratorEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. ### Methods -#### `ResolveConditionals(System.String,System.Collections.Generic.List{System.String})` +#### `Generate(UnityAtoms.Editor.AtomReceipe,System.String,System.String[],System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,System.String})` -Resolve conditionals from the provided tempalte. +Generate new Atoms based on the input data. ##### Parameters -- `template` - Template to resolve the conditionals from. -- `trueConditions` - A list of conditionals that are `true`. +- `valueType` - The type of Atom to generate.abstract Eg. double, byte, MyStruct, MyClass. +- `baseWritePath` - Base write path (relative to the Asset folder) where the Atoms are going to be written to. +- `isEquatable` - Is the `type` provided implementing `IEquatable`? +- `atomTypesToGenerate` - A list of `AtomType`s to be generated. +- `typeNamespace` - If the `type` provided is defined under a namespace, provide that namespace here. +- `subUnityAtomsNamespace` - By default the Atoms that gets generated will be under the namespace `UnityAtoms`. If you for example like it to be under `UnityAtoms.MyNamespace` you would then enter `MyNamespace` in this field. + +##### Examples + +```cs +namespace MyNamespace +{ + public struct MyStruct + { + public string Text; + public int Number; + } +} +var generator = new Generator(); +generator.Generate("MyStruct", "", false, new List() { AtomTypes.ACTION }, "MyNamespace", ""); // Generates an Atom Action of type MyStruct +``` + +--- + +#### `RemoveDuplicateNamespaces(System.String)` + +Removes duplicate namespaces, given content from a template. + +##### Parameters + +- `template` - The content template to remove namespace from. ##### Returns -A new template string resolved and based on the provided `template`. - ---- - -#### `ResolveVariables(System.Collections.Generic.Dictionary{System.String,System.String},System.String)` - -Resolve variables in the provided string. - -##### Parameters - -- `templateVariables` - Dictionay mapping template variables and their resolutions. -- `toResolve` - The string to resolve. - -##### Returns - -A new template string resolved and based on the provided `toResolve` string. +A copy of `content`, but without duplicate namespaces. --- @@ -147,150 +228,69 @@ A new toggle row (`VisualElement`). --- -## `AtomReceipe` +## `RegenereateAllAtoms` -Internal module class that holds that regarding an Atom type. - ---- - -## `AtomType` - -Internal module class that holds that regarding an Atom type. - ---- - -## `Generator` - -Generator that generates new Atom types based on the input data. Used by the `GeneratorEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Internal utility class to regenerate all Atoms. Reachable via top menu bar and `Tools/Unity Atoms/Regenerate All Atoms`. ### Methods -#### `Generate(UnityAtoms.Editor.AtomReceipe,System.String,System.String[],System.Collections.Generic.List{System.String},System.Collections.Generic.Dictionary{System.String,System.String})` +#### `Regenereate` -Generate new Atoms based on the input data. - -##### Parameters - -- `valueType` - The type of Atom to generate.abstract Eg. double, byte, MyStruct, MyClass. -- `baseWritePath` - Base write path (relative to the Asset folder) where the Atoms are going to be written to. -- `isEquatable` - Is the `type` provided implementing `IEquatable`? -- `atomTypesToGenerate` - A list of `AtomType`s to be generated. -- `typeNamespace` - If the `type` provided is defined under a namespace, provide that namespace here. -- `subUnityAtomsNamespace` - By default the Atoms that gets generated will be under the namespace `UnityAtoms`. If you for example like it to be under `UnityAtoms.MyNamespace` you would then enter `MyNamespace` in this field. - -##### Examples - -```cs -namespace MyNamespace -{ - public struct MyStruct - { - public string Text; - public int Number; - } -} -var generator = new Generator(); -generator.Generate("MyStruct", "", false, new List() { AtomTypes.ACTION }, "MyNamespace", ""); // Generates an Atom Action of type MyStruct -``` +Create the editor window. --- -#### `RemoveDuplicateNamespaces(System.String)` +## `Templating` -Removes duplicate namespaces, given content from a template. +Internal class used for templating when generating new Atoms using the `Generator`. + +### Methods + +#### `ResolveConditionals(System.String,System.Collections.Generic.List{System.String})` + +Resolve conditionals from the provided tempalte. ##### Parameters -- `template` - The content template to remove namespace from. +- `template` - Template to resolve the conditionals from. +- `trueConditions` - A list of conditionals that are `true`. ##### Returns -A copy of `content`, but without duplicate namespaces. +A new template string resolved and based on the provided `template`. --- -## `AtomTypes` +#### `ResolveVariables(System.Collections.Generic.Dictionary{System.String,System.String},System.String)` -Internal static class holding predefined static `AtomType`s. +Resolve variables in the provided string. -### Variables +##### Parameters -#### `ALL_ATOM_TYPES` +- `templateVariables` - Dictionay mapping template variables and their resolutions. +- `toResolve` - The string to resolve. -Containes all common atom types that are usually generated for a type. +##### Returns + +A new template string resolved and based on the provided `toResolve` string. --- -#### `DEPENDENCY_GRAPH` +## `EditorIconPostProcessor` -Graph explaining all the dependencies between Atoms. - ---- - -## `AtomEventReferenceDrawer` - -A custom property drawer for Event References. Makes it possible to choose between an Event, Event Instancer, Variable or a Variable Instancer. - ---- - -## `AtomDrawer` - -#### Type Parameters - -- `T` - The type of Atom the property drawer should apply to. - -The base Unity Atoms property drawer. Makes it possible to create and add a new Atom via Unity's inspector. Only availble in `UNITY_2018_3_OR_NEWER`. - ---- - -## `AtomReferenceDrawer` - -A custom property drawer for References. Makes it possible to choose between a Value, Variable, Constant or a Variable Instancer. - ---- - -## `AtomBaseReferenceDrawer` - -A custom property drawer for References (Events and regular). Makes it possible to reference a resources (Variable or Event) through multiple options. - ---- - -## `ReadOnlyDrawer` - -Make property read only by using the abbtribute `[ReadOnly]`. Solution taken from: https://answers.unity.com/questions/489942/how-to-make-a-readonly-property-in-inspector.html - ---- - -## `AtomListAttributeDrawer` - -A custom property drawer for properties using the `AtomList` attribute. - ---- - -## `AtomEventInstancerEditor` - -#### Type Parameters - -- `T` - The type of this event.. -- `E` - Event of type T. - -Custom editor for Events. Adds the possiblity to raise an Event from Unity's Inspector. - ---- - -## `AtomVariableEditor`2` - -Custom editor for Variables. Provides a better user workflow and indicates when which variables can be edited - ---- - -## `AtomEventEditor` - -#### Type Parameters - -- `T` - The type of this event.. -- `E` - Event of type T. - -Custom editor for Events. Adds the possiblity to raise an Event from Unity's Inspector. +Postprocessor that processes all scripts using the EditorIcon attribute and assigns the matching icon guid (matching the icon query name) to the script's meta. It's a very simple solution (and very hacky), but works really great. + +### Methods + +#### `OnPostprocessAllAssets(System.String[],System.String[],System.String[],System.String[])` + +Called when new assets are imported, deleted or moved. + +##### Parameters + +- `importedAssets` - Imported assets. +- `deletedAssets` - Deleted assets. +- `movedAssets` - Moved assets. +- `movedFromAssetPaths` - Moved from asset paths. --- diff --git a/docs/api/unityatoms.fsm.editor.md b/docs/api/unityatoms.fsm.editor.md index 238f098f..18df9a8a 100644 --- a/docs/api/unityatoms.fsm.editor.md +++ b/docs/api/unityatoms.fsm.editor.md @@ -7,15 +7,9 @@ sidebar_label: UnityAtoms.FSM.Editor # Namespace - `UnityAtoms.FSM.Editor` -## `FiniteStateMachineInstancerEditor` +## `FiniteStateMachineReferenceDrawer` -Custom property drawer for type `FiniteStateMachineInstancer`. - ---- - -## `FiniteStateMachineEditor` - -Custom property drawer for type `FiniteStateMachine`. +A custom property drawer for FiniteStateMachineReference. Makes it possible to choose between a FSM or a FSM Instancer. --- @@ -25,9 +19,21 @@ A custom property drawer for References. Makes it possible to choose between a v --- -## `FiniteStateMachineReferenceDrawer` +## `FSMTransitionDataEventDrawer` -A custom property drawer for FiniteStateMachineReference. Makes it possible to choose between a FSM or a FSM Instancer. +Event property drawer of type `FSMTransitionData`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `FiniteStateMachineEditor` + +Custom property drawer for type `FiniteStateMachine`. + +--- + +## `FiniteStateMachineInstancerEditor` + +Custom property drawer for type `FiniteStateMachineInstancer`. --- @@ -36,9 +42,3 @@ A custom property drawer for FiniteStateMachineReference. Makes it possible to c Event property drawer of type `FSMTransitionData`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. --- - -## `FSMTransitionDataEventDrawer` - -Event property drawer of type `FSMTransitionData`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- diff --git a/docs/api/unityatoms.fsm.md b/docs/api/unityatoms.fsm.md index 3b8ff321..0df23e50 100644 --- a/docs/api/unityatoms.fsm.md +++ b/docs/api/unityatoms.fsm.md @@ -7,27 +7,15 @@ sidebar_label: UnityAtoms.FSM # Namespace - `UnityAtoms.FSM` -## `TransitionListWrapper` +## `FSMTransitionDataAction` -Needed in order to use our custom property drawer for transitions in the FSM. +Action of type `FSMTransitionData`. Inherits from `AtomAction`. --- -## `Transition` +## `FSMTransitionDataBaseEventReferenceListener` -Controls a transition from a FromState to a ToState. - ---- - -## `FSMTransitionData` - -A struct representing a transition in a FSM. - ---- - -## `FSMTransitionDataUnityEvent` - -None generic Unity Event of type `FSMTransitionData`. Inherits from `UnityEvent`. +Event Reference Listener of type `FSMTransitionData`. Inherits from `AtomEventReferenceListener`. --- @@ -67,39 +55,9 @@ Event Instancer of type `FSMTransitionData`. Inherits from `AtomEventInstancer`. - ---- - -## `FiniteStateMachineReferenceUsage` - -Different usages of the FSM reference. - ---- - -## `FiniteStateMachineReference` - -Reference of type `FiniteStateMachine`. Inherits from `AtomBaseReference`. - -### Variables - -#### `_fsm` - -Variable used if `Usage` is set to `FSM`. - ---- - -#### `_fsmInstancer` - -Variable Instancer used if `Usage` is set to `FSM_INSTANCER`. - -### Properties - -#### `Machine` - -Get the value for the Reference. +Event of type `FSMTransitionData`. Inherits from `AtomEvent`. --- @@ -187,12 +145,6 @@ Dispatches a new command to the FiniteStateMachine, invoking any necessary trans --- -## `FiniteStateMachineMonoHook` - -Needed By FiniteStateMachine in order to gain access to some of the Unity life cycle methods. - ---- - ## `FiniteStateMachineInstancer` Takes a base FSM and creates an in memory copy of it on OnEnable. Removes the FSM on OnDestroy. @@ -205,9 +157,39 @@ The variable that the in memory copy will be based on when created at runtime. --- -## `FSMStateListWrapper` +## `FiniteStateMachineMonoHook` -Needed in order to use our custom property drawer for states in the FSM. +Needed By FiniteStateMachine in order to gain access to some of the Unity life cycle methods. + +--- + +## `FiniteStateMachineReferenceUsage` + +Different usages of the FSM reference. + +--- + +## `FiniteStateMachineReference` + +Reference of type `FiniteStateMachine`. Inherits from `AtomBaseReference`. + +### Variables + +#### `_fsm` + +Variable used if `Usage` is set to `FSM`. + +--- + +#### `_fsmInstancer` + +Variable Instancer used if `Usage` is set to `FSM_INSTANCER`. + +### Properties + +#### `Machine` + +Get the value for the Reference. --- @@ -217,14 +199,32 @@ Class representing a state in the FSM. --- -## `FSMTransitionDataEvent` +## `FSMStateListWrapper` -Event of type `FSMTransitionData`. Inherits from `AtomEvent`. +Needed in order to use our custom property drawer for states in the FSM. --- -## `FSMTransitionDataBaseEventReferenceListener` +## `FSMTransitionData` -Event Reference Listener of type `FSMTransitionData`. Inherits from `AtomEventReferenceListener`. +A struct representing a transition in a FSM. + +--- + +## `Transition` + +Controls a transition from a FromState to a ToState. + +--- + +## `TransitionListWrapper` + +Needed in order to use our custom property drawer for transitions in the FSM. + +--- + +## `FSMTransitionDataUnityEvent` + +None generic Unity Event of type `FSMTransitionData`. Inherits from `UnityEvent`. --- diff --git a/docs/api/unityatoms.inputsystem.editor.md b/docs/api/unityatoms.inputsystem.editor.md index 1e39b683..1254f8d1 100644 --- a/docs/api/unityatoms.inputsystem.editor.md +++ b/docs/api/unityatoms.inputsystem.editor.md @@ -7,18 +7,6 @@ sidebar_label: UnityAtoms.InputSystem.Editor # Namespace - `UnityAtoms.InputSystem.Editor` -## `PlayerInputEventEditor` - -Event property drawer of type `PlayerInput`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `InputAction_CallbackContextEventEditor` - -Event property drawer of type `InputAction.CallbackContext`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - ## `InputAction_CallbackContextEventDrawer` Event property drawer of type `InputAction.CallbackContext`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. @@ -30,3 +18,15 @@ Event property drawer of type `InputAction.CallbackContext`. Inherits from `Atom Event property drawer of type `PlayerInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- + +## `InputAction_CallbackContextEventEditor` + +Event property drawer of type `InputAction.CallbackContext`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `PlayerInputEventEditor` + +Event property drawer of type `PlayerInput`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- diff --git a/docs/api/unityatoms.inputsystem.md b/docs/api/unityatoms.inputsystem.md index 1bee55c4..53632fa2 100644 --- a/docs/api/unityatoms.inputsystem.md +++ b/docs/api/unityatoms.inputsystem.md @@ -7,15 +7,15 @@ sidebar_label: UnityAtoms.InputSystem # Namespace - `UnityAtoms.InputSystem` -## `InputAction_CallbackContextUnityEvent` +## `InputAction_CallbackContextAction` -None generic Unity Event of type `InputAction.CallbackContext`. Inherits from `UnityEvent`. +Action of type `InputAction.CallbackContext`. Inherits from `AtomAction`. --- -## `PlayerInputUnityEvent` +## `PlayerInputAction` -None generic Unity Event of type `PlayerInput`. Inherits from `UnityEvent`. +Action of type `PlayerInput`. Inherits from `AtomAction`. --- @@ -31,18 +31,6 @@ Event Instancer of type `PlayerInput`. Inherits from `AtomEventInstancer`. - ---- - -## `PlayerInputAction` - -Action of type `PlayerInput`. Inherits from `AtomAction`. - ---- - ## `InputAction_CallbackContextEvent` Event of type `InputAction.CallbackContext`. Inherits from `AtomEvent`. @@ -54,3 +42,15 @@ Event of type `InputAction.CallbackContext`. Inherits from `AtomEvent`. --- + +## `InputAction_CallbackContextUnityEvent` + +None generic Unity Event of type `InputAction.CallbackContext`. Inherits from `UnityEvent`. + +--- + +## `PlayerInputUnityEvent` + +None generic Unity Event of type `PlayerInput`. Inherits from `UnityEvent`. + +--- diff --git a/docs/api/unityatoms.md b/docs/api/unityatoms.md index 2d8f7e53..b7666f56 100644 --- a/docs/api/unityatoms.md +++ b/docs/api/unityatoms.md @@ -7,95 +7,294 @@ sidebar_label: UnityAtoms # Namespace - `UnityAtoms` -## `Void` +## `StringExtensions` -Dummy module class used for representing nothing in for example empty Events, eg: `AtomEvent` +Internal extension class for strings. + +### Methods + +#### `ToInt(System.String,System.Int32)` + +Tries to parse a string to an int. + +##### Parameters + +- `str` - The string to parse. +- `def` - The default value if not able to parse the provided string. + +##### Returns + +Returns the string parsed to an int. If not able to parse the string, it returns the default value provided to the method. --- -## `EquatableAtomReference` +#### `Repeat(System.String,System.Int32)` + +Repeats the string X amount of times. + +##### Parameters + +- `str` - The string to repeat. +- `times` - The number of times to repeat the provided string. + +##### Returns + +The string repeated X amount of times. + +--- + +#### `Capitalize(System.String)` + +Capitalize the provided string. + +##### Parameters + +- `str` - The string to capitalize. + +##### Returns + +A capitalized version of the string provided. + +--- + +## `IMGUIUtils` + +Utility methods for IMGUI. + +### Methods + +#### `SnipRectH(UnityEngine.Rect,System.Single)` + +Snip a `Rect` horizontally. + +##### Parameters + +- `rect` - The rect. +- `range` - The range. + +##### Returns + +A new `Rect` snipped horizontally. + +--- + +#### `SnipRectH(UnityEngine.Rect,System.Single,UnityEngine.Rect@,System.Single)` + +Snip a `Rect` horizontally. + +##### Parameters + +- `rect` - The rect. +- `range` - The range. +- `rest` - Rest rect. +- `gutter` - Gutter + +##### Returns + +A new `Rect` snipped horizontally. + +--- + +#### `SnipRectV(UnityEngine.Rect,System.Single)` + +Snip a `Rect` vertically. + +##### Parameters + +- `rect` - The rect. +- `range` - The range. + +##### Returns + +A new `Rect` snipped vertically. + +--- + +#### `SnipRectV(UnityEngine.Rect,System.Single,UnityEngine.Rect@,System.Single)` + +Snip a `Rect` vertically. + +##### Parameters + +- `rect` - The rect. +- `range` - The range. +- `rest` - Rest rect. +- `gutter` - Gutter + +##### Returns + +A new `Rect` snipped vertically. + +--- + +## `AtomAction` + +Base abstract class for Actions. Inherits from `BaseAtom`. + +### Methods + +#### `Do` + +Perform the Action. + +--- + +## `AtomAction` #### Type Parameters -- `T` - The type of the variable. -- `P` - IPair of type `T`. -- `C` - Constant of type `T`. -- `V` - Variable of type `T`. -- `E1` - Event of type `T`. -- `E2` - Event of type `IPair`. -- `F` - Function of type `T => T`. -- `VI` - Variable Instancer of type `T`. +- `T1` - The type for this Action. -Atom Reference that where the value is implementing `IEquatable`. +Generic abstract base class for Actions. Inherits from `AtomAction`. + +### Methods + +#### `Do(t1)` + +Perform the Action. + +##### Parameters + +- `t1` - The first parameter. --- -## `AtomReferenceUsage` - -Different Reference usages. - ---- - -## `AtomBaseReference` - -None generic base class for `AtomReference`. - -### Variables - -#### `_usage` - -Describes how we use the Reference and where the value comes from. - ---- - -## `AtomReference` +## `SetVariableValue` #### Type Parameters -- `T` - The type of the variable. -- `P` - IPair of type `T`. -- `C` - Constant of type `T`. -- `V` - Variable of type `T`. -- `E1` - Event of type `T`. -- `E2` - Event of type `IPair`. -- `F` - Function of type `T => T`. -- `VI` - Variable Instancer of type `T`. +- `T` - The type of the Variable to set. +- `P` - A IPair of type T. +- `V` - A Variable class of type `T` to set. +- `C` - A Constant class of type `T`. +- `R` - A Reference of type `T`. +- `E1` - An Event of type `T`. +- `E2` - An Event x 2 of type `T`. +- `F` - A Function x 2 of type `T`. +- `VI` - A Variable Instancer of type `T`. -A Reference lets you define a variable in your script where you then from the inspector can choose if it's going to be taking the value from a Constant, Variable, Value or a Variable Instancer. +Base class for all SetVariableValue Actions. Inherits from `AtomAction`. ### Variables -#### `_value` - -Value used if `Usage` is set to `Value`. - ---- - -#### `_constant` - -Constant used if `Usage` is set to `Constant`. - ---- - #### `_variable` -Variable used if `Usage` is set to `Variable`. +The Variable to set. --- -#### `_variableInstancer` +#### `_value` -Variable Instancer used if `Usage` is set to `VariableInstancer`. +The value to use. + +### Methods + +#### `Do` + +Perform the action. + +--- + +## `AtomListWrapper` + +#### Type Parameters + +- `T` - Type used in list. + +Needed in order to create a property drawer for a List / Array. See this for more info: https://answers.unity.com/questions/605875/custompropertydrawer-for-array-types-in-43.html + +--- + +## `AtomsSearchable` + +Attribute that makes an Atom searchable. + +--- + +## `EditorIcon` + +Specify a texture name from your assets which you want to be assigned as an icon to the MonoScript. + +--- + +## `ReadOnlyAttribute` + +Use to make a field read only in the Unity inspector. Solution taken from here: https://answers.unity.com/questions/489942/how-to-make-a-readonly-property-in-inspector.html + +--- + +## `BaseAtom` + +None generic base class for all Atoms. + +### Variables + +#### `_developerDescription` + +A description of the Atom made for documentation purposes. + +--- + +## `AtomCondition` + +Base abstract class for Conditions. Inherits from `BaseAtom`. + +### Methods + +#### `Call` + +Check the condition. + +--- + +## `AtomCondition`1` + +Generic abstract base class for Conditions. Inherits from `AtomCondition`. + +### Methods + +#### `Call(t1)` + +Evaluate the Condition. + +##### Parameters + +- `t1` - The first parameter. + +--- + +## `AtomConditionOperators` + +Enumeration for logical operators for `AtomCondition` Predicates + +--- + +## `AtomEventInstancer` + +#### Type Parameters + +- `T` - The value type. +- `E` - Event of type T. + +An Event Instancer is a MonoBehaviour that takes an Event as a base and creates an in memory copy of it on OnEnable. This is handy when you want to use Events for prefabs that are instantiated at runtime. + +### Variables + +#### `_base` + +The Event that the in memory copy will be based on when created at runtime. + +--- + +#### `_inspectorRaiseValue` + +Used when raising values from the inspector for debugging purposes. ### Properties -#### `Value` +#### `Event` -Get or set the value for the Reference. - ---- - -#### `IsUnassigned` +Getter for retrieving the in memory runtime Event. ### Methods @@ -127,6 +326,22 @@ Set event by type. --- +#### `Raise` + +Raises the instanced Event. + +--- + +#### `Raise(item)` + +Raises the instanced Event. + +##### Parameters + +- `item` - The value associated with the Event. + +--- + ## `AtomEventReferenceUsage` Different types of Event Reference usages. @@ -235,180 +450,19 @@ Get or set the Event used by the Event Reference. --- -## `AtomListWrapper` +## `AtomEvent` #### Type Parameters -- `T` - Type used in list. +- `T` - The type for this Event. -Needed in order to create a property drawer for a List / Array. See this for more info: https://answers.unity.com/questions/605875/custompropertydrawer-for-array-types-in-43.html - ---- - -## `AtomVariableInstancer` - -#### Type Parameters - -- `V` - Variable of type T. -- `P` - IPair of type `T`. -- `T` - The value type. -- `E1` - Event of type T. -- `E2` - Event x 2 of type T. -- `F` - Function of type T => T - -A Variable Instancer is a MonoBehaviour that takes a variable as a base and creates an in memory copy of it OnEnable. This is handy when you want to use atoms for prefabs that are instantiated at runtime. Use together with AtomCollection to react accordingly when a prefab with an associated atom is added or deleted to the scene. - -### Methods - -#### `ImplSpecificSetup` - -Override to add implementation specific setup on `OnEnable`. - ---- - -#### `GetEvent` - -Get event by type. - -#### Type Parameters - -- `E` - undefined - -##### Returns - -The event. - ---- - -#### `SetEvent(e)` - -Set event by type. - -#### Type Parameters - -- `E` - undefined - -##### Parameters - -- `e` - The new event value. - ---- - -#### `GetOrCreateEvent` - -Get event by type. Creates it if it doesn't exist. - -#### Type Parameters - -- `E` - undefined - -##### Returns - -The event. - ---- - -## `AtomBaseVariableInstancer` - -#### Type Parameters - -- `V` - Variable of type T. -- `P` - IPair of type `T`. -- `T` - The value type. -- `E1` - Event of type T. -- `E2` - Event x 2 of type T. -- `F` - Function of type T => T - -A Variable Instancer is a MonoBehaviour that takes a variable as a base and creates an in memory copy of it OnEnable. This is handy when you want to use atoms for prefabs that are instantiated at runtime. Use together with AtomCollection to react accordingly when a prefab with an assoicated atom is added or deleted to the scene. +Generic base class for Events. Inherits from `AtomEventBase`. ### Variables -#### `_base` +#### `_replayBufferSize` -The variable that the in memory copy will be based on when created at runtime. - -### Properties - -#### `Variable` - -Getter for retrieving the in memory runtime variable. - ---- - -#### `Value` - -Getter for retrieving the value of the in memory runtime variable. - -### Methods - -#### `ImplSpecificSetup` - -Override to add implementation specific setup on `OnEnable`. - ---- - -## `Runtime` - -Internal constant and static readonly members for runtime usage. - -### Properties - -#### `IsUnityAtomsRepo` - -Determine if we are working the Unity Atoms source library / repo or not. - ---- - -## `Runtime.Constants` - -Runtime constants - -### Variables - -#### `LOG_PREFIX` - -Prefix that should be pre-pended to all Debug.Logs made from UnityAtoms to help immediately inform a user that those logs are made from this library. - ---- - -## `Runtime.ExecutionOrder` - -Constants for defining DefaultExecutionOrder. - ---- - -## `EditorIcon` - -Specify a texture name from your assets which you want to be assigned as an icon to the MonoScript. - ---- - -## `ReadOnlyAttribute` - -Use to make a field read only in the Unity inspector. Solution taken from here: https://answers.unity.com/questions/489942/how-to-make-a-readonly-property-in-inspector.html - ---- - -## `AtomsSearchable` - -Attribute that makes an Atom searchable. - ---- - -## `AtomEventInstancer` - -#### Type Parameters - -- `T` - The value type. -- `E` - Event of type T. - -An Event Instancer is a MonoBehaviour that takes an Event as a base and creates an in memory copy of it on OnEnable. This is handy when you want to use Events for prefabs that are instantiated at runtime. - -### Variables - -#### `_base` - -The Event that the in memory copy will be based on when created at runtime. +The event replays the specified number of old values to new subscribers. Works like a ReplaySubject in Rx. --- @@ -418,49 +472,15 @@ Used when raising values from the inspector for debugging purposes. ### Properties -#### `Event` +#### `ReplayBuffer` -Getter for retrieving the in memory runtime Event. +Retrieve Replay Buffer as a List. This call will allocate memory so use sparsely. ### Methods -#### `GetEvent` - -Get event by type. - -#### Type Parameters - -- `E` - undefined - -##### Returns - -The event. - ---- - -#### `SetEvent(e)` - -Set event by type. - -#### Type Parameters - -- `E` - undefined - -##### Parameters - -- `e` - The new event value. - ---- - -#### `Raise` - -Raises the instanced Event. - ---- - #### `Raise(item)` -Raises the instanced Event. +Raise the Event. ##### Parameters @@ -468,301 +488,121 @@ Raises the instanced Event. --- -## `AtomBaseVariable` +#### `RaiseEditor(item)` -None generic base class for Variables. Inherits from `BaseAtom`. +Used in editor scipts since Raise is ambigious when using reflection to get method. -### Properties +##### Parameters -#### `BaseValue` +- `item` - undefined -The Variable value as an `object`.abstract Beware of boxing! πŸ₯Š +--- + +#### `Register(action)` + +Register handler to be called when the Event triggers. + +##### Parameters + +- `action` - The handler. + +--- + +#### `Unregister(action)` + +Unregister handler that was registered using the `Register` method. + +##### Parameters + +- `action` - The handler. + +--- + +#### `UnregisterAll` + +Unregister all handlers that were registered using the `Register` method. + +--- + +#### `RegisterListener(listener)` + +Register a Listener that in turn trigger all its associated handlers when the Event triggers. + +##### Parameters + +- `listener` - The Listener to register. + +--- + +#### `UnregisterListener(listener)` + +Unregister a listener that was registered using the `RegisterListener` method. + +##### Parameters + +- `listener` - The Listener to unregister. + +--- + +#### `Observe` + +Turn the Event into an `IObservable`. Makes Events compatible with for example UniRx. + +##### Returns + +The Event as an `IObservable`. + +--- + +## `AtomEventBase` + +None generic base class for Events. Inherits from `BaseAtom` and `ISerializationCallbackReceiver`. ### Methods -#### `Reset(System.Boolean)` +#### `Register(System.Action)` -Abstract method that could be implemented to reset the Variable value. - ---- - -## `AtomBaseVariable` - -#### Type Parameters - -- `T` - The Variable value type. - -Generic base class for Variables. Inherits from `AtomBaseVariable`. - -### Properties - -#### `BaseValue` - -The Variable value as an `object`.abstract Beware of boxing! πŸ₯Š - ---- - -#### `Value` - -The Variable value as a property. - -### Methods - -#### `Equals(other)` - -Determines equality between Variables. +Register handler to be called when the Event triggers. ##### Parameters -- `other` - The other Variable to compare. - -##### Returns - -`true` if they are equal, otherwise `false`. +- `del` - The handler. --- -#### `Reset(System.Boolean)` +#### `Unregister(System.Action)` -Not implemented.abstract Throws Exception - ---- - -## `AtomVariable` - -#### Type Parameters - -- `T` - The Variable value type. -- `P` - IPair of type `T`. -- `E1` - Event of type `AtomEvent`. -- `E2` - Event of type `AtomEvent`. -- `F` - Function of type `FunctionEvent`. - -Generic base class for Variables. Inherits from `AtomBaseVariable`. - -### Variables - -#### `_changed` - -Changed Event triggered when the Variable value gets changed. - ---- - -#### `_changedWithHistory` - -Changed with history Event triggered when the Variable value gets changed. - ---- - -#### `_triggerChangedOnOnEnable` - -Whether Changed Event should be triggered on OnEnable or not - ---- - -#### `_triggerChangedWithHistoryOnOnEnable` - -Whether ChangedWithHistory Event should be triggered on OnEnable or not - ---- - -#### `_initialValue` - -The inital value of the Variable. - -### Properties - -#### `Value` - -The Variable value as a property. - ---- - -#### `InitialValue` - -The initial value as a property. - ---- - -#### `OldValue` - -The value the Variable had before its value got changed last time. - ---- - -#### `PreChangeTransformers` - -When setting the value of a Variable the new value will be piped through all the pre change transformers, which allows you to create custom logic and restriction on for example what values can be set for this Variable. - -### Methods - -#### `SetInitialValues` - -Set initial values - ---- - -#### `TriggerInitialEvents` - -Trigger initial events if related options enabled - ---- - -#### `Reset(System.Boolean)` - -Reset the Variable to its `_initialValue`. +Unregister handler that was registered using the `Register` method. ##### Parameters -- `shouldTriggerEvents` - Set to `true` if Events should be triggered on reset, otherwise `false`. +- `del` - The handler. --- -#### `SetValue(newValue)` +#### `UnregisterAll` -Set the Variable value. +Unregister all handlers that were registered using the `Register` method. + +--- + +#### `RegisterListener(UnityAtoms.IAtomListener)` + +Register a Listener that in turn trigger all its associated handlers when the Event triggers. ##### Parameters -- `newValue` - The new value to set. - -##### Returns - -`true` if the value got changed, otherwise `false`. +- `listener` - The Listener to register. --- -#### `SetValue(variable)` +#### `UnregisterListener(UnityAtoms.IAtomListener)` -Set the Variable value. +Unregister a listener that was registered using the `RegisterListener` method. ##### Parameters -- `variable` - The value to set provided from another Variable. - -##### Returns - -`true` if the value got changed, otherwise `false`. - ---- - -#### `ObserveChange` - -Turn the Variable's change Event into an `IObservable`. Makes the Variable's change Event compatible with for example UniRx. - -##### Returns - -The Variable's change Event as an `IObservable`. - ---- - -#### `ObserveChangeWithHistory` - -Turn the Variable's change with history Event into an `IObservable`. Makes the Variable's change with history Event compatible with for example UniRx. - -##### Returns - -The Variable's change Event as an `IObservable`. - ---- - -#### `GetEvent` - -Get event by type (allowing inheritance). - -#### Type Parameters - -- `E` - undefined - -##### Returns - -{"_":"Changed - If Changed (or ChangedWithHistory) are of type E\n ChangedWithHistory - If not Changed but ChangedWithHistory is of type E\n \n ","exception":[{"_":"if none of the events are of type E","$":{"cref":"T:System.NotSupportedException"}}]} - ---- - -#### `SetEvent(e)` - -Set event by type. - -#### Type Parameters - -- `E` - undefined - -##### Parameters - -- `e` - The new event value. - ---- - -#### `GetOrCreateEvent` - -Get event by type (allowing inheritance). Creates an event if the type is supported for this Variable, but the Event itself is `null`. - -#### Type Parameters - -- `E` - undefined - -##### Returns - -{"_":"Changed - If Changed (or ChangedWithHistory) are of type E\n ChangedWithHistory - If not Changed but ChangedWithHistory is of type E\n \n ","exception":[{"_":"if none of the events are of type E","$":{"cref":"T:System.NotSupportedException"}}]} - ---- - -## `EquatableAtomVariable` - -#### Type Parameters - -- `T` - The Variable type. -- `P` - Pair of type T. -- `E1` - Event of type T. -- `E2` - Pair event of type T. -- `F` - Function of type T and T. - -Atom Variable base class for types that are implementing `IEquatable`. - ---- - -## `AtomConditionOperators` - -Enumeration for logical operators for `AtomCondition` Predicates - ---- - -## `AtomCondition`1` - -Base abstract class for Conditions. Condition must be an AtomFunction. - ---- - -## `AtomAction` - -Base abstract class for Actions. Inherits from `BaseAtom`. - -### Methods - -#### `Do` - -Perform the Action. - ---- - -## `AtomAction` - -#### Type Parameters - -- `T1` - The type for this Action. - -Generic abstract base class for Actions. Inherits from `AtomAction`. - -### Methods - -#### `Do(t1)` - -Perform the Action. - -##### Parameters - -- `t1` - The first parameter. +- `listener` - The Listener to unregister. --- @@ -1051,184 +891,57 @@ An `AtomFunction`. --- -## `AtomEventBase` +## `IAtomCollection` -None generic base class for Events. Inherits from `BaseAtom` and `ISerializationCallbackReceiver`. - -### Methods - -#### `Register(System.Action)` - -Register handler to be called when the Event triggers. - -##### Parameters - -- `del` - The handler. +Interface for Atom Collections. --- -#### `Unregister(System.Action)` +## `IAtomList` -Unregister handler that was registered using the `Register` method. - -##### Parameters - -- `del` - The handler. +Interface for Atom Lists. --- -#### `UnregisterAll` +## `IGetEvent` -Unregister all handlers that were registered using the `Register` method. +Interface for getting an event. --- -#### `RegisterListener(UnityAtoms.IAtomListener)` +## `IGetOrCreateEvent` -Register a Listener that in turn trigger all its associated handlers when the Event triggers. - -##### Parameters - -- `listener` - The Listener to register. +Interface for getting or creating an event. --- -#### `UnregisterListener(UnityAtoms.IAtomListener)` +## `IGetValue`1` -Unregister a listener that was registered using the `RegisterListener` method. - -##### Parameters - -- `listener` - The Listener to unregister. +Interface for getting a value. --- -## `AtomEvent` +## `IIsValid` -#### Type Parameters - -- `T` - The type for this Event. - -Generic base class for Events. Inherits from `AtomEventBase`. - -### Variables - -#### `_replayBufferSize` - -The event replays the specified number of old values to new subscribers. Works like a ReplaySubject in Rx. +Interface defining an `IsValid` method. --- -#### `_inspectorRaiseValue` +## `IPair`1` -Used when raising values from the inspector for debugging purposes. - -### Properties - -#### `ReplayBuffer` - -Retrieve Replay Buffer as a List. This call will allocate memory so use sparsely. - -### Methods - -#### `Raise(item)` - -Raise the Event. - -##### Parameters - -- `item` - The value associated with the Event. +Interface defining a generic `IPair`. --- -#### `RaiseEditor(item)` +## `ISetEvent` -Used in editor scipts since Raise is ambigious when using reflection to get method. - -##### Parameters - -- `item` - undefined +Interface for setting an event. --- -#### `Register(action)` +## `IVariable`1` -Register handler to be called when the Event triggers. - -##### Parameters - -- `action` - The handler. - ---- - -#### `Unregister(action)` - -Unregister handler that was registered using the `Register` method. - -##### Parameters - -- `action` - The handler. - ---- - -#### `UnregisterAll` - -Unregister all handlers that were registered using the `Register` method. - ---- - -#### `RegisterListener(listener)` - -Register a Listener that in turn trigger all its associated handlers when the Event triggers. - -##### Parameters - -- `listener` - The Listener to register. - ---- - -#### `UnregisterListener(listener)` - -Unregister a listener that was registered using the `RegisterListener` method. - -##### Parameters - -- `listener` - The Listener to unregister. - ---- - -#### `Observe` - -Turn the Event into an `IObservable`. Makes Events compatible with for example UniRx. - -##### Returns - -The Event as an `IObservable`. - ---- - -## `AtomEventReferenceListener` - -#### Type Parameters - -- `T` - The type that we are listening for. -- `E` - Event of type `T`. -- `ER` - Event Reference of type `T`. -- `UER` - UnityEvent of type `T`. - -Generic base class for Listeners using Event Reference. Inherits from `AtomListener` and implements `IAtomListener`. - -### Variables - -#### `_eventReference` - -The Event Reference that we are listening to. - -### Properties - -#### `Event` - -The Event we are listening for as a property. +Interface for retrieving a Variable. --- @@ -1326,21 +1039,190 @@ The Event we are listening for as a property. --- +## `AtomEventReferenceListener` + +#### Type Parameters + +- `T` - The type that we are listening for. +- `E` - Event of type `T`. +- `ER` - Event Reference of type `T`. +- `UER` - UnityEvent of type `T`. + +Generic base class for Listeners using Event Reference. Inherits from `AtomListener` and implements `IAtomListener`. + +### Variables + +#### `_eventReference` + +The Event Reference that we are listening to. + +### Properties + +#### `Event` + +The Event we are listening for as a property. + +--- + ## `VariableResetter` Resets all the Variables in the list on OnEnable. Note that this will cause Events on the Variables to be triggered. --- -## `BaseAtom` +## `AtomPreferences` -None generic base class for all Atoms. +Class to set preferences for Unity Atoms. + +--- + +## `AtomReferenceUsage` + +Different Reference usages. + +--- + +## `AtomBaseReference` + +None generic base class for `AtomReference`. ### Variables -#### `_developerDescription` +#### `_usage` -A description of the Atom made for documentation purposes. +Describes how we use the Reference and where the value comes from. + +--- + +## `AtomReference` + +#### Type Parameters + +- `T` - The type of the variable. +- `P` - IPair of type `T`. +- `C` - Constant of type `T`. +- `V` - Variable of type `T`. +- `E1` - Event of type `T`. +- `E2` - Event of type `IPair`. +- `F` - Function of type `T => T`. +- `VI` - Variable Instancer of type `T`. + +A Reference lets you define a variable in your script where you then from the inspector can choose if it's going to be taking the value from a Constant, Variable, Value or a Variable Instancer. + +### Variables + +#### `_value` + +Value used if `Usage` is set to `Value`. + +--- + +#### `_constant` + +Constant used if `Usage` is set to `Constant`. + +--- + +#### `_variable` + +Variable used if `Usage` is set to `Variable`. + +--- + +#### `_variableInstancer` + +Variable Instancer used if `Usage` is set to `VariableInstancer`. + +### Properties + +#### `Value` + +Get or set the value for the Reference. + +--- + +#### `IsUnassigned` + +### Methods + +#### `GetEvent` + +Get event by type. + +#### Type Parameters + +- `E` - undefined + +##### Returns + +The event. + +--- + +#### `SetEvent(e)` + +Set event by type. + +#### Type Parameters + +- `E` - undefined + +##### Parameters + +- `e` - The new event value. + +--- + +## `EquatableAtomReference` + +#### Type Parameters + +- `T` - The type of the variable. +- `P` - IPair of type `T`. +- `C` - Constant of type `T`. +- `V` - Variable of type `T`. +- `E1` - Event of type `T`. +- `E2` - Event of type `IPair`. +- `F` - Function of type `T => T`. +- `VI` - Variable Instancer of type `T`. + +Atom Reference that where the value is implementing `IEquatable`. + +--- + +## `Void` + +Dummy module class used for representing nothing in for example empty Events, eg: `AtomEvent` + +--- + +## `Runtime` + +Internal constant and static readonly members for runtime usage. + +### Properties + +#### `IsUnityAtomsRepo` + +Determine if we are working the Unity Atoms source library / repo or not. + +--- + +## `Runtime.Constants` + +Runtime constants + +### Variables + +#### `LOG_PREFIX` + +Prefix that should be pre-pended to all Debug.Logs made from UnityAtoms to help immediately inform a user that those logs are made from this library. + +--- + +## `Runtime.ExecutionOrder` + +Constants for defining DefaultExecutionOrder. --- @@ -1559,212 +1441,364 @@ Clear the list. --- -## `IPair`1` - -Interface defining a generic `IPair`. - ---- - -## `IIsValid` - -Interface defining an `IsValid` method. - ---- - -## `ISetEvent` - -Interface for setting an event. - ---- - -## `IGetOrCreateEvent` - -Interface for getting or creating an event. - ---- - -## `IGetEvent` - -Interface for getting an event. - ---- - -## `IAtomCollection` - -Interface for Atom Collections. - ---- - -## `IVariable`1` - -Interface for retrieving a Variable. - ---- - -## `IGetValue`1` - -Interface for getting a value. - ---- - -## `IAtomList` - -Interface for Atom Lists. - ---- - -## `IMGUIUtils` - -Utility methods for IMGUI. - -### Methods - -#### `SnipRectH(UnityEngine.Rect,System.Single)` - -Snip a `Rect` horizontally. - -##### Parameters - -- `rect` - The rect. -- `range` - The range. - -##### Returns - -A new `Rect` snipped horizontally. - ---- - -#### `SnipRectH(UnityEngine.Rect,System.Single,UnityEngine.Rect@,System.Single)` - -Snip a `Rect` horizontally. - -##### Parameters - -- `rect` - The rect. -- `range` - The range. -- `rest` - Rest rect. -- `gutter` - Gutter - -##### Returns - -A new `Rect` snipped horizontally. - ---- - -#### `SnipRectV(UnityEngine.Rect,System.Single)` - -Snip a `Rect` vertically. - -##### Parameters - -- `rect` - The rect. -- `range` - The range. - -##### Returns - -A new `Rect` snipped vertically. - ---- - -#### `SnipRectV(UnityEngine.Rect,System.Single,UnityEngine.Rect@,System.Single)` - -Snip a `Rect` vertically. - -##### Parameters - -- `rect` - The rect. -- `range` - The range. -- `rest` - Rest rect. -- `gutter` - Gutter - -##### Returns - -A new `Rect` snipped vertically. - ---- - -## `StringExtensions` - -Internal extension class for strings. - -### Methods - -#### `ToInt(System.String,System.Int32)` - -Tries to parse a string to an int. - -##### Parameters - -- `str` - The string to parse. -- `def` - The default value if not able to parse the provided string. - -##### Returns - -Returns the string parsed to an int. If not able to parse the string, it returns the default value provided to the method. - ---- - -#### `Repeat(System.String,System.Int32)` - -Repeats the string X amount of times. - -##### Parameters - -- `str` - The string to repeat. -- `times` - The number of times to repeat the provided string. - -##### Returns - -The string repeated X amount of times. - ---- - -#### `Capitalize(System.String)` - -Capitalize the provided string. - -##### Parameters - -- `str` - The string to capitalize. - -##### Returns - -A capitalized version of the string provided. - ---- - -## `SetVariableValue` +## `AtomBaseVariableInstancer` #### Type Parameters -- `T` - The type of the Variable to set. -- `P` - A IPair of type T. -- `V` - A Variable class of type `T` to set. -- `C` - A Constant class of type `T`. -- `R` - A Reference of type `T`. -- `E1` - An Event of type `T`. -- `E2` - An Event x 2 of type `T`. -- `F` - A Function x 2 of type `T`. -- `VI` - A Variable Instancer of type `T`. +- `V` - Variable of type T. +- `P` - IPair of type `T`. +- `T` - The value type. +- `E1` - Event of type T. +- `E2` - Event x 2 of type T. +- `F` - Function of type T => T -Base class for all SetVariableValue Actions. Inherits from `AtomAction`. +A Variable Instancer is a MonoBehaviour that takes a variable as a base and creates an in memory copy of it OnEnable. This is handy when you want to use atoms for prefabs that are instantiated at runtime. Use together with AtomCollection to react accordingly when a prefab with an assoicated atom is added or deleted to the scene. ### Variables -#### `_variable` +#### `_base` -The Variable to set. +The variable that the in memory copy will be based on when created at runtime. + +### Properties + +#### `Variable` + +Getter for retrieving the in memory runtime variable. --- -#### `_value` +#### `Value` -The value to use. +Getter for retrieving the value of the in memory runtime variable. ### Methods -#### `Do` +#### `ImplSpecificSetup` -Perform the action. +Override to add implementation specific setup on `OnEnable`. + +--- + +## `AtomVariableInstancer` + +#### Type Parameters + +- `V` - Variable of type T. +- `P` - IPair of type `T`. +- `T` - The value type. +- `E1` - Event of type T. +- `E2` - Event x 2 of type T. +- `F` - Function of type T => T + +A Variable Instancer is a MonoBehaviour that takes a variable as a base and creates an in memory copy of it OnEnable. This is handy when you want to use atoms for prefabs that are instantiated at runtime. Use together with AtomCollection to react accordingly when a prefab with an associated atom is added or deleted to the scene. + +### Methods + +#### `ImplSpecificSetup` + +Override to add implementation specific setup on `OnEnable`. + +--- + +#### `GetEvent` + +Get event by type. + +#### Type Parameters + +- `E` - undefined + +##### Returns + +The event. + +--- + +#### `SetEvent(e)` + +Set event by type. + +#### Type Parameters + +- `E` - undefined + +##### Parameters + +- `e` - The new event value. + +--- + +#### `GetOrCreateEvent` + +Get event by type. Creates it if it doesn't exist. + +#### Type Parameters + +- `E` - undefined + +##### Returns + +The event. + +--- + +## `AtomBaseVariable` + +None generic base class for Variables. Inherits from `BaseAtom`. + +### Properties + +#### `BaseValue` + +The Variable value as an `object`.abstract Beware of boxing! πŸ₯Š + +### Methods + +#### `Reset(System.Boolean)` + +Abstract method that could be implemented to reset the Variable value. + +--- + +## `AtomBaseVariable` + +#### Type Parameters + +- `T` - The Variable value type. + +Generic base class for Variables. Inherits from `AtomBaseVariable`. + +### Properties + +#### `BaseValue` + +The Variable value as an `object`.abstract Beware of boxing! πŸ₯Š + +--- + +#### `Value` + +The Variable value as a property. + +### Methods + +#### `Equals(other)` + +Determines equality between Variables. + +##### Parameters + +- `other` - The other Variable to compare. + +##### Returns + +`true` if they are equal, otherwise `false`. + +--- + +#### `Reset(System.Boolean)` + +Not implemented.abstract Throws Exception + +--- + +## `AtomVariable` + +#### Type Parameters + +- `T` - The Variable value type. +- `P` - IPair of type `T`. +- `E1` - Event of type `AtomEvent`. +- `E2` - Event of type `AtomEvent`. +- `F` - Function of type `FunctionEvent`. + +Generic base class for Variables. Inherits from `AtomBaseVariable`. + +### Variables + +#### `_changed` + +Changed Event triggered when the Variable value gets changed. + +--- + +#### `_changedWithHistory` + +Changed with history Event triggered when the Variable value gets changed. + +--- + +#### `_triggerChangedOnOnEnable` + +Whether Changed Event should be triggered on OnEnable or not + +--- + +#### `_triggerChangedWithHistoryOnOnEnable` + +Whether ChangedWithHistory Event should be triggered on OnEnable or not + +--- + +#### `_initialValue` + +The inital value of the Variable. + +--- + +#### `_instances` + +Set of all AtomVariable instances in editor. + +### Properties + +#### `Value` + +The Variable value as a property. + +--- + +#### `InitialValue` + +The initial value as a property. + +--- + +#### `OldValue` + +The value the Variable had before its value got changed last time. + +--- + +#### `PreChangeTransformers` + +When setting the value of a Variable the new value will be piped through all the pre change transformers, which allows you to create custom logic and restriction on for example what values can be set for this Variable. + +### Methods + +#### `SetInitialValues` + +Set initial values + +--- + +#### `TriggerInitialEvents` + +Trigger initial events if related options enabled + +--- + +#### `Reset(System.Boolean)` + +Reset the Variable to its `_initialValue`. + +##### Parameters + +- `shouldTriggerEvents` - Set to `true` if Events should be triggered on reset, otherwise `false`. + +--- + +#### `SetValue(newValue)` + +Set the Variable value. + +##### Parameters + +- `newValue` - The new value to set. + +##### Returns + +`true` if the value got changed, otherwise `false`. + +--- + +#### `SetValue(variable)` + +Set the Variable value. + +##### Parameters + +- `variable` - The value to set provided from another Variable. + +##### Returns + +`true` if the value got changed, otherwise `false`. + +--- + +#### `ObserveChange` + +Turn the Variable's change Event into an `IObservable`. Makes the Variable's change Event compatible with for example UniRx. + +##### Returns + +The Variable's change Event as an `IObservable`. + +--- + +#### `ObserveChangeWithHistory` + +Turn the Variable's change with history Event into an `IObservable`. Makes the Variable's change with history Event compatible with for example UniRx. + +##### Returns + +The Variable's change Event as an `IObservable`. + +--- + +#### `GetEvent` + +Get event by type (allowing inheritance). + +#### Type Parameters + +- `E` - undefined + +##### Returns + +{"_":"Changed - If Changed (or ChangedWithHistory) are of type E\r\n ChangedWithHistory - If not Changed but ChangedWithHistory is of type E\r\n \r\n ","exception":[{"_":"if none of the events are of type E","$":{"cref":"T:System.NotSupportedException"}}]} + +--- + +#### `SetEvent(e)` + +Set event by type. + +#### Type Parameters + +- `E` - undefined + +##### Parameters + +- `e` - The new event value. + +--- + +#### `GetOrCreateEvent` + +Get event by type (allowing inheritance). Creates an event if the type is supported for this Variable, but the Event itself is `null`. + +#### Type Parameters + +- `E` - undefined + +##### Returns + +{"_":"Changed - If Changed (or ChangedWithHistory) are of type E\r\n ChangedWithHistory - If not Changed but ChangedWithHistory is of type E\r\n \r\n ","exception":[{"_":"if none of the events are of type E","$":{"cref":"T:System.NotSupportedException"}}]} + +--- + +## `EquatableAtomVariable` + +#### Type Parameters + +- `T` - The Variable type. +- `P` - Pair of type T. +- `E1` - Event of type T. +- `E2` - Pair event of type T. +- `F` - Function of type T and T. + +Atom Variable base class for types that are implementing `IEquatable`. --- diff --git a/docs/api/unityatoms.mobile.editor.md b/docs/api/unityatoms.mobile.editor.md index fc2ebdf5..36e0bd68 100644 --- a/docs/api/unityatoms.mobile.editor.md +++ b/docs/api/unityatoms.mobile.editor.md @@ -7,9 +7,33 @@ sidebar_label: UnityAtoms.Mobile.Editor # Namespace - `UnityAtoms.Mobile.Editor` -## `TouchUserInputVariableEditor` +## `TouchUserInputConstantDrawer` -Variable Inspector of type `TouchUserInput`. Inherits from `AtomVariableEditor` +Constant property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `TouchUserInputEventDrawer` + +Event property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `TouchUserInputPairEventDrawer` + +Event property drawer of type `TouchUserInputPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `TouchUserInputValueListDrawer` + +Value List property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `TouchUserInputVariableDrawer` + +Variable property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -25,32 +49,8 @@ Event property drawer of type `TouchUserInputPair`. Inherits from `AtomEventEdit --- -## `TouchUserInputConstantDrawer` +## `TouchUserInputVariableEditor` -Constant property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `TouchUserInputVariableDrawer` - -Variable property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `TouchUserInputPairEventDrawer` - -Event property drawer of type `TouchUserInputPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `TouchUserInputEventDrawer` - -Event property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `TouchUserInputValueListDrawer` - -Value List property drawer of type `TouchUserInput`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Variable Inspector of type `TouchUserInput`. Inherits from `AtomVariableEditor` --- diff --git a/docs/api/unityatoms.mobile.md b/docs/api/unityatoms.mobile.md index 4b97a063..6c2edd15 100644 --- a/docs/api/unityatoms.mobile.md +++ b/docs/api/unityatoms.mobile.md @@ -7,9 +7,63 @@ sidebar_label: UnityAtoms.Mobile # Namespace - `UnityAtoms.Mobile` -## `TouchUserInputPairEventReferenceListener` +## `TouchUserInputAction` -Event Reference Listener of type `TouchUserInputPair`. Inherits from `AtomEventReferenceListener`. +Action of type `TouchUserInput`. Inherits from `AtomAction`. + +--- + +## `TouchUserInputPairAction` + +Action of type `TouchUserInputPair`. Inherits from `AtomAction`. + +--- + +## `UpdateTouchUserInput` + +Updates the `TouchUserInputVariable` on every Update tick. Meant to be called every Update. + +### Variables + +#### `TouchUserInputVariable` + +The `TouchUserInputVariable` to update. + +### Methods + +#### `Do` + +Update the `TouchUserInputVariable`.abstract Call this on every Update tick. + +--- + +## `SetTouchUserInputVariableValue` + +Set variable value Action of type `TouchUserInput`. Inherits from `SetVariableValue`. + +--- + +## `TouchUserInputCondition` + +Condition of type `TouchUserInput`. Inherits from `AtomCondition`. + +--- + +## `TouchUserInputConstant` + +Constant of type `TouchUserInput`. Inherits from `AtomBaseVariable`. + +--- + +## `TouchUserInputEventInstancer` + +Event Instancer of type `TouchUserInput`. Inherits from `AtomEventInstancer`. + +--- + +## `TouchUserInputPairEventInstancer` + +Event Instancer of type `TouchUserInputPair`. Inherits from `AtomEventInstancer`. --- @@ -19,6 +73,60 @@ Event Reference Listener of type `TouchUserInput`. Inherits from `AtomEventRefer --- +## `TouchUserInputPairEventReferenceListener` + +Event Reference Listener of type `TouchUserInputPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `TouchUserInputEventReference` + +Event Reference of type `TouchUserInput`. Inherits from `AtomEventReference`. + +--- + +## `TouchUserInputPairEventReference` + +Event Reference of type `TouchUserInputPair`. Inherits from `AtomEventReference`. + +--- + +## `TouchUserInputEvent` + +Event of type `TouchUserInput`. Inherits from `AtomEvent`. + +--- + +## `TouchUserInputPairEvent` + +Event of type `TouchUserInputPair`. Inherits from `AtomEvent`. + +--- + +## `TouchUserInputTouchUserInputFunction` + +Function x 2 of type `TouchUserInput`. Inherits from `AtomFunction`. + +--- + +## `TouchUserInputPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `TouchUserInputReference` + +Reference of type `TouchUserInput`. Inherits from `EquatableAtomReference`. + +--- + +## `SyncTouchUserInputVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type TouchUserInput to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + ## `TouchUserInput` Module class holding data for touch user input. @@ -154,135 +262,21 @@ Enum for different touch user input states. --- -## `TouchUserInputReference` - -Reference of type `TouchUserInput`. Inherits from `EquatableAtomReference`. - ---- - -## `TouchUserInputPair` - -IPair of type ``. Inherits from `IPair`. - ---- - ## `TouchUserInputPairUnityEvent` None generic Unity Event of type `TouchUserInputPair`. Inherits from `UnityEvent`. --- -## `TouchUserInputUnityEvent` - -None generic Unity Event of type `TouchUserInput`. Inherits from `UnityEvent`. - ---- - ## `TouchUserInputTouchUserInputUnityEvent` None generic Unity Event x 2 of type `TouchUserInput`. Inherits from `UnityEvent`. --- -## `TouchUserInputConstant` +## `TouchUserInputUnityEvent` -Constant of type `TouchUserInput`. Inherits from `AtomBaseVariable`. - ---- - -## `TouchUserInputEventReference` - -Event Reference of type `TouchUserInput`. Inherits from `AtomEventReference`. - ---- - -## `TouchUserInputPairEventReference` - -Event Reference of type `TouchUserInputPair`. Inherits from `AtomEventReference`. - ---- - -## `TouchUserInputVariableInstancer` - -Variable Instancer of type `TouchUserInput`. Inherits from `AtomVariableInstancer`. - ---- - -## `TouchUserInputPairEventInstancer` - -Event Instancer of type `TouchUserInputPair`. Inherits from `AtomEventInstancer`. - ---- - -## `TouchUserInputEventInstancer` - -Event Instancer of type `TouchUserInput`. Inherits from `AtomEventInstancer`. - ---- - -## `TouchUserInputVariable` - -Variable of type `TouchUserInput`. Inherits from `EquatableAtomVariable`. - ---- - -## `TouchUserInputCondition` - -Condition of type `TouchUserInput`. Inherits from `AtomCondition`. - ---- - -## `TouchUserInputPairAction` - -Action of type `TouchUserInputPair`. Inherits from `AtomAction`. - ---- - -## `UpdateTouchUserInput` - -Updates the `TouchUserInputVariable` on every Update tick. Meant to be called every Update. - -### Variables - -#### `TouchUserInputVariable` - -The `TouchUserInputVariable` to update. - -### Methods - -#### `Do` - -Update the `TouchUserInputVariable`.abstract Call this on every Update tick. - ---- - -## `TouchUserInputAction` - -Action of type `TouchUserInput`. Inherits from `AtomAction`. - ---- - -## `TouchUserInputTouchUserInputFunction` - -Function x 2 of type `TouchUserInput`. Inherits from `AtomFunction`. - ---- - -## `SyncTouchUserInputVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type TouchUserInput to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `TouchUserInputPairEvent` - -Event of type `TouchUserInputPair`. Inherits from `AtomEvent`. - ---- - -## `TouchUserInputEvent` - -Event of type `TouchUserInput`. Inherits from `AtomEvent`. +None generic Unity Event of type `TouchUserInput`. Inherits from `UnityEvent`. --- @@ -292,8 +286,14 @@ Value List of type `TouchUserInput`. Inherits from `AtomValueList`. +Variable Instancer of type `TouchUserInput`. Inherits from `AtomVariableInstancer`. + +--- + +## `TouchUserInputVariable` + +Variable of type `TouchUserInput`. Inherits from `EquatableAtomVariable`. --- diff --git a/docs/api/unityatoms.monohooks.editor.md b/docs/api/unityatoms.monohooks.editor.md index fe27a4a0..df7dde65 100644 --- a/docs/api/unityatoms.monohooks.editor.md +++ b/docs/api/unityatoms.monohooks.editor.md @@ -7,75 +7,9 @@ sidebar_label: UnityAtoms.MonoHooks.Editor # Namespace - `UnityAtoms.MonoHooks.Editor` -## `CollisionGameObjectVariableEditor` +## `Collider2DGameObjectConstantDrawer` -Variable Inspector of type `CollisionGameObject`. Inherits from `AtomVariableEditor` - ---- - -## `Collider2DGameObjectVariableEditor` - -Variable Inspector of type `Collider2DGameObject`. Inherits from `AtomVariableEditor` - ---- - -## `Collision2DGameObjectVariableEditor` - -Variable Inspector of type `Collision2DGameObject`. Inherits from `AtomVariableEditor` - ---- - -## `ColliderGameObjectVariableEditor` - -Variable Inspector of type `ColliderGameObject`. Inherits from `AtomVariableEditor` - ---- - -## `Collision2DGameObjectEventEditor` - -Event property drawer of type `Collision2DGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DGameObjectPairEventEditor` - -Event property drawer of type `Collider2DGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DGameObjectEventEditor` - -Event property drawer of type `Collider2DGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DGameObjectPairEventEditor` - -Event property drawer of type `Collision2DGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderGameObjectEventEditor` - -Event property drawer of type `ColliderGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionGameObjectPairEventEditor` - -Event property drawer of type `CollisionGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionGameObjectEventEditor` - -Event property drawer of type `CollisionGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `ColliderGameObjectPairEventEditor` - -Event property drawer of type `ColliderGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. +Constant property drawer of type `Collider2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -97,33 +31,21 @@ Constant property drawer of type `CollisionGameObject`. Inherits from `AtomDrawe --- -## `Collider2DGameObjectConstantDrawer` +## `Collider2DGameObjectEventDrawer` -Constant property drawer of type `Collider2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `Collider2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `ColliderGameObjectVariableDrawer` +## `Collider2DGameObjectPairEventDrawer` -Variable property drawer of type `ColliderGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `Collider2DGameObjectPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- -## `Collision2DGameObjectVariableDrawer` +## `ColliderGameObjectEventDrawer` -Variable property drawer of type `Collision2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DGameObjectVariableDrawer` - -Variable property drawer of type `Collider2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `CollisionGameObjectVariableDrawer` - -Variable property drawer of type `CollisionGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Event property drawer of type `ColliderGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -133,6 +55,18 @@ Event property drawer of type `ColliderGameObjectPair`. Inherits from `AtomDrawe --- +## `Collision2DGameObjectEventDrawer` + +Event property drawer of type `Collision2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collision2DGameObjectPairEventDrawer` + +Event property drawer of type `Collision2DGameObjectPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + ## `CollisionGameObjectEventDrawer` Event property drawer of type `CollisionGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. @@ -145,42 +79,6 @@ Event property drawer of type `CollisionGameObjectPair`. Inherits from `AtomDraw --- -## `ColliderGameObjectEventDrawer` - -Event property drawer of type `ColliderGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DGameObjectEventDrawer` - -Event property drawer of type `Collider2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DGameObjectPairEventDrawer` - -Event property drawer of type `Collision2DGameObjectPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DGameObjectEventDrawer` - -Event property drawer of type `Collision2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collider2DGameObjectPairEventDrawer` - -Event property drawer of type `Collider2DGameObjectPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `Collision2DGameObjectValueListDrawer` - -Value List property drawer of type `Collision2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - ## `Collider2DGameObjectValueListDrawer` Value List property drawer of type `Collider2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. @@ -193,8 +91,110 @@ Value List property drawer of type `ColliderGameObject`. Inherits from `AtomDraw --- +## `Collision2DGameObjectValueListDrawer` + +Value List property drawer of type `Collision2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + ## `CollisionGameObjectValueListDrawer` Value List property drawer of type `CollisionGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- + +## `Collider2DGameObjectVariableDrawer` + +Variable property drawer of type `Collider2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColliderGameObjectVariableDrawer` + +Variable property drawer of type `ColliderGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collision2DGameObjectVariableDrawer` + +Variable property drawer of type `Collision2DGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `CollisionGameObjectVariableDrawer` + +Variable property drawer of type `CollisionGameObject`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collider2DGameObjectEventEditor` + +Event property drawer of type `Collider2DGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collider2DGameObjectPairEventEditor` + +Event property drawer of type `Collider2DGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColliderGameObjectEventEditor` + +Event property drawer of type `ColliderGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `ColliderGameObjectPairEventEditor` + +Event property drawer of type `ColliderGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collision2DGameObjectEventEditor` + +Event property drawer of type `Collision2DGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collision2DGameObjectPairEventEditor` + +Event property drawer of type `Collision2DGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `CollisionGameObjectEventEditor` + +Event property drawer of type `CollisionGameObject`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `CollisionGameObjectPairEventEditor` + +Event property drawer of type `CollisionGameObjectPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `Collider2DGameObjectVariableEditor` + +Variable Inspector of type `Collider2DGameObject`. Inherits from `AtomVariableEditor` + +--- + +## `ColliderGameObjectVariableEditor` + +Variable Inspector of type `ColliderGameObject`. Inherits from `AtomVariableEditor` + +--- + +## `Collision2DGameObjectVariableEditor` + +Variable Inspector of type `Collision2DGameObject`. Inherits from `AtomVariableEditor` + +--- + +## `CollisionGameObjectVariableEditor` + +Variable Inspector of type `CollisionGameObject`. Inherits from `AtomVariableEditor` + +--- diff --git a/docs/api/unityatoms.monohooks.md b/docs/api/unityatoms.monohooks.md index c36a7a9e..d598e063 100644 --- a/docs/api/unityatoms.monohooks.md +++ b/docs/api/unityatoms.monohooks.md @@ -7,147 +7,105 @@ sidebar_label: UnityAtoms.MonoHooks # Namespace - `UnityAtoms.MonoHooks` -## `CollisionGameObjectPairEventReferenceListener` +## `Collider2DGameObjectAction` -Event Reference Listener of type `CollisionGameObjectPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Collider2DGameObject`. Inherits from `AtomAction`. --- -## `Collider2DGameObjectEventReferenceListener` +## `Collider2DGameObjectPairAction` -Event Reference Listener of type `Collider2DGameObject`. Inherits from `AtomEventReferenceListener`. +Action of type `Collider2DGameObjectPair`. Inherits from `AtomAction`. --- -## `ColliderGameObjectEventReferenceListener` +## `ColliderGameObjectAction` -Event Reference Listener of type `ColliderGameObject`. Inherits from `AtomEventReferenceListener`. +Action of type `ColliderGameObject`. Inherits from `AtomAction`. --- -## `Collision2DGameObjectEventReferenceListener` +## `ColliderGameObjectPairAction` -Event Reference Listener of type `Collision2DGameObject`. Inherits from `AtomEventReferenceListener`. +Action of type `ColliderGameObjectPair`. Inherits from `AtomAction`. --- -## `Collider2DGameObjectPairEventReferenceListener` +## `Collision2DGameObjectAction` -Event Reference Listener of type `Collider2DGameObjectPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Collision2DGameObject`. Inherits from `AtomAction`. --- -## `ColliderGameObjectPairEventReferenceListener` +## `Collision2DGameObjectPairAction` -Event Reference Listener of type `ColliderGameObjectPair`. Inherits from `AtomEventReferenceListener`. +Action of type `Collision2DGameObjectPair`. Inherits from `AtomAction`. --- -## `Collision2DGameObjectPairEventReferenceListener` +## `CollisionGameObjectAction` -Event Reference Listener of type `Collision2DGameObjectPair`. Inherits from `AtomEventReferenceListener`. +Action of type `CollisionGameObject`. Inherits from `AtomAction`. --- -## `CollisionGameObjectEventReferenceListener` +## `CollisionGameObjectPairAction` -Event Reference Listener of type `CollisionGameObject`. Inherits from `AtomEventReferenceListener`. +Action of type `CollisionGameObjectPair`. Inherits from `AtomAction`. --- -## `ColliderGameObjectReference` +## `SetCollider2DGameObjectVariableValue` -Reference of type `ColliderGameObject`. Inherits from `EquatableAtomReference`. +Set variable value Action of type `Collider2DGameObject`. Inherits from `SetVariableValue`. --- -## `CollisionGameObjectReference` +## `SetColliderGameObjectVariableValue` -Reference of type `CollisionGameObject`. Inherits from `EquatableAtomReference`. +Set variable value Action of type `ColliderGameObject`. Inherits from `SetVariableValue`. --- -## `Collision2DGameObjectReference` +## `SetCollision2DGameObjectVariableValue` -Reference of type `Collision2DGameObject`. Inherits from `EquatableAtomReference`. +Set variable value Action of type `Collision2DGameObject`. Inherits from `SetVariableValue`. --- -## `Collider2DGameObjectReference` +## `SetCollisionGameObjectVariableValue` -Reference of type `Collider2DGameObject`. Inherits from `EquatableAtomReference`. +Set variable value Action of type `CollisionGameObject`. Inherits from `SetVariableValue`. --- -## `Collider2DGameObjectPair` +## `Collider2DGameObjectCondition` -IPair of type ``. Inherits from `IPair`. +Condition of type `Collider2DGameObject`. Inherits from `AtomCondition`. --- -## `Collision2DGameObjectPair` +## `ColliderGameObjectCondition` -IPair of type ``. Inherits from `IPair`. +Condition of type `ColliderGameObject`. Inherits from `AtomCondition`. --- -## `ColliderGameObjectPair` +## `Collision2DGameObjectCondition` -IPair of type ``. Inherits from `IPair`. +Condition of type `Collision2DGameObject`. Inherits from `AtomCondition`. --- -## `CollisionGameObjectPair` +## `CollisionGameObjectCondition` -IPair of type ``. Inherits from `IPair`. +Condition of type `CollisionGameObject`. Inherits from `AtomCondition`. --- -## `Collision2DGameObjectUnityEvent` +## `Collider2DGameObjectConstant` -None generic Unity Event of type `Collision2DGameObject`. Inherits from `UnityEvent`. - ---- - -## `Collider2DGameObjectUnityEvent` - -None generic Unity Event of type `Collider2DGameObject`. Inherits from `UnityEvent`. - ---- - -## `Collider2DGameObjectPairUnityEvent` - -None generic Unity Event of type `Collider2DGameObjectPair`. Inherits from `UnityEvent`. - ---- - -## `CollisionGameObjectPairUnityEvent` - -None generic Unity Event of type `CollisionGameObjectPair`. Inherits from `UnityEvent`. - ---- - -## `CollisionGameObjectUnityEvent` - -None generic Unity Event of type `CollisionGameObject`. Inherits from `UnityEvent`. - ---- - -## `Collision2DGameObjectPairUnityEvent` - -None generic Unity Event of type `Collision2DGameObjectPair`. Inherits from `UnityEvent`. - ---- - -## `ColliderGameObjectPairUnityEvent` - -None generic Unity Event of type `ColliderGameObjectPair`. Inherits from `UnityEvent`. - ---- - -## `ColliderGameObjectUnityEvent` - -None generic Unity Event of type `ColliderGameObject`. Inherits from `UnityEvent`. +Constant of type `Collider2DGameObject`. Inherits from `AtomBaseVariable`. --- @@ -163,93 +121,21 @@ Constant of type `Collision2DGameObject`. Inherits from `AtomBaseVariable`. - ---- - ## `CollisionGameObjectConstant` Constant of type `CollisionGameObject`. Inherits from `AtomBaseVariable`. --- -## `CollisionGameObjectEventReference` +## `Collider2DGameObjectEventInstancer` -Event Reference of type `CollisionGameObject`. Inherits from `AtomEventReference`. +Event Instancer of type `Collider2DGameObject`. Inherits from `AtomEventInstancer`. --- -## `CollisionGameObjectPairEventReference` +## `Collider2DGameObjectPairEventInstancer` -Event Reference of type `CollisionGameObjectPair`. Inherits from `AtomEventReference`. - ---- - -## `ColliderGameObjectPairEventReference` - -Event Reference of type `ColliderGameObjectPair`. Inherits from `AtomEventReference`. - ---- - -## `Collider2DGameObjectEventReference` - -Event Reference of type `Collider2DGameObject`. Inherits from `AtomEventReference`. - ---- - -## `Collider2DGameObjectPairEventReference` - -Event Reference of type `Collider2DGameObjectPair`. Inherits from `AtomEventReference`. - ---- - -## `Collision2DGameObjectPairEventReference` - -Event Reference of type `Collision2DGameObjectPair`. Inherits from `AtomEventReference`. - ---- - -## `ColliderGameObjectEventReference` - -Event Reference of type `ColliderGameObject`. Inherits from `AtomEventReference`. - ---- - -## `Collision2DGameObjectEventReference` - -Event Reference of type `Collision2DGameObject`. Inherits from `AtomEventReference`. - ---- - -## `ColliderGameObjectVariableInstancer` - -Variable Instancer of type `ColliderGameObject`. Inherits from `AtomVariableInstancer`. - ---- - -## `CollisionGameObjectVariableInstancer` - -Variable Instancer of type `CollisionGameObject`. Inherits from `AtomVariableInstancer`. - ---- - -## `Collider2DGameObjectVariableInstancer` - -Variable Instancer of type `Collider2DGameObject`. Inherits from `AtomVariableInstancer`. - ---- - -## `Collision2DGameObjectVariableInstancer` - -Variable Instancer of type `Collision2DGameObject`. Inherits from `AtomVariableInstancer`. - ---- - -## `Collision2DGameObjectPairEventInstancer` - -Event Instancer of type `Collision2DGameObjectPair`. Inherits from `AtomEventInstancer`. +Event Instancer of type `Collider2DGameObjectPair`. Inherits from `AtomEventInstancer`. --- @@ -259,15 +145,21 @@ Event Instancer of type `ColliderGameObject`. Inherits from `AtomEventInstancer< --- +## `ColliderGameObjectPairEventInstancer` + +Event Instancer of type `ColliderGameObjectPair`. Inherits from `AtomEventInstancer`. + +--- + ## `Collision2DGameObjectEventInstancer` Event Instancer of type `Collision2DGameObject`. Inherits from `AtomEventInstancer`. --- -## `Collider2DGameObjectPairEventInstancer` +## `Collision2DGameObjectPairEventInstancer` -Event Instancer of type `Collider2DGameObjectPair`. Inherits from `AtomEventInstancer`. +Event Instancer of type `Collision2DGameObjectPair`. Inherits from `AtomEventInstancer`. --- @@ -283,45 +175,183 @@ Event Instancer of type `CollisionGameObjectPair`. Inherits from `AtomEventInsta --- -## `ColliderGameObjectPairEventInstancer` +## `Collider2DGameObjectEventReferenceListener` -Event Instancer of type `ColliderGameObjectPair`. Inherits from `AtomEventInstancer`. +Event Reference Listener of type `Collider2DGameObject`. Inherits from `AtomEventReferenceListener`. --- -## `Collider2DGameObjectEventInstancer` +## `Collider2DGameObjectPairEventReferenceListener` -Event Instancer of type `Collider2DGameObject`. Inherits from `AtomEventInstancer`. +Event Reference Listener of type `Collider2DGameObjectPair`. Inherits from `AtomEventReferenceListener`. --- -## `Collider2DGameObjectVariable` +## `ColliderGameObjectEventReferenceListener` -Variable of type `Collider2DGameObject`. Inherits from `EquatableAtomVariable`. +Event Reference Listener of type `ColliderGameObject`. Inherits from `AtomEventReferenceListener`. --- -## `CollisionGameObjectVariable` +## `ColliderGameObjectPairEventReferenceListener` -Variable of type `CollisionGameObject`. Inherits from `EquatableAtomVariable`. +Event Reference Listener of type `ColliderGameObjectPair`. Inherits from `AtomEventReferenceListener`. --- -## `ColliderGameObjectVariable` +## `Collision2DGameObjectEventReferenceListener` -Variable of type `ColliderGameObject`. Inherits from `EquatableAtomVariable`. +Event Reference Listener of type `Collision2DGameObject`. Inherits from `AtomEventReferenceListener`. --- -## `Collision2DGameObjectVariable` +## `Collision2DGameObjectPairEventReferenceListener` -Variable of type `Collision2DGameObject`. Inherits from `EquatableAtomVariable`. +Event Reference Listener of type `Collision2DGameObjectPair`. Inherits from `AtomEventReferenceListener`. --- -## `OnDestroyHook` +## `CollisionGameObjectEventReferenceListener` -Mono Hook for [`OnDestroy`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDestroy.html) +Event Reference Listener of type `CollisionGameObject`. Inherits from `AtomEventReferenceListener`. + +--- + +## `CollisionGameObjectPairEventReferenceListener` + +Event Reference Listener of type `CollisionGameObjectPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `Collider2DGameObjectEventReference` + +Event Reference of type `Collider2DGameObject`. Inherits from `AtomEventReference`. + +--- + +## `Collider2DGameObjectPairEventReference` + +Event Reference of type `Collider2DGameObjectPair`. Inherits from `AtomEventReference`. + +--- + +## `ColliderGameObjectEventReference` + +Event Reference of type `ColliderGameObject`. Inherits from `AtomEventReference`. + +--- + +## `ColliderGameObjectPairEventReference` + +Event Reference of type `ColliderGameObjectPair`. Inherits from `AtomEventReference`. + +--- + +## `Collision2DGameObjectEventReference` + +Event Reference of type `Collision2DGameObject`. Inherits from `AtomEventReference`. + +--- + +## `Collision2DGameObjectPairEventReference` + +Event Reference of type `Collision2DGameObjectPair`. Inherits from `AtomEventReference`. + +--- + +## `CollisionGameObjectEventReference` + +Event Reference of type `CollisionGameObject`. Inherits from `AtomEventReference`. + +--- + +## `CollisionGameObjectPairEventReference` + +Event Reference of type `CollisionGameObjectPair`. Inherits from `AtomEventReference`. + +--- + +## `Collider2DGameObjectEvent` + +Event of type `Collider2DGameObject`. Inherits from `AtomEvent`. + +--- + +## `Collider2DGameObjectPairEvent` + +Event of type `Collider2DGameObjectPair`. Inherits from `AtomEvent`. + +--- + +## `ColliderGameObjectEvent` + +Event of type `ColliderGameObject`. Inherits from `AtomEvent`. + +--- + +## `ColliderGameObjectPairEvent` + +Event of type `ColliderGameObjectPair`. Inherits from `AtomEvent`. + +--- + +## `Collision2DGameObjectEvent` + +Event of type `Collision2DGameObject`. Inherits from `AtomEvent`. + +--- + +## `Collision2DGameObjectPairEvent` + +Event of type `Collision2DGameObjectPair`. Inherits from `AtomEvent`. + +--- + +## `CollisionGameObjectEvent` + +Event of type `CollisionGameObject`. Inherits from `AtomEvent`. + +--- + +## `CollisionGameObjectPairEvent` + +Event of type `CollisionGameObjectPair`. Inherits from `AtomEvent`. + +--- + +## `Collider2DGameObjectCollider2DGameObjectFunction` + +Function x 2 of type `Collider2DGameObject`. Inherits from `AtomFunction`. + +--- + +## `ColliderGameObjectColliderGameObjectFunction` + +Function x 2 of type `ColliderGameObject`. Inherits from `AtomFunction`. + +--- + +## `Collision2DGameObjectCollision2DGameObjectFunction` + +Function x 2 of type `Collision2DGameObject`. Inherits from `AtomFunction`. + +--- + +## `CollisionGameObjectCollisionGameObjectFunction` + +Function x 2 of type `CollisionGameObject`. Inherits from `AtomFunction`. + +--- + +## `Collider2DHook` + +Base class for all `MonoHook`s of type `Collider2D`. + +### Properties + +#### `EventWithGameObject` + +Event including a GameObject reference. --- @@ -337,9 +367,153 @@ Event including a GameObject reference. --- -## `OnUpdateHook` +## `Collision2DHook` -Mono Hook for [`Update`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Update.html) +Base class for all `MonoHook`s of type `Collision2D`. + +### Properties + +#### `EventWithGameObject` + +Event including a GameObject reference. + +--- + +## `CollisionHook` + +Base class for all `MonoHook`s of type `Collision`. + +### Properties + +#### `EventWithGameObject` + +Event including a GameObject reference. + +--- + +## `MonoHook` + +#### Type Parameters + +- `E` - Event of type `AtomEvent` +- `EV` - Event value type +- `F` - Function type `AtomFunction` + +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`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Awake.html). + +### Variables + +#### `_listener` + +Listener + +--- + +#### `_gameObjectListener` + +Listener with GameObject reference + +--- + +## `OnButtonClickHook` + +Mono Hook for On Button Click + +--- + +## `OnCollision2DHook` + +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) + +### 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`](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) + +### 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`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.OnDestroy.html) + +--- + +## `OnFixedUpdateHook` + +Mono Hook for [`FixedUpdate`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.FixedUpdate.html) + +--- + +## `OnLateUpdateHook` + +Mono Hook for [`LateUpdate`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.LateUpdate.html) + +--- + +## `OnPointerDownHook` + +Mono Hook for `OnPointerDown` + +--- + +## `OnStartHook` + +Mono Hook for [`Start`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Start.html) --- @@ -391,159 +565,9 @@ Set to true if Event should be triggered on `OnTriggerStay` --- -## `OnCollisionHook` +## `OnUpdateHook` -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) - -### 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` - ---- - -## `Collision2DHook` - -Base class for all `MonoHook`s of type `Collision2D`. - -### Properties - -#### `EventWithGameObject` - -Event including a GameObject reference. - ---- - -## `MonoHook` - -#### Type Parameters - -- `E` - Event of type `AtomEvent` -- `EV` - Event value type -- `F` - Function type `AtomFunction` - -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 - ---- - -## `OnCollision2DHook` - -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) - -### 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` - ---- - -## `OnLateUpdateHook` - -Mono Hook for [`LateUpdate`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.LateUpdate.html) - ---- - -## `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` - ---- - -## `CollisionHook` - -Base class for all `MonoHook`s of type `Collision`. - -### Properties - -#### `EventWithGameObject` - -Event including a GameObject reference. - ---- - -## `Collider2DHook` - -Base class for all `MonoHook`s of type `Collider2D`. - -### Properties - -#### `EventWithGameObject` - -Event including a GameObject reference. - ---- - -## `OnAwakeHook` - -Mono Hook for [`Awake`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Awake.html). - -### Variables - -#### `_listener` - -Listener - ---- - -#### `_gameObjectListener` - -Listener with GameObject reference - ---- - -## `OnStartHook` - -Mono Hook for [`Start`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Start.html) +Mono Hook for [`Update`](https://docs.unity3d.com/ScriptReference/MonoBehaviour.Update.html) --- @@ -571,105 +595,51 @@ Selector function for the Event `EventWithGameObjectReference`. Makes it possibl --- -## `ColliderGameObjectCondition` +## `Collider2DGameObjectPair` -Condition of type `ColliderGameObject`. Inherits from `AtomCondition`. +IPair of type ``. Inherits from `IPair`. --- -## `CollisionGameObjectCondition` +## `ColliderGameObjectPair` -Condition of type `CollisionGameObject`. Inherits from `AtomCondition`. +IPair of type ``. Inherits from `IPair`. --- -## `Collision2DGameObjectCondition` +## `Collision2DGameObjectPair` -Condition of type `Collision2DGameObject`. Inherits from `AtomCondition`. +IPair of type ``. Inherits from `IPair`. --- -## `Collider2DGameObjectCondition` +## `CollisionGameObjectPair` -Condition of type `Collider2DGameObject`. Inherits from `AtomCondition`. +IPair of type ``. Inherits from `IPair`. --- -## `Collider2DGameObjectAction` +## `Collider2DGameObjectReference` -Action of type `Collider2DGameObject`. Inherits from `AtomAction`. +Reference of type `Collider2DGameObject`. Inherits from `EquatableAtomReference`. --- -## `Collision2DGameObjectPairAction` +## `ColliderGameObjectReference` -Action of type `Collision2DGameObjectPair`. Inherits from `AtomAction`. +Reference of type `ColliderGameObject`. Inherits from `EquatableAtomReference`. --- -## `Collision2DGameObjectAction` +## `Collision2DGameObjectReference` -Action of type `Collision2DGameObject`. Inherits from `AtomAction`. +Reference of type `Collision2DGameObject`. Inherits from `EquatableAtomReference`. --- -## `Collider2DGameObjectPairAction` +## `CollisionGameObjectReference` -Action of type `Collider2DGameObjectPair`. Inherits from `AtomAction`. - ---- - -## `CollisionGameObjectAction` - -Action of type `CollisionGameObject`. Inherits from `AtomAction`. - ---- - -## `ColliderGameObjectPairAction` - -Action of type `ColliderGameObjectPair`. Inherits from `AtomAction`. - ---- - -## `ColliderGameObjectAction` - -Action of type `ColliderGameObject`. Inherits from `AtomAction`. - ---- - -## `CollisionGameObjectPairAction` - -Action of type `CollisionGameObjectPair`. Inherits from `AtomAction`. - ---- - -## `CollisionGameObjectCollisionGameObjectFunction` - -Function x 2 of type `CollisionGameObject`. Inherits from `AtomFunction`. - ---- - -## `Collider2DGameObjectCollider2DGameObjectFunction` - -Function x 2 of type `Collider2DGameObject`. Inherits from `AtomFunction`. - ---- - -## `Collision2DGameObjectCollision2DGameObjectFunction` - -Function x 2 of type `Collision2DGameObject`. Inherits from `AtomFunction`. - ---- - -## `ColliderGameObjectColliderGameObjectFunction` - -Function x 2 of type `ColliderGameObject`. Inherits from `AtomFunction`. - ---- - -## `SyncCollision2DGameObjectVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type Collision2DGameObject to a Collection or List on OnEnable and removes it on OnDestroy. +Reference of type `CollisionGameObject`. Inherits from `EquatableAtomReference`. --- @@ -685,75 +655,63 @@ Adds Variable Instancer's Variable of type ColliderGameObject to a Collection or --- +## `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. --- -## `ColliderGameObjectPairEvent` +## `Collider2DGameObjectPairUnityEvent` -Event of type `ColliderGameObjectPair`. Inherits from `AtomEvent`. +None generic Unity Event of type `Collider2DGameObjectPair`. Inherits from `UnityEvent`. --- -## `CollisionGameObjectPairEvent` +## `Collider2DGameObjectUnityEvent` -Event of type `CollisionGameObjectPair`. Inherits from `AtomEvent`. +None generic Unity Event of type `Collider2DGameObject`. Inherits from `UnityEvent`. --- -## `Collision2DGameObjectPairEvent` +## `ColliderGameObjectPairUnityEvent` -Event of type `Collision2DGameObjectPair`. Inherits from `AtomEvent`. +None generic Unity Event of type `ColliderGameObjectPair`. Inherits from `UnityEvent`. --- -## `CollisionGameObjectEvent` +## `ColliderGameObjectUnityEvent` -Event of type `CollisionGameObject`. Inherits from `AtomEvent`. +None generic Unity Event of type `ColliderGameObject`. Inherits from `UnityEvent`. --- -## `ColliderGameObjectEvent` +## `Collision2DGameObjectPairUnityEvent` -Event of type `ColliderGameObject`. Inherits from `AtomEvent`. +None generic Unity Event of type `Collision2DGameObjectPair`. Inherits from `UnityEvent`. --- -## `Collider2DGameObjectEvent` +## `Collision2DGameObjectUnityEvent` -Event of type `Collider2DGameObject`. Inherits from `AtomEvent`. +None generic Unity Event of type `Collision2DGameObject`. Inherits from `UnityEvent`. --- -## `Collider2DGameObjectPairEvent` +## `CollisionGameObjectPairUnityEvent` -Event of type `Collider2DGameObjectPair`. Inherits from `AtomEvent`. +None generic Unity Event of type `CollisionGameObjectPair`. Inherits from `UnityEvent`. --- -## `Collision2DGameObjectEvent` +## `CollisionGameObjectUnityEvent` -Event of type `Collision2DGameObject`. Inherits from `AtomEvent`. - ---- - -## `ColliderGameObjectValueList` - -Value List of type `ColliderGameObject`. Inherits from `AtomValueList`. - ---- - -## `CollisionGameObjectValueList` - -Value List of type `CollisionGameObject`. Inherits from `AtomValueList`. - ---- - -## `Collision2DGameObjectValueList` - -Value List of type `Collision2DGameObject`. Inherits from `AtomValueList`. +None generic Unity Event of type `CollisionGameObject`. Inherits from `UnityEvent`. --- @@ -763,26 +721,68 @@ Value List of type `Collider2DGameObject`. Inherits from `AtomValueList`. +Value List of type `ColliderGameObject`. Inherits from `AtomValueList`. --- -## `SetCollider2DGameObjectVariableValue` +## `Collision2DGameObjectValueList` -Set variable value Action of type `Collider2DGameObject`. Inherits from `SetVariableValue`. +Value List of type `Collision2DGameObject`. Inherits from `AtomValueList`. --- -## `SetCollision2DGameObjectVariableValue` +## `CollisionGameObjectValueList` -Set variable value Action of type `Collision2DGameObject`. Inherits from `SetVariableValue`. +Value List of type `CollisionGameObject`. Inherits from `AtomValueList`. --- -## `SetColliderGameObjectVariableValue` +## `Collider2DGameObjectVariableInstancer` -Set variable value Action of type `ColliderGameObject`. Inherits from `SetVariableValue`. +Variable Instancer of type `Collider2DGameObject`. Inherits from `AtomVariableInstancer`. + +--- + +## `ColliderGameObjectVariableInstancer` + +Variable Instancer of type `ColliderGameObject`. Inherits from `AtomVariableInstancer`. + +--- + +## `Collision2DGameObjectVariableInstancer` + +Variable Instancer of type `Collision2DGameObject`. Inherits from `AtomVariableInstancer`. + +--- + +## `CollisionGameObjectVariableInstancer` + +Variable Instancer of type `CollisionGameObject`. Inherits from `AtomVariableInstancer`. + +--- + +## `Collider2DGameObjectVariable` + +Variable of type `Collider2DGameObject`. Inherits from `EquatableAtomVariable`. + +--- + +## `ColliderGameObjectVariable` + +Variable of type `ColliderGameObject`. Inherits from `EquatableAtomVariable`. + +--- + +## `Collision2DGameObjectVariable` + +Variable of type `Collision2DGameObject`. Inherits from `EquatableAtomVariable`. + +--- + +## `CollisionGameObjectVariable` + +Variable of type `CollisionGameObject`. Inherits from `EquatableAtomVariable`. --- diff --git a/docs/api/unityatoms.scenemgmt.editor.md b/docs/api/unityatoms.scenemgmt.editor.md index b179cb30..9e7118a5 100644 --- a/docs/api/unityatoms.scenemgmt.editor.md +++ b/docs/api/unityatoms.scenemgmt.editor.md @@ -13,9 +13,33 @@ Customer property drawer for `SceneField`. --- -## `SceneFieldVariableEditor` +## `SceneFieldConstantDrawer` -Variable Inspector of type `SceneField`. Inherits from `AtomVariableEditor` +Constant property drawer of type `SceneField`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `SceneFieldEventDrawer` + +Event property drawer of type `SceneField`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `SceneFieldPairEventDrawer` + +Event property drawer of type `SceneFieldPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `SceneFieldValueListDrawer` + +Value List property drawer of type `SceneField`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. + +--- + +## `SceneFieldVariableDrawer` + +Variable property drawer of type `SceneField`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. --- @@ -31,32 +55,8 @@ Event property drawer of type `SceneFieldPair`. Inherits from `AtomEventEditor`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `SceneFieldVariableDrawer` - -Variable property drawer of type `SceneField`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `SceneFieldPairEventDrawer` - -Event property drawer of type `SceneFieldPair`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `SceneFieldEventDrawer` - -Event property drawer of type `SceneField`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. - ---- - -## `SceneFieldValueListDrawer` - -Value List property drawer of type `SceneField`. Inherits from `AtomDrawer`. Only availble in `UNITY_2019_1_OR_NEWER`. +Variable Inspector of type `SceneField`. Inherits from `AtomVariableEditor` --- diff --git a/docs/api/unityatoms.scenemgmt.md b/docs/api/unityatoms.scenemgmt.md index 569e980f..307a4525 100644 --- a/docs/api/unityatoms.scenemgmt.md +++ b/docs/api/unityatoms.scenemgmt.md @@ -7,9 +7,75 @@ sidebar_label: UnityAtoms.SceneMgmt # Namespace - `UnityAtoms.SceneMgmt` -## `SceneFieldPairEventReferenceListener` +## `ChangeScene` -Event Reference Listener of type `SceneFieldPair`. Inherits from `AtomEventReferenceListener`. +Action to change scene. + +### Variables + +#### `_sceneName` + +Scene to change to. + +### Methods + +#### `Do` + +Change the scene. + +--- + +## `QuitApplication` + +Action to quit the application. + +### Methods + +#### `Do` + +Do quit the apllication. + +--- + +## `SceneFieldAction` + +Action of type `SceneField`. Inherits from `AtomAction`. + +--- + +## `SceneFieldPairAction` + +Action of type `SceneFieldPair`. Inherits from `AtomAction`. + +--- + +## `SetSceneFieldVariableValue` + +Set variable value Action of type `SceneField`. Inherits from `SetVariableValue`. + +--- + +## `SceneFieldCondition` + +Condition of type `SceneField`. Inherits from `AtomCondition`. + +--- + +## `SceneFieldConstant` + +Constant of type `SceneField`. Inherits from `AtomBaseVariable`. + +--- + +## `SceneFieldEventInstancer` + +Event Instancer of type `SceneField`. Inherits from `AtomEventInstancer`. + +--- + +## `SceneFieldPairEventInstancer` + +Event Instancer of type `SceneFieldPair`. Inherits from `AtomEventInstancer`. --- @@ -19,6 +85,60 @@ Event Reference Listener of type `SceneField`. Inherits from `AtomEventReference --- +## `SceneFieldPairEventReferenceListener` + +Event Reference Listener of type `SceneFieldPair`. Inherits from `AtomEventReferenceListener`. + +--- + +## `SceneFieldEventReference` + +Event Reference of type `SceneField`. Inherits from `AtomEventReference`. + +--- + +## `SceneFieldPairEventReference` + +Event Reference of type `SceneFieldPair`. Inherits from `AtomEventReference`. + +--- + +## `SceneFieldEvent` + +Event of type `SceneField`. Inherits from `AtomEvent`. + +--- + +## `SceneFieldPairEvent` + +Event of type `SceneFieldPair`. Inherits from `AtomEvent`. + +--- + +## `SceneFieldSceneFieldFunction` + +Function x 2 of type `SceneField`. Inherits from `AtomFunction`. + +--- + +## `SceneFieldPair` + +IPair of type ``. Inherits from `IPair`. + +--- + +## `SceneFieldReference` + +Reference of type `SceneField`. Inherits from `EquatableAtomReference`. + +--- + +## `SyncSceneFieldVariableInstancerToCollection` + +Adds Variable Instancer's Variable of type SceneField to a Collection or List on OnEnable and removes it on OnDestroy. + +--- + ## `SceneField` Struct to hold data about a scene. @@ -141,18 +261,6 @@ None equality operator. --- -## `SceneFieldReference` - -Reference of type `SceneField`. Inherits from `EquatableAtomReference`. - ---- - -## `SceneFieldPair` - -IPair of type ``. Inherits from `IPair`. - ---- - ## `SceneFieldPairUnityEvent` None generic Unity Event of type `SceneFieldPair`. Inherits from `UnityEvent`. @@ -171,21 +279,9 @@ None generic Unity Event of type `SceneField`. Inherits from `UnityEvent`. - ---- - -## `SceneFieldPairEventReference` - -Event Reference of type `SceneFieldPair`. Inherits from `AtomEventReference`. - ---- - -## `SceneFieldEventReference` - -Event Reference of type `SceneField`. Inherits from `AtomEventReference`. +Value List of type `SceneField`. Inherits from `AtomValueList`. --- @@ -195,104 +291,8 @@ Variable Instancer of type `SceneField`. Inherits from `AtomVariableInstancer`. - ---- - -## `SceneFieldPairEventInstancer` - -Event Instancer of type `SceneFieldPair`. Inherits from `AtomEventInstancer`. - ---- - ## `SceneFieldVariable` Variable of type `SceneField`. Inherits from `EquatableAtomVariable`. --- - -## `SceneFieldCondition` - -Condition of type `SceneField`. Inherits from `AtomCondition`. - ---- - -## `SceneFieldPairAction` - -Action of type `SceneFieldPair`. Inherits from `AtomAction`. - ---- - -## `QuitApplication` - -Action to quit the application. - -### Methods - -#### `Do` - -Do quit the apllication. - ---- - -## `ChangeScene` - -Action to change scene. - -### Variables - -#### `_sceneName` - -Scene to change to. - -### Methods - -#### `Do` - -Change the scene. - ---- - -## `SceneFieldAction` - -Action of type `SceneField`. Inherits from `AtomAction`. - ---- - -## `SceneFieldSceneFieldFunction` - -Function x 2 of type `SceneField`. Inherits from `AtomFunction`. - ---- - -## `SyncSceneFieldVariableInstancerToCollection` - -Adds Variable Instancer's Variable of type SceneField to a Collection or List on OnEnable and removes it on OnDestroy. - ---- - -## `SceneFieldPairEvent` - -Event of type `SceneFieldPair`. Inherits from `AtomEvent`. - ---- - -## `SceneFieldEvent` - -Event of type `SceneField`. Inherits from `AtomEvent`. - ---- - -## `SceneFieldValueList` - -Value List of type `SceneField`. Inherits from `AtomValueList`. - ---- - -## `SetSceneFieldVariableValue` - -Set variable value Action of type `SceneField`. Inherits from `SetVariableValue`. - ---- diff --git a/docs/api/unityatoms.tags.md b/docs/api/unityatoms.tags.md index c7297fef..5b4cdf95 100644 --- a/docs/api/unityatoms.tags.md +++ b/docs/api/unityatoms.tags.md @@ -7,150 +7,6 @@ sidebar_label: UnityAtoms.Tags # Namespace - `UnityAtoms.Tags` -## `ReadOnlyList` - -#### Type Parameters - -- `T` - The type of the list items. - -This is an `IList` without everything that could mutate the it. - -### Properties - -#### `Count` - -Get the number of elements contained in the `ReadOnlyList`. - -##### Examples - -```cs -var readOnlyList = new ReadOnlyList(new List() { 1, 2, 3 }); -Debug.Log(readOnlyList.Count); // Outputs: 3 -``` - ---- - -#### `IsReadOnly` - -Determines if the `ReadOnlyList` is read only or not. - ---- - -#### `Item(System.Int32)` - -Get the element at the specified index. - -### Methods - -#### `#ctor(list)` - -Creates a new class of the `ReadOnlyList` class. - -##### Parameters - -- `list` - The `IList` to initialize the `ReadOnlyList` with. - ---- - -#### `GetEnumerator` - -Implements `GetEnumerator()` of `IEnumerable` - -##### Returns - -The list's `IEnumerator`. - ---- - -#### `Contains(item)` - -Determines whether an element is in the `ReadOnlyList`. - -##### Parameters - -- `item` - The item to check if it exists in the `ReadOnlyList`. - -##### Returns - -`true` if item is found in the `ReadOnlyList`; otherwise, `false`. - ---- - -#### `IndexOf(item)` - -Searches for the specified object and returns the index of its first occurrence in a one-dimensional array. - -##### Parameters - -- `item` - The one-dimensional array to search. - -##### Returns - -The index of the first occurrence of value in array, if found; otherwise, the lower bound of the array minus 1. - ---- - -#### `CopyTo(array,arrayIndex)` - -Copies all the elements of the current one-dimensional array to the specified one-dimensional array starting at the specified destination array index. The index is specified as a 32-bit integer. - -##### Parameters - -- `array` - The one-dimensional array that is the destination of the elements copied from the current array. -- `arrayIndex` - A 32-bit integer that represents the index in array at which copying begins. - ---- - -## `GameObjectExtensions` - -`GameObject` extensions related to tags in Unity Atoms. - -### Methods - -#### `GetTags(UnityEngine.GameObject)` - -Retrieves all tags for a given `GameObject`. A faster alternative to `gameObject.GetComponen().Tags`. - -##### Parameters - -- `go` - This `GameObject` - -##### Returns - -A `ReadOnlyList` of tags stored as `StringContant`s. Returns `null` if the `GameObject` does not have any tags or if the `GameObject` is disabled. - ---- - -#### `HasTag(UnityEngine.GameObject,System.String)` - -Check if the tag provided is associated with this `GameObject`. - -##### Parameters - -- `go` - This `GameObject` -- `tag` - The tag to search for. - -##### Returns - -`true` if the tag exists, otherwise `false`. - ---- - -#### `HasAnyTag(UnityEngine.GameObject,System.Collections.Generic.List{System.String})` - -Check if any of the tags provided are associated with this `GameObject`. - -##### Parameters - -- `go` - This `GameObject` -- `tags` - The tags to search for. - -##### Returns - -`true` if any of the tags exist, otherwise `false`. - ---- - ## `AtomTags` A MonoBehaviour that adds tags the Unity Atoms way to a GameObject. @@ -249,3 +105,147 @@ Retrieves all tags for a given `GameObject`. A faster alternative to `gameObject A `ReadOnlyList` of tags stored as `StringContant`s. Returns `null` if the `GameObject` does not have any tags or if the `GameObject` is disabled. --- + +## `GameObjectExtensions` + +`GameObject` extensions related to tags in Unity Atoms. + +### Methods + +#### `GetTags(UnityEngine.GameObject)` + +Retrieves all tags for a given `GameObject`. A faster alternative to `gameObject.GetComponen().Tags`. + +##### Parameters + +- `go` - This `GameObject` + +##### Returns + +A `ReadOnlyList` of tags stored as `StringContant`s. Returns `null` if the `GameObject` does not have any tags or if the `GameObject` is disabled. + +--- + +#### `HasTag(UnityEngine.GameObject,System.String)` + +Check if the tag provided is associated with this `GameObject`. + +##### Parameters + +- `go` - This `GameObject` +- `tag` - The tag to search for. + +##### Returns + +`true` if the tag exists, otherwise `false`. + +--- + +#### `HasAnyTag(UnityEngine.GameObject,System.Collections.Generic.List{System.String})` + +Check if any of the tags provided are associated with this `GameObject`. + +##### Parameters + +- `go` - This `GameObject` +- `tags` - The tags to search for. + +##### Returns + +`true` if any of the tags exist, otherwise `false`. + +--- + +## `ReadOnlyList` + +#### Type Parameters + +- `T` - The type of the list items. + +This is an `IList` without everything that could mutate the it. + +### Properties + +#### `Count` + +Get the number of elements contained in the `ReadOnlyList`. + +##### Examples + +```cs +var readOnlyList = new ReadOnlyList(new List() { 1, 2, 3 }); +Debug.Log(readOnlyList.Count); // Outputs: 3 +``` + +--- + +#### `IsReadOnly` + +Determines if the `ReadOnlyList` is read only or not. + +--- + +#### `Item(System.Int32)` + +Get the element at the specified index. + +### Methods + +#### `#ctor(list)` + +Creates a new class of the `ReadOnlyList` class. + +##### Parameters + +- `list` - The `IList` to initialize the `ReadOnlyList` with. + +--- + +#### `GetEnumerator` + +Implements `GetEnumerator()` of `IEnumerable` + +##### Returns + +The list's `IEnumerator`. + +--- + +#### `Contains(item)` + +Determines whether an element is in the `ReadOnlyList`. + +##### Parameters + +- `item` - The item to check if it exists in the `ReadOnlyList`. + +##### Returns + +`true` if item is found in the `ReadOnlyList`; otherwise, `false`. + +--- + +#### `IndexOf(item)` + +Searches for the specified object and returns the index of its first occurrence in a one-dimensional array. + +##### Parameters + +- `item` - The one-dimensional array to search. + +##### Returns + +The index of the first occurrence of value in array, if found; otherwise, the lower bound of the array minus 1. + +--- + +#### `CopyTo(array,arrayIndex)` + +Copies all the elements of the current one-dimensional array to the specified one-dimensional array starting at the specified destination array index. The index is specified as a 32-bit integer. + +##### Parameters + +- `array` - The one-dimensional array that is the destination of the elements copied from the current array. +- `arrayIndex` - A 32-bit integer that represents the index in array at which copying begins. + +--- diff --git a/docs/introduction/installation.md b/docs/introduction/installation.md index 18a99cad..7b9b0e05 100644 --- a/docs/introduction/installation.md +++ b/docs/introduction/installation.md @@ -35,15 +35,15 @@ Add the following to your `manifest.json`: ], "dependencies": { ... - "com.unity-atoms.unity-atoms-core": "4.4.3", - "com.unity-atoms.unity-atoms-base-atoms": "4.4.3", - "com.unity-atoms.unity-atoms-fsm": "4.4.3", - "com.unity-atoms.unity-atoms-mobile": "4.4.3", - "com.unity-atoms.unity-atoms-mono-hooks": "4.4.3", - "com.unity-atoms.unity-atoms-tags": "4.4.3", - "com.unity-atoms.unity-atoms-scene-mgmt": "4.4.3", - "com.unity-atoms.unity-atoms-ui": "4.4.3", - "com.unity-atoms.unity-atoms-input-system": "4.4.3", + "com.unity-atoms.unity-atoms-core": "4.4.4", + "com.unity-atoms.unity-atoms-base-atoms": "4.4.4", + "com.unity-atoms.unity-atoms-fsm": "4.4.4", + "com.unity-atoms.unity-atoms-mobile": "4.4.4", + "com.unity-atoms.unity-atoms-mono-hooks": "4.4.4", + "com.unity-atoms.unity-atoms-tags": "4.4.4", + "com.unity-atoms.unity-atoms-scene-mgmt": "4.4.4", + "com.unity-atoms.unity-atoms-ui": "4.4.4", + "com.unity-atoms.unity-atoms-input-system": "4.4.4", ... } } diff --git a/package-lock.json b/package-lock.json index e8be2a58..63376f4c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,13 +1,618 @@ { - "name": "com.mambojambostudios.unity-atoms", - "version": "4.3.0", - "lockfileVersion": 1, + "name": "com.unity-atoms.unity-atoms", + "version": "4.4.4", + "lockfileVersion": 2, "requires": true, + "packages": { + "": { + "name": "com.unity-atoms.unity-atoms", + "version": "4.4.4", + "devDependencies": { + "rimraf": "^3.0.0", + "xml2js": "^0.4.22", + "yargs": "^14.2.0" + } + }, + "node_modules/ansi-regex": { + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.1.tgz", + "integrity": "sha512-ILlv4k/3f6vfQ4OoP2AGvirOktlQ98ZEL1k9FaQjxa3L1abBgbuTDAdPOpvbGncC0BTVQrl+OM8xZGK6tWXt7g==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/ansi-styles": { + "version": "3.2.1", + "resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz", + "integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==", + "dev": true, + "dependencies": { + "color-convert": "^1.9.0" + }, + "engines": { + "node": ">=4" + } + }, + "node_modules/balanced-match": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/balanced-match/-/balanced-match-1.0.0.tgz", + "integrity": "sha1-ibTRmasr7kneFk6gK4nORi1xt2c=", + "dev": true + }, + "node_modules/brace-expansion": { + "version": "1.1.11", + "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", + "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", + "dev": true, + "dependencies": { + "balanced-match": "^1.0.0", + "concat-map": "0.0.1" + } + }, + "node_modules/camelcase": { + "version": "5.3.1", + "resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.3.1.tgz", + "integrity": "sha512-L28STB170nwWS63UjtlEOE3dldQApaJXZkOI1uMFfzf3rRuPegHaHesyee+YxQ+W6SvRDQV6UrdOdRiR153wJg==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/cliui": { + "version": "5.0.0", + "resolved": "https://registry.npmjs.org/cliui/-/cliui-5.0.0.tgz", + "integrity": "sha512-PYeGSEmmHM6zvoef2w8TPzlrnNpXIjTipYK780YswmIP9vjxmd6Y2a3CB2Ks6/AU8NHjZugXvo8w3oWM2qnwXA==", + "dev": true, + "dependencies": { + "string-width": "^3.1.0", + "strip-ansi": "^5.2.0", + "wrap-ansi": "^5.1.0" + } + }, + "node_modules/color-convert": { + "version": "1.9.3", + "resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz", + "integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==", + "dev": true, + "dependencies": { + "color-name": "1.1.3" + } + }, + "node_modules/color-name": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz", + "integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=", + "dev": true + }, + "node_modules/concat-map": { + "version": "0.0.1", + "resolved": "https://registry.npmjs.org/concat-map/-/concat-map-0.0.1.tgz", + "integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=", + "dev": true + }, + "node_modules/decamelize": { + "version": "1.2.0", + "resolved": "https://registry.npmjs.org/decamelize/-/decamelize-1.2.0.tgz", + "integrity": "sha1-9lNNFRSCabIDUue+4m9QH5oZEpA=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/define-properties": { + "version": "1.1.3", + "resolved": "https://registry.npmjs.org/define-properties/-/define-properties-1.1.3.tgz", + "integrity": "sha512-3MqfYKj2lLzdMSf8ZIZE/V+Zuy+BgD6f164e8K2w7dgnpKArBDerGYpM46IYYcjnkdPNMjPk9A6VFB8+3SKlXQ==", + "dev": true, + "dependencies": { + "object-keys": "^1.0.12" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/emoji-regex": { + "version": "7.0.3", + "resolved": "https://registry.npmjs.org/emoji-regex/-/emoji-regex-7.0.3.tgz", + "integrity": "sha512-CwBLREIQ7LvYFB0WyRvwhq5N5qPhc6PMjD6bYggFlI5YyDgl+0vxq5VHbMOFqLg7hfWzmu8T5Z1QofhmTIhItA==", + "dev": true + }, + "node_modules/es-abstract": { + "version": "1.16.2", + "resolved": "https://registry.npmjs.org/es-abstract/-/es-abstract-1.16.2.tgz", + "integrity": "sha512-jYo/J8XU2emLXl3OLwfwtuFfuF2w6DYPs+xy9ZfVyPkDcrauu6LYrw/q2TyCtrbc/KUdCiC5e9UajRhgNkVopA==", + "dev": true, + "dependencies": { + "es-to-primitive": "^1.2.1", + "function-bind": "^1.1.1", + "has": "^1.0.3", + "has-symbols": "^1.0.1", + "is-callable": "^1.1.4", + "is-regex": "^1.0.4", + "object-inspect": "^1.7.0", + "object-keys": "^1.1.1", + "string.prototype.trimleft": "^2.1.0", + "string.prototype.trimright": "^2.1.0" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/es-to-primitive": { + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/es-to-primitive/-/es-to-primitive-1.2.1.tgz", + "integrity": "sha512-QCOllgZJtaUo9miYBcLChTUaHNjJF3PYs1VidD7AwiEj1kYxKeQTctLAezAOH5ZKRH0g2IgPn6KwB4IT8iRpvA==", + "dev": true, + "dependencies": { + "is-callable": "^1.1.4", + "is-date-object": "^1.0.1", + "is-symbol": "^1.0.2" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/find-up": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/find-up/-/find-up-3.0.0.tgz", + "integrity": "sha512-1yD6RmLI1XBfxugvORwlck6f75tYL+iR0jqwsOrOxMZyGYqUuDhJ0l4AXdO1iX/FTs9cBAMEk1gWSEx1kSbylg==", + "dev": true, + "dependencies": { + "locate-path": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/fs.realpath": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz", + "integrity": "sha1-FQStJSMVjKpA20onh8sBQRmU6k8=", + "dev": true + }, + "node_modules/function-bind": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/function-bind/-/function-bind-1.1.1.tgz", + "integrity": "sha512-yIovAzMX49sF8Yl58fSCWJ5svSLuaibPxXQJFLmBObTuCr0Mf1KiPopGM9NiFjiYBCbfaa2Fh6breQ6ANVTI0A==", + "dev": true + }, + "node_modules/get-caller-file": { + "version": "2.0.5", + "resolved": "https://registry.npmjs.org/get-caller-file/-/get-caller-file-2.0.5.tgz", + "integrity": "sha512-DyFP3BM/3YHTQOCUL/w0OZHR0lpKeGrxotcHWcqNEdnltqFwXVfhEBQ94eIo34AfQpo0rGki4cyIiftY06h2Fg==", + "dev": true, + "engines": { + "node": "6.* || 8.* || >= 10.*" + } + }, + "node_modules/glob": { + "version": "7.1.6", + "resolved": "https://registry.npmjs.org/glob/-/glob-7.1.6.tgz", + "integrity": "sha512-LwaxwyZ72Lk7vZINtNNrywX0ZuLyStrdDtabefZKAY5ZGJhVtgdznluResxNmPitE0SAO+O26sWTHeKSI2wMBA==", + "dev": true, + "dependencies": { + "fs.realpath": "^1.0.0", + "inflight": "^1.0.4", + "inherits": "2", + "minimatch": "^3.0.4", + "once": "^1.3.0", + "path-is-absolute": "^1.0.0" + }, + "engines": { + "node": "*" + }, + "funding": { + "url": "https://github.com/sponsors/isaacs" + } + }, + "node_modules/has": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/has/-/has-1.0.3.tgz", + "integrity": "sha512-f2dvO0VU6Oej7RkWJGrehjbzMAjFp5/VKPp5tTpWIV4JHHZK1/BxbFRtf/siA2SWTe09caDmVtYYzWEIbBS4zw==", + "dev": true, + "dependencies": { + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4.0" + } + }, + "node_modules/has-symbols": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/has-symbols/-/has-symbols-1.0.1.tgz", + "integrity": "sha512-PLcsoqu++dmEIZB+6totNFKq/7Do+Z0u4oT0zKOJNl3lYK6vGwwu2hjHs+68OEZbTjiUE9bgOABXbP/GvrS0Kg==", + "dev": true, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/inflight": { + "version": "1.0.6", + "resolved": "https://registry.npmjs.org/inflight/-/inflight-1.0.6.tgz", + "integrity": "sha1-Sb1jMdfQLQwJvJEKEHW6gWW1bfk=", + "dev": true, + "dependencies": { + "once": "^1.3.0", + "wrappy": "1" + } + }, + "node_modules/inherits": { + "version": "2.0.4", + "resolved": "https://registry.npmjs.org/inherits/-/inherits-2.0.4.tgz", + "integrity": "sha512-k/vGaX4/Yla3WzyMCvTQOXYeIHvqOKtnqBduzTHpzpQZzAskKMhZ2K+EnBiSM9zGSoIFeMpXKxa4dYeZIQqewQ==", + "dev": true + }, + "node_modules/is-callable": { + "version": "1.1.4", + "resolved": "https://registry.npmjs.org/is-callable/-/is-callable-1.1.4.tgz", + "integrity": "sha512-r5p9sxJjYnArLjObpjA4xu5EKI3CuKHkJXMhT7kwbpUyIFD1n5PMAsoPvWnvtZiNz7LjkYDRZhd7FlI0eMijEA==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-date-object": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/is-date-object/-/is-date-object-1.0.1.tgz", + "integrity": "sha1-mqIOtq7rv/d/vTPnTKAbM1gdOhY=", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-fullwidth-code-point": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/is-fullwidth-code-point/-/is-fullwidth-code-point-2.0.0.tgz", + "integrity": "sha1-o7MKXE8ZkYMWeqq5O+764937ZU8=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/is-regex": { + "version": "1.0.4", + "resolved": "https://registry.npmjs.org/is-regex/-/is-regex-1.0.4.tgz", + "integrity": "sha1-VRdIm1RwkbCTDglWVM7SXul+lJE=", + "dev": true, + "dependencies": { + "has": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/is-symbol": { + "version": "1.0.3", + "resolved": "https://registry.npmjs.org/is-symbol/-/is-symbol-1.0.3.tgz", + "integrity": "sha512-OwijhaRSgqvhm/0ZdAcXNZt9lYdKFpcRDT5ULUuYXPoT794UNOdU+gpT6Rzo7b4V2HUl/op6GqY894AZwv9faQ==", + "dev": true, + "dependencies": { + "has-symbols": "^1.0.1" + }, + "engines": { + "node": ">= 0.4" + }, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/locate-path": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/locate-path/-/locate-path-3.0.0.tgz", + "integrity": "sha512-7AO748wWnIhNqAuaty2ZWHkQHRSNfPVIsPIfwEOWO22AmaoVrWavlOcMR5nzTLNYvp36X220/maaRsrec1G65A==", + "dev": true, + "dependencies": { + "p-locate": "^3.0.0", + "path-exists": "^3.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/minimatch": { + "version": "3.0.4", + "resolved": "https://registry.npmjs.org/minimatch/-/minimatch-3.0.4.tgz", + "integrity": "sha512-yJHVQEhyqPLUTgt9B83PXu6W3rx4MvvHvSUvToogpwoGDOUQ+yDrR0HRot+yOCdCO7u4hX3pWft6kWBBcqh0UA==", + "dev": true, + "dependencies": { + "brace-expansion": "^1.1.7" + }, + "engines": { + "node": "*" + } + }, + "node_modules/object-inspect": { + "version": "1.7.0", + "resolved": "https://registry.npmjs.org/object-inspect/-/object-inspect-1.7.0.tgz", + "integrity": "sha512-a7pEHdh1xKIAgTySUGgLMx/xwDZskN1Ud6egYYN3EdRW4ZMPNEDUTF+hwy2LUC+Bl+SyLXANnwz/jyh/qutKUw==", + "dev": true, + "funding": { + "url": "https://github.com/sponsors/ljharb" + } + }, + "node_modules/object-keys": { + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.1.1.tgz", + "integrity": "sha512-NuAESUOUMrlIXOfHKzD6bpPu3tYt3xvjNdRIQ+FeT0lNb4K8WR70CaDxhuNguS2XG+GjkyMwOzsN5ZktImfhLA==", + "dev": true, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/object.getownpropertydescriptors": { + "version": "2.0.3", + "resolved": "https://registry.npmjs.org/object.getownpropertydescriptors/-/object.getownpropertydescriptors-2.0.3.tgz", + "integrity": "sha1-h1jIRvW0B62rDyNuCYbxSwUcqhY=", + "dev": true, + "dependencies": { + "define-properties": "^1.1.2", + "es-abstract": "^1.5.1" + }, + "engines": { + "node": ">= 0.8" + } + }, + "node_modules/once": { + "version": "1.4.0", + "resolved": "https://registry.npmjs.org/once/-/once-1.4.0.tgz", + "integrity": "sha1-WDsap3WWHUsROsF9nFC6753Xa9E=", + "dev": true, + "dependencies": { + "wrappy": "1" + } + }, + "node_modules/p-limit": { + "version": "2.2.1", + "resolved": "https://registry.npmjs.org/p-limit/-/p-limit-2.2.1.tgz", + "integrity": "sha512-85Tk+90UCVWvbDavCLKPOLC9vvY8OwEX/RtKF+/1OADJMVlFfEHOiMTPVyxg7mk/dKa+ipdHm0OUkTvCpMTuwg==", + "dev": true, + "dependencies": { + "p-try": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/p-locate": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/p-locate/-/p-locate-3.0.0.tgz", + "integrity": "sha512-x+12w/To+4GFfgJhBEpiDcLozRJGegY+Ei7/z0tSLkMmxGZNybVMSfWj9aJn8Z5Fc7dBUNJOOVgPv2H7IwulSQ==", + "dev": true, + "dependencies": { + "p-limit": "^2.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/p-try": { + "version": "2.2.0", + "resolved": "https://registry.npmjs.org/p-try/-/p-try-2.2.0.tgz", + "integrity": "sha512-R4nPAVTAU0B9D35/Gk3uJf/7XYbQcyohSKdvAxIRSNghFl4e71hVoGnBNQz9cWaXxO2I10KTC+3jMdvvoKw6dQ==", + "dev": true, + "engines": { + "node": ">=6" + } + }, + "node_modules/path-exists": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/path-exists/-/path-exists-3.0.0.tgz", + "integrity": "sha1-zg6+ql94yxiSXqfYENe1mwEP1RU=", + "dev": true, + "engines": { + "node": ">=4" + } + }, + "node_modules/path-is-absolute": { + "version": "1.0.1", + "resolved": "https://registry.npmjs.org/path-is-absolute/-/path-is-absolute-1.0.1.tgz", + "integrity": "sha1-F0uSaHNVNP+8es5r9TpanhtcX18=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-directory": { + "version": "2.1.1", + "resolved": "https://registry.npmjs.org/require-directory/-/require-directory-2.1.1.tgz", + "integrity": "sha1-jGStX9MNqxyXbiNE/+f3kqam30I=", + "dev": true, + "engines": { + "node": ">=0.10.0" + } + }, + "node_modules/require-main-filename": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/require-main-filename/-/require-main-filename-2.0.0.tgz", + "integrity": "sha512-NKN5kMDylKuldxYLSUfrbo5Tuzh4hd+2E8NPPX02mZtn1VuREQToYe/ZdlJy+J3uCpfaiGF05e7B8W0iXbQHmg==", + "dev": true + }, + "node_modules/rimraf": { + "version": "3.0.0", + "resolved": "https://registry.npmjs.org/rimraf/-/rimraf-3.0.0.tgz", + "integrity": "sha512-NDGVxTsjqfunkds7CqsOiEnxln4Bo7Nddl3XhS4pXg5OzwkLqJ971ZVAAnB+DDLnF76N+VnDEiBHaVV8I06SUg==", + "dev": true, + "dependencies": { + "glob": "^7.1.3" + }, + "bin": { + "rimraf": "bin.js" + } + }, + "node_modules/sax": { + "version": "1.2.4", + "resolved": "https://registry.npmjs.org/sax/-/sax-1.2.4.tgz", + "integrity": "sha512-NqVDv9TpANUjFm0N8uM5GxL36UgKi9/atZw+x7YFnQ8ckwFGKrl4xX4yWtrey3UJm5nP1kUbnYgLopqWNSRhWw==", + "dev": true + }, + "node_modules/set-blocking": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/set-blocking/-/set-blocking-2.0.0.tgz", + "integrity": "sha1-BF+XgtARrppoA93TgrJDkrPYkPc=", + "dev": true + }, + "node_modules/string-width": { + "version": "3.1.0", + "resolved": "https://registry.npmjs.org/string-width/-/string-width-3.1.0.tgz", + "integrity": "sha512-vafcv6KjVZKSgz06oM/H6GDBrAtz8vdhQakGjFIvNrHA6y3HCF1CInLy+QLq8dTJPQ1b+KDUqDFctkdRW44e1w==", + "dev": true, + "dependencies": { + "emoji-regex": "^7.0.1", + "is-fullwidth-code-point": "^2.0.0", + "strip-ansi": "^5.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/string.prototype.trimleft": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/string.prototype.trimleft/-/string.prototype.trimleft-2.1.0.tgz", + "integrity": "sha512-FJ6b7EgdKxxbDxc79cOlok6Afd++TTs5szo+zJTUyow3ycrRfJVE2pq3vcN53XexvKZu/DJMDfeI/qMiZTrjTw==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/string.prototype.trimright": { + "version": "2.1.0", + "resolved": "https://registry.npmjs.org/string.prototype.trimright/-/string.prototype.trimright-2.1.0.tgz", + "integrity": "sha512-fXZTSV55dNBwv16uw+hh5jkghxSnc5oHq+5K/gXgizHwAvMetdAJlHqqoFC1FSDVPYWLkAKl2cxpUT41sV7nSg==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.3", + "function-bind": "^1.1.1" + }, + "engines": { + "node": ">= 0.4" + } + }, + "node_modules/strip-ansi": { + "version": "5.2.0", + "resolved": "https://registry.npmjs.org/strip-ansi/-/strip-ansi-5.2.0.tgz", + "integrity": "sha512-DuRs1gKbBqsMKIZlrffwlug8MHkcnpjs5VPmL1PAh+mA30U0DTotfDZ0d2UUsXpPmPmMMJ6W773MaA3J+lbiWA==", + "dev": true, + "dependencies": { + "ansi-regex": "^4.1.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/util.promisify": { + "version": "1.0.0", + "resolved": "https://registry.npmjs.org/util.promisify/-/util.promisify-1.0.0.tgz", + "integrity": "sha512-i+6qA2MPhvoKLuxnJNpXAGhg7HphQOSUq2LKMZD0m15EiskXUkMvKdF4Uui0WYeCUGea+o2cw/ZuwehtfsrNkA==", + "dev": true, + "dependencies": { + "define-properties": "^1.1.2", + "object.getownpropertydescriptors": "^2.0.3" + } + }, + "node_modules/which-module": { + "version": "2.0.0", + "resolved": "https://registry.npmjs.org/which-module/-/which-module-2.0.0.tgz", + "integrity": "sha1-2e8H3Od7mQK4o6j6SzHD4/fm6Ho=", + "dev": true + }, + "node_modules/wrap-ansi": { + "version": "5.1.0", + "resolved": "https://registry.npmjs.org/wrap-ansi/-/wrap-ansi-5.1.0.tgz", + "integrity": "sha512-QC1/iN/2/RPVJ5jYK8BGttj5z83LmSKmvbvrXPNCLZSEb32KKVDJDl/MOt2N01qU2H/FkzEa9PKto1BqDjtd7Q==", + "dev": true, + "dependencies": { + "ansi-styles": "^3.2.0", + "string-width": "^3.0.0", + "strip-ansi": "^5.0.0" + }, + "engines": { + "node": ">=6" + } + }, + "node_modules/wrappy": { + "version": "1.0.2", + "resolved": "https://registry.npmjs.org/wrappy/-/wrappy-1.0.2.tgz", + "integrity": "sha1-tSQ9jz7BqjXxNkYFvA0QNuMKtp8=", + "dev": true + }, + "node_modules/xml2js": { + "version": "0.4.22", + "resolved": "https://registry.npmjs.org/xml2js/-/xml2js-0.4.22.tgz", + "integrity": "sha512-MWTbxAQqclRSTnehWWe5nMKzI3VmJ8ltiJEco8akcC6j3miOhjjfzKum5sId+CWhfxdOs/1xauYr8/ZDBtQiRw==", + "dev": true, + "dependencies": { + "sax": ">=0.6.0", + "util.promisify": "~1.0.0", + "xmlbuilder": "~11.0.0" + }, + "engines": { + "node": ">=4.0.0" + } + }, + "node_modules/xmlbuilder": { + "version": "11.0.1", + "resolved": "https://registry.npmjs.org/xmlbuilder/-/xmlbuilder-11.0.1.tgz", + "integrity": "sha512-fDlsI/kFEx7gLvbecc0/ohLG50fugQp8ryHzMTuW9vSa1GJ0XYWKnhsUx7oie3G98+r56aTQIUB4kht42R3JvA==", + "dev": true, + "engines": { + "node": ">=4.0" + } + }, + "node_modules/y18n": { + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", + "dev": true + }, + "node_modules/yargs": { + "version": "14.2.3", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-14.2.3.tgz", + "integrity": "sha512-ZbotRWhF+lkjijC/VhmOT9wSgyBQ7+zr13+YLkhfsSiTriYsMzkTUFP18pFhWwBeMa5gUc1MzbhrO6/VB7c9Xg==", + "dev": true, + "dependencies": { + "cliui": "^5.0.0", + "decamelize": "^1.2.0", + "find-up": "^3.0.0", + "get-caller-file": "^2.0.1", + "require-directory": "^2.1.1", + "require-main-filename": "^2.0.0", + "set-blocking": "^2.0.0", + "string-width": "^3.0.0", + "which-module": "^2.0.0", + "y18n": "^4.0.0", + "yargs-parser": "^15.0.1" + } + }, + "node_modules/yargs-parser": { + "version": "15.0.1", + "resolved": "https://registry.npmjs.org/yargs-parser/-/yargs-parser-15.0.1.tgz", + "integrity": "sha512-0OAMV2mAZQrs3FkNpDQcBk1x5HXb8X4twADss4S0Iuk+2dGnLOE/fRHrsYm542GduMveyA77OF4wrNJuanRCWw==", + "dev": true, + "dependencies": { + "camelcase": "^5.0.0", + "decamelize": "^1.2.0" + } + } + }, "dependencies": { "ansi-regex": { - "version": "4.1.0", - "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.0.tgz", - "integrity": "sha512-1apePfXM1UOSqw0o9IiFAovVz9M5S1Dg+4TrDwfMewQ6p/rmMueb7tWZjQ1rx4Loy1ArBggoqGpfqqdI4rondg==", + "version": "4.1.1", + "resolved": "https://registry.npmjs.org/ansi-regex/-/ansi-regex-4.1.1.tgz", + "integrity": "sha512-ILlv4k/3f6vfQ4OoP2AGvirOktlQ98ZEL1k9FaQjxa3L1abBgbuTDAdPOpvbGncC0BTVQrl+OM8xZGK6tWXt7g==", "dev": true }, "ansi-styles": { @@ -441,15 +1046,15 @@ "dev": true }, "y18n": { - "version": "4.0.0", - "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.0.tgz", - "integrity": "sha512-r9S/ZyXu/Xu9q1tYlpsLIsa3EeLXXk0VwlxqTcFRfg9EhMW+17kbt9G0NrgCmhGb5vT2hyhJZLfDGx+7+5Uj/w==", + "version": "4.0.3", + "resolved": "https://registry.npmjs.org/y18n/-/y18n-4.0.3.tgz", + "integrity": "sha512-JKhqTOwSrqNA1NY5lSztJ1GrBiUodLMmIZuLiDaMRJ+itFd+ABVE8XBjOvIWL+rSqNDC74LCSFmlb/U4UZ4hJQ==", "dev": true }, "yargs": { - "version": "14.2.2", - "resolved": "https://registry.npmjs.org/yargs/-/yargs-14.2.2.tgz", - "integrity": "sha512-/4ld+4VV5RnrynMhPZJ/ZpOCGSCeghMykZ3BhdFBDa9Wy/RH6uEGNWDJog+aUlq+9OM1CFTgtYRW5Is1Po9NOA==", + "version": "14.2.3", + "resolved": "https://registry.npmjs.org/yargs/-/yargs-14.2.3.tgz", + "integrity": "sha512-ZbotRWhF+lkjijC/VhmOT9wSgyBQ7+zr13+YLkhfsSiTriYsMzkTUFP18pFhWwBeMa5gUc1MzbhrO6/VB7c9Xg==", "dev": true, "requires": { "cliui": "^5.0.0", @@ -462,7 +1067,7 @@ "string-width": "^3.0.0", "which-module": "^2.0.0", "y18n": "^4.0.0", - "yargs-parser": "^15.0.0" + "yargs-parser": "^15.0.1" } }, "yargs-parser": { diff --git a/package.json b/package.json index 36f57e06..7d9bff51 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,7 @@ { "name": "com.unity-atoms.unity-atoms", "displayName": "Unity Atoms", - "version": "4.4.3", + "version": "4.4.4", "publishConfig": { "registry": "https://npm.pkg.github.com/" },