Class RxExecutableLibrary
Provides R3 subscription and disposable helpers for Flow graphs.
[CeresGroup("Rx")]
public class RxExecutableLibrary : ExecutableFunctionLibrary
- Inheritance
-
RxExecutableLibrary
- Inherited Members
Constructors
RxExecutableLibrary()
public RxExecutableLibrary()
Methods
CollectExecutableFunctions()
Collect all static executable functions in this library
protected override void CollectExecutableFunctions()
Flow_DisposableCreate(EventDelegate)
Creates a disposable that invokes the supplied event when disposed.
[ExecutableFunction]
[CeresLabel("Create Disposable From Event")]
public static IDisposable Flow_DisposableCreate(EventDelegate onDispose)
Parameters
onDisposeEventDelegateCallback invoked when the disposable is disposed.
Returns
- IDisposable
A disposable callback wrapper.
Flow_IDisposableAddToComponent(IDisposable, Component)
Registers the disposable with a component lifetime.
[ExecutableFunction(IsScriptMethod = true)]
[CeresLabel("Add To Component")]
public static void Flow_IDisposableAddToComponent(IDisposable disposable, Component component)
Parameters
disposableIDisposableThe disposable to register.
componentComponentThe component whose lifetime owns the disposable.
Flow_IDisposableAddToGameObject(IDisposable, GameObject)
Registers the disposable with a GameObject lifetime.
[ExecutableFunction(IsScriptMethod = true)]
[CeresLabel("Add To GameObject")]
public static void Flow_IDisposableAddToGameObject(IDisposable disposable, GameObject gameObject)
Parameters
disposableIDisposableThe disposable to register.
gameObjectGameObjectThe GameObject whose lifetime owns the disposable.
Flow_IDisposableAddToIDisposableUnregister(IDisposable, IDisposableUnregister)
Registers the disposable with an IDisposableUnregister lifetime owner.
[ExecutableFunction(IsScriptMethod = true)]
[CeresLabel("Add To Disposable Unregister")]
public static void Flow_IDisposableAddToIDisposableUnregister(IDisposable disposable, IDisposableUnregister disposableUnregister)
Parameters
disposableIDisposableThe disposable to register.
disposableUnregisterIDisposableUnregisterThe unregister owner that will dispose it.
Flow_IDisposableDispose(IDisposable)
Disposes the target subscription or disposable object.
[ExecutableFunction(IsScriptMethod = true)]
[CeresLabel("Dispose")]
public static void Flow_IDisposableDispose(IDisposable disposable)
Parameters
disposableIDisposableThe disposable object to dispose.