Class Flow

Inheritance
Object
Flow
Namespace: Ludiq.Bolt
Syntax
public sealed class Flow : IPoolable, IDisposable

Fields

loopIdentifier

Declaration
public int loopIdentifier
Field Value
Type Description
Int32

Properties

currentLoop

Declaration
public int currentLoop { get; }
Property Value
Type Description
Int32

enableDebug

Declaration
public bool enableDebug { get; }
Property Value
Type Description
Boolean

isCoroutine

Declaration
public bool isCoroutine { get; }
Property Value
Type Description
Boolean

isPrediction

Declaration
public bool isPrediction { get; }
Property Value
Type Description
Boolean

stack

Declaration
public GraphStack stack { get; }
Property Value
Type Description
GraphStack

variables

Declaration
[Obsolete("Use the new class variables system instead.")]
public VariableDeclarations variables { get; }
Property Value
Type Description
VariableDeclarations

Methods

AssignLocal(Object, HybridType, Object)

Declaration
public void AssignLocal(object identifier, HybridType type, object value)
Parameters
Type Name Description
Object identifier
HybridType type
Object value

AssignLocal<T>(String, T)

Declaration
public void AssignLocal<T>(string identifier, T value)
Parameters
Type Name Description
String identifier
T value
Type Parameters
Name Description
T

BreakLoop()

Declaration
public void BreakLoop()

CanPredict(IUnitValuePort, GraphReference)

Declaration
public static bool CanPredict(IUnitValuePort port, GraphReference reference)
Parameters
Type Name Description
IUnitValuePort port
GraphReference reference
Returns
Type Description
Boolean

CanPredict(ValueInput)

Declaration
public bool CanPredict(ValueInput input)
Parameters
Type Name Description
ValueInput input
Returns
Type Description
Boolean

CreateCoroutine(GraphReference, ControlOutput, out IEnumerator)

Declaration
public static Flow CreateCoroutine(GraphReference reference, ControlOutput startPort, out IEnumerator enumerator)
Parameters
Type Name Description
GraphReference reference
ControlOutput startPort
IEnumerator enumerator
Returns
Type Description
Flow

Dispose()

Declaration
public void Dispose()

DisposePreservedStack(GraphStack)

Declaration
public void DisposePreservedStack(GraphStack stack)
Parameters
Type Name Description
GraphStack stack

EnterLoop()

Declaration
public int EnterLoop()
Returns
Type Description
Int32

ExitLoop(Int32)

Declaration
public void ExitLoop(int loop)
Parameters
Type Name Description
Int32 loop

FetchValue(ValueInput, GraphReference)

Declaration
public static object FetchValue(ValueInput input, GraphReference reference)
Parameters
Type Name Description
ValueInput input
GraphReference reference
Returns
Type Description
Object

FetchValue(ValueInput, HybridType, GraphReference)

Declaration
public static object FetchValue(ValueInput input, HybridType type, GraphReference reference)
Parameters
Type Name Description
ValueInput input
HybridType type
GraphReference reference
Returns
Type Description
Object

FetchValue<T>(ValueInput, GraphReference)

Declaration
public static T FetchValue<T>(ValueInput input, GraphReference reference)
Parameters
Type Name Description
ValueInput input
GraphReference reference
Returns
Type Description
T
Type Parameters
Name Description
T

GetDefaultValue(ValueInput)

Declaration
public object GetDefaultValue(ValueInput input)
Parameters
Type Name Description
ValueInput input
Returns
Type Description
Object

GetLocal(Object)

Declaration
public object GetLocal(object identifier)
Parameters
Type Name Description
Object identifier
Returns
Type Description
Object

GetValue(ValueInput)

Declaration
public object GetValue(ValueInput input)
Parameters
Type Name Description
ValueInput input
Returns
Type Description
Object

GetValue(ValueInput, HybridType)

Declaration
public object GetValue(ValueInput input, HybridType type)
Parameters
Type Name Description
ValueInput input
HybridType type
Returns
Type Description
Object

GetValue(ValueOutput)

Declaration
public object GetValue(ValueOutput output)
Parameters
Type Name Description
ValueOutput output
Returns
Type Description
Object

GetValue(ValueOutput, HybridType)

Declaration
public object GetValue(ValueOutput output, HybridType type)
Parameters
Type Name Description
ValueOutput output
HybridType type
Returns
Type Description
Object

GetValue<T>(ValueInput)

Declaration
public T GetValue<T>(ValueInput input)
Parameters
Type Name Description
ValueInput input
Returns
Type Description
T
Type Parameters
Name Description
T

GetValue<T>(ValueOutput)

Declaration
public T GetValue<T>(ValueOutput output)
Parameters
Type Name Description
ValueOutput output
Returns
Type Description
T
Type Parameters
Name Description
T

HasLocal(Object)

Declaration
public bool HasLocal(object identifier)
Parameters
Type Name Description
Object identifier
Returns
Type Description
Boolean

Invoke(ControlOutput)

Declaration
public void Invoke(ControlOutput output)
Parameters
Type Name Description
ControlOutput output

LoopIsNotBroken(Int32)

Declaration
public bool LoopIsNotBroken(int loop)
Parameters
Type Name Description
Int32 loop
Returns
Type Description
Boolean

New(GraphReference, Boolean)

Declaration
public static Flow New(GraphReference reference, bool isPrediction = false)
Parameters
Type Name Description
GraphReference reference
Boolean isPrediction
Returns
Type Description
Flow

Predict(IUnitValuePort, GraphReference)

Declaration
public static object Predict(IUnitValuePort port, GraphReference reference)
Parameters
Type Name Description
IUnitValuePort port
GraphReference reference
Returns
Type Description
Object

Predict(IUnitValuePort, GraphReference, Type)

Declaration
public static object Predict(IUnitValuePort port, GraphReference reference, Type type)
Parameters
Type Name Description
IUnitValuePort port
GraphReference reference
Type type
Returns
Type Description
Object

Predict<T>(IUnitValuePort, GraphReference)

Declaration
public static T Predict<T>(IUnitValuePort port, GraphReference pointer)
Parameters
Type Name Description
IUnitValuePort port
GraphReference pointer
Returns
Type Description
T
Type Parameters
Name Description
T

PreserveStack()

Declaration
public GraphStack PreserveStack()
Returns
Type Description
GraphStack

RestoreStack(GraphStack)

Declaration
public void RestoreStack(GraphStack stack)
Parameters
Type Name Description
GraphStack stack

SetValue(ValueInput, Object)

Declaration
public void SetValue(ValueInput input, object value)
Parameters
Type Name Description
ValueInput input
Object value

SetValue(ValueOutput, Object)

Declaration
public void SetValue(ValueOutput output, object value)
Parameters
Type Name Description
ValueOutput output
Object value

StartCoroutine(MonoBehaviour)

Declaration
public Coroutine StartCoroutine(MonoBehaviour runner)
Parameters
Type Name Description
MonoBehaviour runner
Returns
Type Description
Coroutine

StopCoroutine(Boolean)

Declaration
public void StopCoroutine(bool disposeInstantly)
Parameters
Type Name Description
Boolean disposeInstantly

TryGetDefaultValue(ValueInput, out Object)

Declaration
public bool TryGetDefaultValue(ValueInput input, out object defaultValue)
Parameters
Type Name Description
ValueInput input
Object defaultValue
Returns
Type Description
Boolean

TryGetLocal(Object, out Object)

Declaration
public bool TryGetLocal(object identifier, out object local)
Parameters
Type Name Description
Object identifier
Object local
Returns
Type Description
Boolean

Events

disposing

Declaration
public event Action disposing
Event Type
Type Description
Action

Explicit Interface Implementations

IPoolable.Free()

Declaration
void IPoolable.Free()
Implements

IPoolable.New()

Declaration
void IPoolable.New()
Implements

Extension Methods