Warning: preg_replace(): Compilation failed: invalid range in character class at offset 4 in /home/customer/www/qualgame.com/public_html/wp-content/plugins/crayon-syntax-highlighter/crayon_langs.class.php on line 340
BtEngine Properties | BtEngineSDK

BtEngine Properties

Table of contents

1. Set the forest XML file name
2. Get the forest XML file name
3. Enable or disable parallel operation
4. Determine whether parallel operation is enabled or not
5. Get the forest count
6. Get the engine property wrapper

1. Set the forest XML file name
Signature:
static bool BtEngine.SetForestFile(string ForestFile)
Description:
Sets the forest xml file name. This operation is effective only when the engine is off.
Parameters:
ForestFile The name of the forest xml file to set.
Return Value:
True if the forest xml file name was updated; false otherwise.
Complexity:
O(1).
2. Get the forest XML file name
Signature:
static string BtEngine.GetForestFile()
Description:
Gets the forest xml file name.
Return Value:
A string of the forest xml file name.
Complexity:
O(1).
3. Enable or disable parallel operation
Signature:
static bool BtEngine.EnableParallelOp(bool Enable)
Description:
Enables or disables parallel operation, i.e., tree specific operation queue (enabled by default). Without parallel operation, a queued sequence of tree operations such as Load, Destroy, Play, Pause, Resume, Stop, Reset, can only be invoked sequentially by parallel running trees. However, interrupt operations (Destroy, Pause, Stop, Reset) can block the operation queue until all the nodes in the invoked tree return, which will delay the invocation of other operations on other trees. Enabling parallel operation will ensure operations getting invoked immediately per tree without waiting for other trees. This operation is effective only when the engine is off.
Parameters:
Enable True to enable; false to disable.
Return Value:
True if parallel operation was updated; false otherwise.
Complexity:
O(1).
4. Determine whether parallel operation is enabled or not
Signature:
static bool BtEngine.IsEnabledParallelOp()
Description:
Determines whether parallel operation is enabled or not.
Return Value:
True if parallel operation is enabled; false otherwise.
Complexity:
O(1).
5. Get the forest count
Signature:
static Tuple<bool, uint> BtEngine.GetForestCount()
Description:
Gets the number of forest instances.
Return Value:
A tuple. Item1: true if the engine was on; false otherwise. Item2: the number of forest instances if Item1 is true; 0 otherwise.
Complexity:
O(1).
6. Get the engine property wrapper
Signature:
static Tuple<bool, EnginePropWrap> BtEngine.GetEnginePropWrap(FromEngineTo Level)
Description:
Gets an engine property wrapper that contains all the information of the engine with the specified depth level.
Parameters:
Level The depth level of the information in the property wrapper.
Return Value:
A tuple. Item1: true if the engine was on; false otherwise. Item2: an engine property wrapper that contains all the information of the engine if Item1 is true; null otherwise.
Complexity:
O(1) if level is FromEngineTo.Engine, O(1 + f) if level is FromEngineTo.Forest, O(1 + f * t) if level is FromEngineTo.Tree, O(1 + f * t * n) if level is FromEngineTo.Node, 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.