MyFunction

Navigation

API > API/Plugins > API/Plugins/ControlFlows > API/Plugins/ControlFlows/MyFunction

References

&42;void MyFunction  
&40;  
    FControlFlowNodeRef FlowHandle,  
    ...  
&41;  
Copy full snippet

&42;void MyFunction &40;     FControlFlowNodeRef FlowHandle,     ... &41;

Remarks

System/Tool to queue (asynchronous or synchronous) functions for modularity implemented via delegates. Allows code to be more easily read so there fewer 'Alt+G'-ing around to figure out what and where a class does it's thing

This system only supports non-const functions currently.

'QueueFunction': Queues a 'void (...)' function. The Flow will execute this function and continue on with the next function in queue.

'QueueWait': Queues a 'void (FControlFlowNodeRef FlowHandle, ...)' function. The flow will stop until 'FlowHandle->ContinueFlow()' is called. BE RESPONSIBLE and make sure all code paths call to continue xOR cancel, otherwise the flow will hang.

'QueueControlFlow': Queues a 'void (TSharedRef Subflow, ...)' function.

'QueueControlFlowBranch': Queues a 'int32(TSharedRef Branch, ...)' function. TODO: Allow any return-type for branch selection, and not restricted to only int32. Lambda-Syntax: '.BranchFlow(this { })'

'QueueConcurrentFlows': Queues a 'void(TSharedRef ForkedFlow, ...)' function Lambda-Syntax: '.ForkFlow(this { })'

'QueueConditionalLoop': Queues a 'EConditionalLoopResult(TSharedRef Loop, ...)' function The public functions of 'FConditionalLoop' forces the caller to define the loop as as a 'while (CONDITION) {}' or a 'do {} while(CONDITION);' The return is a FControlFlow& and queue your flow as normal Lambda-Syntax: '.Loop(this { })'

'QueueStep': Usable in UObject's or classes that derive from #TSharedFromThis. The Control Flow will automatically deduce if this is a '#QueueFunction', '#QueueWait', '#QueueControlFlow', '#QueueControlFlowBranch', '#QueueConcurrentFlows', 'EConditionalLoopResult' based on the function signature. Returns a ref to the ControlFlow - enables chained step queueing.

Using the auto-deduction of 'QueueStep', you can change the queue from a synchronous function (QueueFunction) to an asynchronous one (QueueWait) or vice-versa by adding/removing the 'FControlFlowNodeRef FlowHandle' as your first parameter. And you can change it to (QueueControlFlow) if need be as well!

Syntax:

void MyFunction(...); /**