Group Tree Operations – Engine Level

Table of contents
1. Start to execute all the trees in each forest 2. Start to execute all the trees in each forest with a target loop count and basic play mode 3. Pause all the trees in each forest 4. Resume to execute all the trees that were paused in each forest 5. Stop all the trees in each forest 6. Reset all the trees in each forest 7. Load all the forests and trees from the XML files 8. Destroy all the forests and trees

1. Start to execute all the trees in each forest
Signature:
static bool BtEngine.PlayAll()
Description:
Asynchronously starts to execute all tree instances in each forest with previously specified target loop count (0 by default) and basic play mode (StopByExecuteLoopCount by default).
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t), where f is the count of forest instance and t is the count of whose child tree instance.

2. Start to execute all the trees in each forest with a target loop count and basic play mode
Signature:
static bool BtEngine.PlayAll(uint TgtLoopCount, BasicPlayMode Mode)
Description:
Asynchronously starts to execute all tree instances in each forest with the specified target loop count and basic play mode.
Parameters:
TgtLoopCount	The target loop count for this execution as specified by the basic play mode. Enter 0 for an infinite loop.
Mode	The basic play mode for this execution which specifies the way to count loop number and stop execution.
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t), where f is the count of forest instance and t is the count of whose child tree instance.

3. Pause all the trees in each forest
Signature:
static bool BtEngine.PauseAll(bool Sync)
Description:
Asynchronously pauses all tree instances in each forest.
Parameters:
Sync	True to keep each tree instance’s state unchanged until whose OnPause operation returns; false otherwise.
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t), where f is the count of forest instance and t is the count of whose child tree instance.

4. Resume to execute all the trees that were paused in each forest
Signature:
static bool BtEngine.ResumeAll()
Description:
Asynchronously resumes to execute all tree instances that were paused in each forest with tree specific remaining loop count.
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t), where f is the count of forest instance and t is the count of whose child tree instance.

5. Stop all the trees in each forest
Signature:
static bool BtEngine.StopAll(bool Sync)
Description:
Asynchronously stops all tree instances in each forest.
Parameters:
Sync	True to keep each tree instance’s state unchanged until whose OnStop operation returns; false otherwise.
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t), where f is the count of forest instance and t is the count of whose child tree instance.

6. Reset all the trees in each forest
Signature:
static bool BtEngine.ResetAll(bool Sync)
Description:
Asynchronously resets all tree instances in each forest.
Parameters:
Sync	True to keep each tree instance’s state unchanged until whose OnReset operation returns; false otherwise.
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t), where f is the count of forest instance and t is the count of whose child tree instance.

7. Load all the forests and trees from the XML files
Signature:
static bool BtEngine.LoadAll(bool Sync)
Description:
Asynchronously instantiates all the trees and forests whose instances don’t exist from the forest xml file and tree xml files.
Parameters:
Sync	True to keep each forest and tree instance’s state unchanged until whose OnConstruct operation returns; false otherwise.
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t * n), where f is the count of forest instance, t is the count of whose child tree instance and n is the count of whose child node instance.

8. Destroy all the forests and trees
Signature:
static bool BtEngine.DestroyAll(bool Sync)
Description:
Asynchronously deletes all forest instances and all tree instances in each forest. If parallel operation, i.e., tree specific operation queue, is enabled, this operation cancels all the parallel tree specific queued operations of Play, Pause, Resume, Stop and Reset that were issued before it and then gets invoked right away.
Parameters:
Sync	True to keep each forest and tree instance’s state unchanged until whose OnDestruct operation returns; false otherwise.
Return Value:
True if the operation was enqueued; false otherwise.
Complexity:
O(f * t * n), where f is the count of forest instance, t is the count of whose child tree instance and n is the count of whose child node instance.