initial commit

docs/flow/ActivityImplementation.js

@@ -0,0 +1,37 @@
+    /**
+     * Perform whatever pre-update setup is required.
+     * Return true for success, false for failure.
+     * If a failure, update will not be called.
+     * @method jibo.flow.ActivityImplementation#start
+     * @param {jibo.flow.Context} context The executor's context
+     * @returns {boolean}
+     */
+
+    /**
+     * Perform the activity's normal update action. This will continue to be
+     * called on every update tick until it returns SUCCEEDED or FAILED.
+     * @method jibo.flow.ActivityImplementation#update
+     * @param {jibo.flow.Context} context The executor's context
+     * @returns {jibo.bt.Status}
+     */
+
+    /**
+     * Stop any ongoing activity (called during the processing of Flow.Interrupt and general exceptions).
+     * This is provided so that an asynchronous activity can be stopped and its resources released.
+     * @method jibo.flow.ActivityImplementation#stop
+     * @param {jibo.flow.Context} context The executor's context
+     * @return {Promise<void>} A promise that resolves after any asynchronous cleanup has been performed.
+     */
+
+    /**
+     * Destroy the activity, doing a full cleanup of any resources that need releasing.
+     * @method jibo.flow.ActivityImplementation#destroy
+     */
+
+    /**
+     * If the Flow has a transition or Flow.Catch in scope capable of handling the given JS exception, turn it into
+     * a Flow ~Exception.* and process it internally, otherwise stop Flow execution and throw the JS exception.
+     * @method jibo.flow.ActivityImplementation#formOrThrowException
+     * @param jsexception {Exception} Javascript Exception object to throw as a JS exception or convert to a Flow exception
+     * @returns {string} the name of the Flow Exception to be thrown
+     */