mirror of
https://github.com/unity-atoms/unity-atoms.git
synced 2025-01-22 08:08:51 -05:00
Docs added
This commit is contained in:
parent
48ca635af7
commit
24831f5927
@ -3,6 +3,11 @@ using UnityEngine;
|
||||
|
||||
namespace UnityAtoms.BaseAtoms
|
||||
{
|
||||
/// <summary>
|
||||
/// Creates an in memory copy of a Collection using a base.
|
||||
/// </summary>
|
||||
/// <typeparam name="T"></typeparam>
|
||||
/// <typeparam name="V"></typeparam>
|
||||
[EditorIcon("atom-icon-hotpink")]
|
||||
[DefaultExecutionOrder(Runtime.ExecutionOrder.VARIABLE_INSTANCER)]
|
||||
public abstract class AtomBaseCollectionInstancer<T, V> : AtomBaseVariableInstancer<T, V>
|
||||
|
@ -8,7 +8,8 @@ namespace UnityAtoms
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The type of the Variable to set.</typeparam>
|
||||
/// <typeparam name="P">A IPair of type T.</typeparam>
|
||||
/// <typeparam name="C">A Constant class of type `T` to set.</typeparam>
|
||||
/// <typeparam name="V">A Variable class of type `T` to set.</typeparam>
|
||||
/// <typeparam name="C">A Constant class of type `T`.</typeparam>
|
||||
/// <typeparam name="R">A Reference of type `T`.</typeparam>
|
||||
/// <typeparam name="E1">An Event of type `T`.</typeparam>
|
||||
/// <typeparam name="E2">An Event x 2 of type `T`.</typeparam>
|
||||
@ -31,7 +32,7 @@ namespace UnityAtoms
|
||||
private V _variable = null;
|
||||
|
||||
/// <summary>
|
||||
/// The value to set.
|
||||
/// The value to use.
|
||||
/// </summary>
|
||||
[SerializeField]
|
||||
private R _value = null;
|
||||
|
@ -3,6 +3,9 @@ using UnityEngine;
|
||||
|
||||
namespace UnityAtoms
|
||||
{
|
||||
/// <summary>
|
||||
/// Resets all the Variables in the list on OnEnable. Note that this will cause Events on the Variables to be triggered.
|
||||
/// </summary>
|
||||
[AddComponentMenu("Unity Atoms/MonoBehaviour Helpers/Variable Resetter")]
|
||||
[DefaultExecutionOrder(Runtime.ExecutionOrder.VARIABLE_RESETTER)]
|
||||
[EditorIcon("atom-icon-delicate")]
|
||||
|
@ -16,6 +16,9 @@
|
||||
public const string LOG_PREFIX = "UnityAtoms :: ";
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
/// Constants for defining DefaultExecutionOrder.
|
||||
/// </summary>
|
||||
public static class ExecutionOrder
|
||||
{
|
||||
public const int VARIABLE_RESETTER = -200;
|
||||
|
@ -2,6 +2,14 @@ using System;
|
||||
|
||||
namespace UnityAtoms
|
||||
{
|
||||
/// <summary>
|
||||
/// Atom Variable base class for types that are implementing `IEquatable<T>`.
|
||||
/// </summary>
|
||||
/// <typeparam name="T">The Variable type.</typeparam>
|
||||
/// <typeparam name="P">Pair of type T.</typeparam>
|
||||
/// <typeparam name="E1">Event of type T.</typeparam>
|
||||
/// <typeparam name="E2">Pair event of type T.</typeparam>
|
||||
/// <typeparam name="F">Function of type T and T.</typeparam>
|
||||
[EditorIcon("atom-icon-lush")]
|
||||
public abstract class EquatableAtomVariable<T, P, E1, E2, F> : AtomVariable<T, P, E1, E2, F>
|
||||
where T : IEquatable<T>
|
||||
|
Loading…
Reference in New Issue
Block a user