caleb-brown/unity-atoms
1
0
Fork 0
mirror of https://github.com/unity-atoms/unity-atoms.git synced 2025-01-22 16:18:24 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity
cf23583293
unity-atoms/docs/api/unityatoms.md

912 lines
14 KiB
Markdown
Raw Normal View History

Generate docs - document tags
2019-10-14 20:08:41 -04:00
---
id: unityatoms
title: UnityAtoms
hide_title: true
sidebar_label: UnityAtoms
---
# Namespace - `UnityAtoms`
Create documentation WIP
2019-10-15 13:19:44 -04:00
## `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.
---
## `AtomAction<T1>`
#### Type Parameters
- `T1` - The type for this Action.
Generic abstract base class for Actions. Inherits from `BaseAtom`.
Document Core WIP
2019-10-15 14:44:25 -04:00
### Variables
#### `Action`
The actual Action.
### Methods
#### `Do(t1)`
Perform the Action.
##### Parameters
- `t1` - The first parameter.
---
## `AtomAction<T1,T2>`
#### Type Parameters
- `T1` - The first type for this Action.
- `T2` - The second type for this Action.
Generic abstract base class for Actions. Inherits from `BaseAtom`.
### Variables
#### `Action`
The actual Action.
### Methods
#### `Do(t1,t2)`
Perform the Action.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
---
## `AtomAction<T1,T2,T3>`
#### Type Parameters
- `T1` - The first type for this Action.
- `T2` - The second type for this Action.
- `T3` - The third type for this Action.
Generic abstract base class for Actions. Inherits from `BaseAtom`.
### Variables
#### `Action`
The actual Action.
### Methods
#### `Do(t1,t2,t3)`
Perform the Action.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
- `t3` - The third parameter.
---
## `AtomAction<T1,T2,T3,T4>`
#### Type Parameters
- `T1` - The first type for this Action.
- `T2` - The second type for this Action.
- `T3` - The third type for this Action.
- `T4` - The fourth type for this Action.
Generic abstract base class for Actions. Inherits from `BaseAtom`.
### Variables
#### `Action`
The actual Action.
### Methods
#### `Do(t1,t2,t3,t4)`
Perform the Action.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
- `t3` - The third parameter.
- `t4` - The fourth parameter.
---
## `AtomAction<T1,T2,T3,T4,T5>`
#### Type Parameters
- `T1` - The first type for this Action.
- `T2` - The second type for this Action.
- `T3` - The third type for this Action.
- `T4` - The fourth type for this Action.
- `T5` - The fifth type for this Action.
Generic abstract base class for Actions. Inherits from `BaseAtom`.
### Variables
#### `Action`
The actual Action.
### Methods
#### `Do(t1,t2,t3,t4,t5)`
Perform the Action.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
- `t3` - The third parameter.
- `t4` - The fourth parameter.
- `t5` - The fifth parameter.
---
## `VoidAction`
Action of type Void. Inherits from `AtomAction<Void>`.
### Methods
#### `Do(UnityAtoms.Void)`
Do the Action.
##### Parameters
- `_` - Dummy Void parameter.
---
#### `Do`
Do the Action.
---
## `SetVariableValue<T,V,R,E1,E2>`
#### Type Parameters
- `T` - The type of the Variable to set.
- `V` - A Variable class of type `type` to set.
- `R` - A Reference of type `type`.
- `E1` - An Event of type `type`.
- `E2` - An Event x 2 of type `type`.
Base class for all SetVariableValue Actions. Inherits from `VoidAction`.
### Variables
#### `_variable`
The Variable to set.
---
#### `_value`
The value to set.
### Methods
#### `Do`
Perform the action.
Create documentation WIP
2019-10-15 13:19:44 -04:00
---
Generate docs - document tags
2019-10-14 20:08:41 -04:00
## `EditorIcon`
Specify a texture name from your assets which you want to be assigned as an icon to the MonoScript.
---
Create documentation WIP
2019-10-15 13:19:44 -04:00
Generate docs - document tags
2019-10-14 20:08:41 -04:00
## `BaseAtom`
Document Core WIP
2019-10-15 14:44:25 -04:00
None generic base class for all atoms.
### Variables
#### `_developerDescription`
A description of the Atom made for developers to document their Atoms.
---
## `AtomEvent`
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.
---
#### `Unregister(System.Action)`
Unregister handler that was registered using the `Register` method.
##### Parameters
- `del` - The handler.
---
## `AtomEvent<T>`
#### Type Parameters
- `T` - The type for this Event.
Generic base class for Events. Inherits from `AtomEvent`.
### Methods
#### `Raise(item)`
Raise the Event.
##### Parameters
- `item` - The value associated with the Event.
---
#### `Register(del)`
Register handler to be called when the Event triggers.
##### Parameters
- `del` - The handler.
---
#### `Unregister(del)`
Unregister handler that was registered using the `Register` method.
##### Parameters
- `del` - The handler.
---
#### `RegisterListener(listener)`
Register a Listener that in turn trigger all its associated handlers when the Event triggers.
##### Parameters
- `listener` - The Listenr to register.
---
#### `UnregisterListener(listener)`
Unregister a listener that was registered using the `RegisterListener` method.
##### Parameters
- `listener` - The Listenr to unregister.
---
#### `Observe`
Turn the Event into an `IObservable<T>`. Makes Events compatible with for example UniRx.
##### Returns
The Event as an `IObservable<T>`.
---
## `AtomEvent<T1,T2>`
#### Type Parameters
- `T1` - The first type for this Event.
- `T2` - The second type for this Event.
Generic base class for Events. Inherits from `AtomEvent`.
### Methods
#### `Raise(item1,item2)`
Raise the Event.
##### Parameters
- `item1` - The first value associated with the Event.
- `item2` - The second value associated with the Event.
---
#### `Register(del)`
Register handler to be called when the Event triggers.
##### Parameters
- `del` - The handler.
---
#### `Unregister(del)`
Unregister handler that was registered using the `Register` method.
##### Parameters
- `del` - The handler.
---
#### `RegisterListener(listener)`
Register a Listener that in turn trigger all its associated handlers when the Event triggers.
##### Parameters
- `listener` - The Listenr to register.
---
#### `UnregisterListener(listener)`
Unregister a listener that was registered using the `RegisterListener` method.
##### Parameters
- `listener` - The Listenr to unregister.
---
#### `Observe<M>(resultSelector)`
Turn the Event into an `IObservable<M>`. Makes Events compatible with for example UniRx.
#### Type Parameters
- `M` - The result selector type.
##### Parameters
- `resultSelector` - Takes `T1` and `T2` and returns a new type of type `M`.abstract Most of the time this is going to be combination of T1 and T2, eg. `ValueTuple<T1, T2>`
##### Returns
The Event as an `IObservable<M>`.
---
## `AtomFunction<R>`
#### Type Parameters
- `R` - The type to return from the Function.
Generic abstract base class for Functions. Inherits from `BaseAtom`.
### Variables
#### `Func`
The actual function.
### Methods
#### `Call`
Call the Function.
##### Returns
Whatever the function decides to return of type `R`.
---
#### `SetFunc(func)`
Set the Function providing a `Func<R>`.
##### Parameters
- `func` - The `Func<R>` to set.
##### Returns
An `AtomFunction<R>`.
---
## `AtomFunction<R,T1>`
#### Type Parameters
- `R` - The type to return from the Function.
- `T1` - The parameter type for this Function.
Generic abstract base class for Functions. Inherits from `BaseAtom`.
### Variables
#### `Func`
The actual function.
### Methods
#### `Call(t1)`
Call the Function.
##### Parameters
- `t1` - The first parameter.
##### Returns
Whatever the function decides to return of type `R`.
---
#### `SetFunc(func)`
Set the Function providing a `Func<T1, R>`.
##### Parameters
- `func` - The `Func<T1, R>` to set.
##### Returns
An `AtomFunction<R, T1>`.
---
## `AtomFunction<R,T1,T2>`
#### Type Parameters
- `R` - The type to return from the Function.
- `T1` - The first parameter type for this Function.
- `T2` - The second parameter type for this Function.
Generic abstract base class for Functions. Inherits from `BaseAtom`.
### Variables
#### `Func`
The actual function.
### Methods
#### `Call(t1,t2)`
Call the Function.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
##### Returns
Whatever the function decides to return of type `R`.
---
#### `SetFunc(func)`
Set the Function providing a `Func<T1, T2, R>`.
##### Parameters
- `func` - The `Func<T1, T2, R>` to set.
##### Returns
An `AtomFunction<R, T1, T2>`.
---
## `AtomFunction<R,T1,T2,T3>`
#### Type Parameters
- `R` - The type to return from the Function.
- `T1` - The first parameter type for this Function.
- `T2` - The second parameter type for this Function.
- `T3` - The third parameter type for this Function.
Generic abstract base class for Functions. Inherits from `BaseAtom`.
### Variables
#### `Func`
The actual function.
### Methods
#### `Call(t1,t2,t3)`
Call the Function.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
- `t3` - The third parameter.
##### Returns
Whatever the function decides to return of type `R`.
---
#### `SetFunc(func)`
Set the Function providing a `Func<T1, T2, T3, R>`.
##### Parameters
- `func` - The `Func<T1, T2, T3, R>` to set.
##### Returns
An `AtomFunction<R, T1, T2, T3>`.
---
## `AtomFunction<R,T1,T2,T3,T4>`
#### Type Parameters
- `R` - The type to return from the Function.
- `T1` - The first parameter type for this Function.
- `T2` - The second parameter type for this Function.
- `T3` - The third parameter type for this Function.
- `T4` - The fourth parameter type for this Function.
Generic abstract base class for Functions. Inherits from `BaseAtom`.
### Variables
#### `Func`
The actual function.
### Methods
#### `Call(t1,t2,t3,t4)`
Call the Function.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
- `t3` - The third parameter.
- `t4` - The fourth parameter.
##### Returns
Whatever the function decides to return of type `R`.
---
#### `SetFunc(func)`
Set the Function providing a `Func<T1, T2, T3, T4 R>`.
##### Parameters
- `func` - The `Func<T1, T2, T3, T4, R>` to set.
##### Returns
An `AtomFunction<R, T1, T2, T3, T4>`.
---
## `AtomFunction<R,T1,T2,T3,T4,T5>`
#### Type Parameters
- `R` - The type to return from the Function.
- `T1` - The first parameter type for this Function.
- `T2` - The second parameter type for this Function.
- `T3` - The third parameter type for this Function.
- `T4` - The fourth parameter type for this Function.
- `T5` - The fifth parameter type for this Function.
Generic abstract base class for Functions. Inherits from `BaseAtom`.
### Variables
#### `Func`
The actual function.
### Methods
#### `Call(t1,t2,t3,t4,t5)`
Call the Function.
##### Parameters
- `t1` - The first parameter.
- `t2` - The second parameter.
- `t3` - The third parameter.
- `t4` - The fourth parameter.
- `t5` - The fifth parameter.
##### Returns
Whatever the function decides to return of type `R`.
---
#### `SetFunc(func)`
Set the Function providing a `Func<T1, T2, T3, T4, T5 R>`.
##### Parameters
- `func` - The `Func<T1, T2, T3, T4, T5, R>` to set.
##### Returns
An `AtomFunction<R, T1, T2, T3, T4, T5>`.
---
Document Atom Listener
2019-10-15 15:21:23 -04:00
## `AtomListener<T,A,E,UER>`
Document Core WIP
2019-10-15 14:44:25 -04:00
#### Type Parameters
Document Atom Listener
2019-10-15 15:21:23 -04:00
- `T` - The type that we are listening for.
- `A` - Acion of type `AtomAction<T>`.
- `E` - Event of type `AtomEvent<T>`.
- `UER` - Unity Event of type `UnityEvent<T>`.
Document Core WIP
2019-10-15 14:44:25 -04:00
Generic base class for Listeners. Inherits from `MonoBehaviour` and `IAtomListener<T>`
Generate docs - document tags
2019-10-14 20:08:41 -04:00
Document Atom Listener
2019-10-15 15:21:23 -04:00
### Variables
#### `_event`
The Event that we are listening to.
---
#### `_unityEventResponse`
The Unity Event responses.
---
#### `_actionResponses`
The Action responses;
### Properties
#### `Event`
The Event we are listening for as a proeprty.
### Methods
#### `OnEventRaised(item)`
Handler for when the Event gets raised.
##### Parameters
- `item` - The Event type.
---
## `AtomListener<T1,T2,A,E,UER>`
#### Type Parameters
- `T1` - The first type that we are listening for.
- `T2` - The second type that we are listening for.
- `A` - Acion of type `AtomAction<T1, T2>`.
- `E` - Event of type `AtomEvent<T1, T2>`.
- `UER` - Unity Event of type `UnityEvent<T1, T2>`.
Generic base class for Listeners. Inherits from `MonoBehaviour` and `IAtomListener<T1, T2>`
### Variables
#### `_event`
The Event that we are listening to.
---
#### `_unityEventResponse`
The Unity Event responses.
---
#### `_actionResponses`
The Action responses;
### Properties
#### `Event`
The Event we are listening for as a proeprty.
### Methods
#### `OnEventRaised(first,second)`
Handler for when the Event gets raised.
##### Parameters
- `first` - The first Event type.
- `second` - The second Event type.
Generate docs - document tags
2019-10-14 20:08:41 -04:00
---
Create documentation WIP
2019-10-15 13:19:44 -04:00
Generate docs - document tags
2019-10-14 20:08:41 -04:00
## `Runtime`
Internal constant and static readonly members for runtime usage.
---
Create documentation WIP
2019-10-15 13:19:44 -04:00
Generate docs - document tags
2019-10-14 20:08:41 -04:00
## `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.
---
Reference in New Issue Copy Permalink