10663 lines
896 KiB
JSON
10663 lines
896 KiB
JSON
{
|
||
"uniq": {
|
||
"LimboAI Documentation\u0000{}": {
|
||
"uid": 1,
|
||
"tpl": "LimboAI Documentation",
|
||
"markers": {}
|
||
},
|
||
"<b>LimboAI</b> is an open-source C++ module for <b>Godot Engine 4</b> providing a combination of <b>Behavior Trees</b> and <b>State Machines</b> for crafting your game’s AI. It comes with a behavior tree editor, built-in documentation, visual debugger, and more! While it is implemented in C++, it fully supports GDScript for <l1>creating your own tasks</l> and states. The full list of features is available on the <l2>LimboAI GitHub</l> page.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/custom-tasks#custom-tasks\\\"><span class=\\\"std std-ref\\\">creating your own tasks</span></a>\", \"2\": \"<a class=\\\"reference external\\\" href=\\\"https://github.com/limbonaut/limboai#features\\\">LimboAI GitHub</a>\"}": {
|
||
"uid": 2,
|
||
"tpl": "<b>LimboAI</b> is an open-source C++ module for <b>Godot Engine 4</b> providing a combination of <b>Behavior Trees</b> and <b>State Machines</b> for crafting your game’s AI. It comes with a behavior tree editor, built-in documentation, visual debugger, and more! While it is implemented in C++, it fully supports GDScript for <l1>creating your own tasks</l> and states. The full list of features is available on the <l2>LimboAI GitHub</l> page.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-behavior-trees/custom-tasks#custom-tasks\"><span class=\"std std-ref\">creating your own tasks</span></a>",
|
||
"2": "<a class=\"reference external\" href=\"https://github.com/limbonaut/limboai#features\">LimboAI GitHub</a>"
|
||
}
|
||
},
|
||
"<b>Behavior Trees</b> are powerful hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies, entities). They are designed to make it easier to create complex and highly modular behaviors for your games. To learn more about behavior trees, check out <l1>Introduction to Behavior Trees</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/introduction#introduction\\\"><span class=\\\"std std-ref\\\">Introduction to Behavior Trees</span></a>\"}": {
|
||
"uid": 3,
|
||
"tpl": "<b>Behavior Trees</b> are powerful hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies, entities). They are designed to make it easier to create complex and highly modular behaviors for your games. To learn more about behavior trees, check out <l1>Introduction to Behavior Trees</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-behavior-trees/introduction#introduction\"><span class=\"std std-ref\">Introduction to Behavior Trees</span></a>"
|
||
}
|
||
},
|
||
"<b>Hierarchical State Machines</b> are finite state machines that allow any state to host their own sub-state machine. This allows you to tackle your AI’s state and transition complexity by breaking down one big state machine into multiple smaller ones.\u0000{}": {
|
||
"uid": 4,
|
||
"tpl": "<b>Hierarchical State Machines</b> are finite state machines that allow any state to host their own sub-state machine. This allows you to tackle your AI’s state and transition complexity by breaking down one big state machine into multiple smaller ones.",
|
||
"markers": {}
|
||
},
|
||
"Getting LimboAI\u0000{}": {
|
||
"uid": 5,
|
||
"tpl": "Getting LimboAI",
|
||
"markers": {}
|
||
},
|
||
"LimboAI can be used as either a C++ module or as a GDExtension shared library. There are some differences between the two. In short, GDExtension version is more convenient to use but somewhat limited in features. The module version provides better editor experience and is slightly more performant, but it requires using custom engine builds including the export templates. Whichever you choose to use, your project will stay compatible with both and you can switch from one to the other any time.\u0000{}": {
|
||
"uid": 6,
|
||
"tpl": "LimboAI can be used as either a C++ module or as a GDExtension shared library. There are some differences between the two. In short, GDExtension version is more convenient to use but somewhat limited in features. The module version provides better editor experience and is slightly more performant, but it requires using custom engine builds including the export templates. Whichever you choose to use, your project will stay compatible with both and you can switch from one to the other any time.",
|
||
"markers": {}
|
||
},
|
||
"Choose the version you’d like to use. If you’re unsure, start with the GDExtension version. You can change your decision at any time - both versions are fully compatible.\u0000{}": {
|
||
"uid": 7,
|
||
"tpl": "Choose the version you’d like to use. If you’re unsure, start with the GDExtension version. You can change your decision at any time - both versions are fully compatible.",
|
||
"markers": {}
|
||
},
|
||
"Get GDExtension version\u0000{}": {
|
||
"uid": 8,
|
||
"tpl": "Get GDExtension version",
|
||
"markers": {}
|
||
},
|
||
"Precompiled builds are available on the official <l1>LimboAI GitHub</l> page, and in the Asset Library.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://github.com/limbonaut/limboai#getting-limboai\\\">LimboAI GitHub</a>\"}": {
|
||
"uid": 9,
|
||
"tpl": "Precompiled builds are available on the official <l1>LimboAI GitHub</l> page, and in the Asset Library.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://github.com/limbonaut/limboai#getting-limboai\">LimboAI GitHub</a>"
|
||
}
|
||
},
|
||
"GDExtension is the most convenient way of using the LimboAI plugin, but it comes with certain limitations:\u0000{}": {
|
||
"uid": 10,
|
||
"tpl": "GDExtension is the most convenient way of using the LimboAI plugin, but it comes with certain limitations:",
|
||
"markers": {}
|
||
},
|
||
"Documentation tooltips are not available.\u0000{}": {
|
||
"uid": 11,
|
||
"tpl": "Documentation tooltips are not available.",
|
||
"markers": {}
|
||
},
|
||
"Handy <l1>BBParam</l> property editor is not available in the extension due to dependencies on the engine classes that are not available in the Godot API.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 12,
|
||
"tpl": "Handy <l1>BBParam</l> property editor is not available in the extension due to dependencies on the engine classes that are not available in the Godot API.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"<b>🛈 See also:</b> <l1>What is GDExtension?</l>\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/what_is_gdextension.html#what-is-gdextension\\\">What is GDExtension?</a>\"}": {
|
||
"uid": 13,
|
||
"tpl": "<b>🛈 See also:</b> <l1>What is GDExtension?</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://docs.godotengine.org/en/stable/tutorials/scripting/gdextension/what_is_gdextension.html#what-is-gdextension\">What is GDExtension?</a>"
|
||
}
|
||
},
|
||
"Installation instructions:\u0000{}": {
|
||
"uid": 14,
|
||
"tpl": "Installation instructions:",
|
||
"markers": {}
|
||
},
|
||
"Make sure you’re using the latest stable version of the Godot editor.\u0000{}": {
|
||
"uid": 15,
|
||
"tpl": "Make sure you’re using the latest stable version of the Godot editor.",
|
||
"markers": {}
|
||
},
|
||
"Create a new project for your experiments with LimboAI.\u0000{}": {
|
||
"uid": 16,
|
||
"tpl": "Create a new project for your experiments with LimboAI.",
|
||
"markers": {}
|
||
},
|
||
"In Godot, click AssetLib tab at the top of the screen and search for LimboAI. Download it. LimboAI plugin will be downloaded with the demo project files. Don’t mind the errors printed at this point, this is due to the extension library not being loaded just yet.\u0000{}": {
|
||
"uid": 17,
|
||
"tpl": "In Godot, click AssetLib tab at the top of the screen and search for LimboAI. Download it. LimboAI plugin will be downloaded with the demo project files. Don’t mind the errors printed at this point, this is due to the extension library not being loaded just yet.",
|
||
"markers": {}
|
||
},
|
||
"Reload your project with Project -> Reload project. There shouldn’t be any errors printed now.\u0000{}": {
|
||
"uid": 18,
|
||
"tpl": "Reload your project with Project -> Reload project. There shouldn’t be any errors printed now.",
|
||
"markers": {}
|
||
},
|
||
"In the project files, locate a scene file called showcase.tscn and run it. It’s the demo’s entry point.\u0000{}": {
|
||
"uid": 19,
|
||
"tpl": "In the project files, locate a scene file called showcase.tscn and run it. It’s the demo’s entry point.",
|
||
"markers": {}
|
||
},
|
||
"Get module version\u0000{}": {
|
||
"uid": 20,
|
||
"tpl": "Get module version",
|
||
"markers": {}
|
||
},
|
||
"Precompiled builds are available on the official <l1>LimboAI GitHub</l> page.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://github.com/limbonaut/limboai#getting-limboai\\\">LimboAI GitHub</a>\"}": {
|
||
"uid": 21,
|
||
"tpl": "Precompiled builds are available on the official <l1>LimboAI GitHub</l> page.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://github.com/limbonaut/limboai#getting-limboai\">LimboAI GitHub</a>"
|
||
}
|
||
},
|
||
"In <l1>GitHub releases</l>, download the latest pre-compiled release build for your platform.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://github.com/limbonaut/limboai/releases/\\\">GitHub releases</a>\"}": {
|
||
"uid": 22,
|
||
"tpl": "In <l1>GitHub releases</l>, download the latest pre-compiled release build for your platform.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://github.com/limbonaut/limboai/releases/\">GitHub releases</a>"
|
||
}
|
||
},
|
||
"Download the demo project archive from the same release.\u0000{}": {
|
||
"uid": 23,
|
||
"tpl": "Download the demo project archive from the same release.",
|
||
"markers": {}
|
||
},
|
||
"Extract the pre-compiled editor and the demo project files.\u0000{}": {
|
||
"uid": 24,
|
||
"tpl": "Extract the pre-compiled editor and the demo project files.",
|
||
"markers": {}
|
||
},
|
||
"Launch the pre-compiled editor binary, import and open the demo project.\u0000{}": {
|
||
"uid": 25,
|
||
"tpl": "Launch the pre-compiled editor binary, import and open the demo project.",
|
||
"markers": {}
|
||
},
|
||
"Run the project.\u0000{}": {
|
||
"uid": 26,
|
||
"tpl": "Run the project.",
|
||
"markers": {}
|
||
},
|
||
"<b>Important</b>: To export your game using the module version of LimboAI, make sure to use the pre-compiled export templates included in the same GitHub release build.\u0000{}": {
|
||
"uid": 27,
|
||
"tpl": "<b>Important</b>: To export your game using the module version of LimboAI, make sure to use the pre-compiled export templates included in the same GitHub release build.",
|
||
"markers": {}
|
||
},
|
||
"Using LimboAI with C#\u0000{}": {
|
||
"uid": 28,
|
||
"tpl": "Using LimboAI with C#",
|
||
"markers": {}
|
||
},
|
||
"Here’s how you can use the module version with C# to write your tasks and states.\u0000{}": {
|
||
"uid": 29,
|
||
"tpl": "Here’s how you can use the module version with C# to write your tasks and states.",
|
||
"markers": {}
|
||
},
|
||
"Locate LimboAI NuGet package files.\u0000{}": {
|
||
"uid": 30,
|
||
"tpl": "Locate LimboAI NuGet package files.",
|
||
"markers": {}
|
||
},
|
||
"Each provided build comes with a GodotSharp folder, which has packages under “GodotSharp/Tools/nupkgs/”. Note down the directory path; you’ll need it in the next step.\u0000{}": {
|
||
"uid": 31,
|
||
"tpl": "Each provided build comes with a GodotSharp folder, which has packages under “GodotSharp/Tools/nupkgs/”. Note down the directory path; you’ll need it in the next step.",
|
||
"markers": {}
|
||
},
|
||
"Add a local source for NuGet packages using the following command:\u0000{}": {
|
||
"uid": 32,
|
||
"tpl": "Add a local source for NuGet packages using the following command:",
|
||
"markers": {}
|
||
},
|
||
"Your C# project should be able to see LimboAI classes and compile.\u0000{}": {
|
||
"uid": 33,
|
||
"tpl": "Your C# project should be able to see LimboAI classes and compile.",
|
||
"markers": {}
|
||
},
|
||
"Regarding GDExtension, I can only confirm success with the module version and C#. Unfortunately, I haven’t had any luck with the GDExtension version yet. If you’ve had success with GDExtension, please let me know via Discord or email.\u0000{}": {
|
||
"uid": 34,
|
||
"tpl": "Regarding GDExtension, I can only confirm success with the module version and C#. Unfortunately, I haven’t had any luck with the GDExtension version yet. If you’ve had success with GDExtension, please let me know via Discord or email.",
|
||
"markers": {}
|
||
},
|
||
"Contributing\u0000{}": {
|
||
"uid": 35,
|
||
"tpl": "Contributing",
|
||
"markers": {}
|
||
},
|
||
"We target the latest stable version of the Godot Engine for development until a third beta or a release candidate of an upcoming Godot release becomes available. If you want to contribute to the project, please ensure that you are using the corresponding Godot version.\u0000{}": {
|
||
"uid": 36,
|
||
"tpl": "We target the latest stable version of the Godot Engine for development until a third beta or a release candidate of an upcoming Godot release becomes available. If you want to contribute to the project, please ensure that you are using the corresponding Godot version.",
|
||
"markers": {}
|
||
},
|
||
"We follow the <l1>Godot code style guidelines</l>. Please use <2/> to maintain consistent styling. You can install <3/> hooks for Git using <4/> to automate this process.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://docs.godotengine.org/en/stable/contributing/development/code_style_guidelines.html#doc-code-style-guidelines\\\">Godot code style guidelines</a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">clang-format</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">pre-commit</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">pre-commit</span> <span class=\\\"pre\\\">install</span></code>\"}": {
|
||
"uid": 37,
|
||
"tpl": "We follow the <l1>Godot code style guidelines</l>. Please use <2/> to maintain consistent styling. You can install <3/> hooks for Git using <4/> to automate this process.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://docs.godotengine.org/en/stable/contributing/development/code_style_guidelines.html#doc-code-style-guidelines\">Godot code style guidelines</a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">clang-format</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">pre-commit</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">pre-commit</span> <span class=\"pre\">install</span></code>"
|
||
}
|
||
},
|
||
"Please keep the minor versions backward-compatible when submitting pull requests.\u0000{}": {
|
||
"uid": 38,
|
||
"tpl": "Please keep the minor versions backward-compatible when submitting pull requests.",
|
||
"markers": {}
|
||
},
|
||
"We support building LimboAI as a module for the Godot Engine and as a GDExtension library. Make sure your contribution is compatible with both. Our CI workflow will verify that your changes can be compiled in both configurations.\u0000{}": {
|
||
"uid": 39,
|
||
"tpl": "We support building LimboAI as a module for the Godot Engine and as a GDExtension library. Make sure your contribution is compatible with both. Our CI workflow will verify that your changes can be compiled in both configurations.",
|
||
"markers": {}
|
||
},
|
||
"Compiling as module of the Godot Engine\u0000{}": {
|
||
"uid": 40,
|
||
"tpl": "Compiling as module of the Godot Engine",
|
||
"markers": {}
|
||
},
|
||
"Clone the Godot Engine repository.\u0000{}": {
|
||
"uid": 41,
|
||
"tpl": "Clone the Godot Engine repository.",
|
||
"markers": {}
|
||
},
|
||
"Switch to the latest stable tag.\u0000{}": {
|
||
"uid": 42,
|
||
"tpl": "Switch to the latest stable tag.",
|
||
"markers": {}
|
||
},
|
||
"Clone the LimboAI repository into the <1/> directory.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">modules/limboai</span></code>\"}": {
|
||
"uid": 43,
|
||
"tpl": "Clone the LimboAI repository into the <1/> directory.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">modules/limboai</span></code>"
|
||
}
|
||
},
|
||
"Consult the <l1>Godot Engine documentation</l> for detailed instructions on building the engine.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://docs.godotengine.org/en/stable/engine_details/development/compiling/index.html\\\">Godot Engine documentation</a>\"}": {
|
||
"uid": 44,
|
||
"tpl": "Consult the <l1>Godot Engine documentation</l> for detailed instructions on building the engine.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://docs.godotengine.org/en/stable/engine_details/development/compiling/index.html\">Godot Engine documentation</a>"
|
||
}
|
||
},
|
||
"<b>Unit tests</b> can be compiled using the <1/> build option. To execute them, run the compiled Godot binary with the <2/> command-line options.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">tests=yes</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">--test</span> <span class=\\\"pre\\\">--tc=\\\"*[LimboAI]*\\\"</span></code>\"}": {
|
||
"uid": 45,
|
||
"tpl": "<b>Unit tests</b> can be compiled using the <1/> build option. To execute them, run the compiled Godot binary with the <2/> command-line options.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">tests=yes</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">--test</span> <span class=\"pre\">--tc=\"*[LimboAI]*\"</span></code>"
|
||
}
|
||
},
|
||
"Building C# Packages\u0000{}": {
|
||
"uid": 46,
|
||
"tpl": "Building C# Packages",
|
||
"markers": {}
|
||
},
|
||
"If you want C# Support for LimboAI when building from source, follow Godot’s instructions for building from source with C# Support: <l1>Compiling with .NET</l>. LimboAI’s classes will be included in the output from that build process.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://docs.godotengine.org/en/stable/engine_details/development/compiling/compiling_with_dotnet.html\\\">Compiling with .NET</a>\"}": {
|
||
"uid": 47,
|
||
"tpl": "If you want C# Support for LimboAI when building from source, follow Godot’s instructions for building from source with C# Support: <l1>Compiling with .NET</l>. LimboAI’s classes will be included in the output from that build process.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://docs.godotengine.org/en/stable/engine_details/development/compiling/compiling_with_dotnet.html\">Compiling with .NET</a>"
|
||
}
|
||
},
|
||
"Compiling as GDExtension library\u0000{}": {
|
||
"uid": 48,
|
||
"tpl": "Compiling as GDExtension library",
|
||
"markers": {}
|
||
},
|
||
"You’ll need the SCons build tool and a C++ compiler. See also <l1>Compiling</l>. Run <2/> to build the plugin library for your current platform.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://docs.godotengine.org/en/stable/engine_details/development/compiling/index.html\\\">Compiling</a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">scons</span> <span class=\\\"pre\\\">target=editor</span></code>\"}": {
|
||
"uid": 49,
|
||
"tpl": "You’ll need the SCons build tool and a C++ compiler. See also <l1>Compiling</l>. Run <2/> to build the plugin library for your current platform.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://docs.godotengine.org/en/stable/engine_details/development/compiling/index.html\">Compiling</a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">scons</span> <span class=\"pre\">target=editor</span></code>"
|
||
}
|
||
},
|
||
"SCons will automatically clone the <1/> repository if it doesn’t already exist in the <2/> directory.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">godot-cpp</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">limboai/godot-cpp</span></code>\"}": {
|
||
"uid": 50,
|
||
"tpl": "SCons will automatically clone the <1/> repository if it doesn’t already exist in the <2/> directory.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">godot-cpp</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">limboai/godot-cpp</span></code>"
|
||
}
|
||
},
|
||
"By default, built targets are placed in the demo project: <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">demo/addons/limboai/bin/</span></code>\"}": {
|
||
"uid": 51,
|
||
"tpl": "By default, built targets are placed in the demo project: <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">demo/addons/limboai/bin/</span></code>"
|
||
}
|
||
},
|
||
"Check <1/> for other options and targets.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">scons</span> <span class=\\\"pre\\\">-h</span></code>\"}": {
|
||
"uid": 52,
|
||
"tpl": "Check <1/> for other options and targets.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">scons</span> <span class=\"pre\">-h</span></code>"
|
||
}
|
||
},
|
||
"Contributing to the documentation\u0000{}": {
|
||
"uid": 53,
|
||
"tpl": "Contributing to the documentation",
|
||
"markers": {}
|
||
},
|
||
"Online documentation is created using <l1>Sphinx</l>. Source files are located in the <2/> directory in RST format and can be built locally with <3/>. See the <l4>Sphinx documentation</l> for more details.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://www.sphinx-doc.org/en/master/\\\">Sphinx</a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">doc/source</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">sphinx-build</span></code>\", \"4\": \"<a class=\\\"reference external\\\" href=\\\"https://www.sphinx-doc.org/en/master/tutorial/getting-started.html\\\">Sphinx documentation</a>\"}": {
|
||
"uid": 54,
|
||
"tpl": "Online documentation is created using <l1>Sphinx</l>. Source files are located in the <2/> directory in RST format and can be built locally with <3/>. See the <l4>Sphinx documentation</l> for more details.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://www.sphinx-doc.org/en/master/\">Sphinx</a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">doc/source</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">sphinx-build</span></code>",
|
||
"4": "<a class=\"reference external\" href=\"https://www.sphinx-doc.org/en/master/tutorial/getting-started.html\">Sphinx documentation</a>"
|
||
}
|
||
},
|
||
"Class documentation resides in XML files within the <1/> directory. If you create a new class or modify an existing one, you can run the compiled Godot binary with the <2/> option in the root of the Godot source code to generate the missing XML files or sections within those files in the class documentation. After editing the XML files, please run the compiled editor binary with the <3/> option again to update and tidy up the XML files.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">doc_classes/</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">--doctool</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">--doctool</span></code>\"}": {
|
||
"uid": 55,
|
||
"tpl": "Class documentation resides in XML files within the <1/> directory. If you create a new class or modify an existing one, you can run the compiled Godot binary with the <2/> option in the root of the Godot source code to generate the missing XML files or sections within those files in the class documentation. After editing the XML files, please run the compiled editor binary with the <3/> option again to update and tidy up the XML files.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">doc_classes/</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">--doctool</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">--doctool</span></code>"
|
||
}
|
||
},
|
||
"Sphinx RST files for the class documentation are generated from XML files using the Godot script <1/> and stored in the <2/> directory. This process is performed using our own script <3/>. RST files in <4/> should not be edited manually.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">make_rst.py</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">doc/source/classes</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">scripts/update_rst.sh</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">doc/source/classes</span></code>\"}": {
|
||
"uid": 56,
|
||
"tpl": "Sphinx RST files for the class documentation are generated from XML files using the Godot script <1/> and stored in the <2/> directory. This process is performed using our own script <3/>. RST files in <4/> should not be edited manually.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">make_rst.py</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">doc/source/classes</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">scripts/update_rst.sh</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">doc/source/classes</span></code>"
|
||
}
|
||
},
|
||
"Introduction to Behavior Trees\u0000{}": {
|
||
"uid": 57,
|
||
"tpl": "Introduction to Behavior Trees",
|
||
"markers": {}
|
||
},
|
||
"<b>🛈 Note:</b> Demo project includes a tutorial that provides an introduction to behavior trees through illustrative examples.\u0000{}": {
|
||
"uid": 58,
|
||
"tpl": "<b>🛈 Note:</b> Demo project includes a tutorial that provides an introduction to behavior trees through illustrative examples.",
|
||
"markers": {}
|
||
},
|
||
"<b>Behavior Trees (BT)</b> are hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies, entities). They are designed to make it easier to create complex and highly modular behaviors for your games.\u0000{}": {
|
||
"uid": 59,
|
||
"tpl": "<b>Behavior Trees (BT)</b> are hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies, entities). They are designed to make it easier to create complex and highly modular behaviors for your games.",
|
||
"markers": {}
|
||
},
|
||
"Behavior Trees are composed of tasks that represent specific actions or decision-making rules. Tasks can be broadly categorized into two main types: control tasks and leaf tasks. <b>Control tasks</b> determine the execution flow within the tree. They include <l1>Sequence</l>, <l2>Selector</l>, and <l3>Invert</l>. <b>Leaf tasks</b> represent specific actions to perform, like moving or attacking, or conditions that need to be checked. The <l4>BTTask</l> class provides the foundation for various building blocks of the Behavior Trees. Such tasks can <l5>share data using the Blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">Sequence</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">Selector</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinvert#class-btinvert\\\"><span class=\\\"std std-ref\\\">Invert</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/using-blackboard#blackboard\\\"><span class=\\\"std std-ref\\\">share data using the Blackboard</span></a>\"}": {
|
||
"uid": 60,
|
||
"tpl": "Behavior Trees are composed of tasks that represent specific actions or decision-making rules. Tasks can be broadly categorized into two main types: control tasks and leaf tasks. <b>Control tasks</b> determine the execution flow within the tree. They include <l1>Sequence</l>, <l2>Selector</l>, and <l3>Invert</l>. <b>Leaf tasks</b> represent specific actions to perform, like moving or attacking, or conditions that need to be checked. The <l4>BTTask</l> class provides the foundation for various building blocks of the Behavior Trees. Such tasks can <l5>share data using the Blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">Sequence</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">Selector</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btinvert#class-btinvert\"><span class=\"std std-ref\">Invert</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-behavior-trees/using-blackboard#blackboard\"><span class=\"std std-ref\">share data using the Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<b>🛈 Note:</b> To <l1>create your own actions</l>, extend the <l2>BTAction</l> class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/custom-tasks#custom-tasks\\\"><span class=\\\"std std-ref\\\">create your own actions</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btaction#class-btaction\\\"><span class=\\\"std std-ref\\\">BTAction</span></a>\"}": {
|
||
"uid": 61,
|
||
"tpl": "<b>🛈 Note:</b> To <l1>create your own actions</l>, extend the <l2>BTAction</l> class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-behavior-trees/custom-tasks#custom-tasks\"><span class=\"std std-ref\">create your own actions</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btaction#class-btaction\"><span class=\"std std-ref\">BTAction</span></a>"
|
||
}
|
||
},
|
||
"A Behavior Tree is usually processed each frame. It is traversed from top to bottom, with the control tasks determining the control flow. Each task has a <l1>_tick</l> method, which performs the task’s work and returns a status indicating its progress: <2/>, <3/>, or <4/>. <5/> and <6/> indicate the outcome of finished work, while <7/> status is returned when a task requires more than one tick to complete its job. These statuses determine how the tree progresses, with the <8/> status usually meaning that the tree will continue execution during the next frame.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"6\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"7\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"8\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 62,
|
||
"tpl": "A Behavior Tree is usually processed each frame. It is traversed from top to bottom, with the control tasks determining the control flow. Each task has a <l1>_tick</l> method, which performs the task’s work and returns a status indicating its progress: <2/>, <3/>, or <4/>. <5/> and <6/> indicate the outcome of finished work, while <7/> status is returned when a task requires more than one tick to complete its job. These statuses determine how the tree progresses, with the <8/> status usually meaning that the tree will continue execution during the next frame.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"6": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"7": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"8": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"There are <i>four types of tasks</i>:\u0000{}": {
|
||
"uid": 63,
|
||
"tpl": "There are <i>four types of tasks</i>:",
|
||
"markers": {}
|
||
},
|
||
"<b>Actions</b> are leaf tasks that perform the actual work.\u0000{}": {
|
||
"uid": 64,
|
||
"tpl": "<b>Actions</b> are leaf tasks that perform the actual work.",
|
||
"markers": {}
|
||
},
|
||
"Examples: <l1>PlayAnimation</l>, <l2>Wait</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayanimation#class-btplayanimation\\\"><span class=\\\"std std-ref\\\">PlayAnimation</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btwait#class-btwait\\\"><span class=\\\"std std-ref\\\">Wait</span></a>\"}": {
|
||
"uid": 65,
|
||
"tpl": "Examples: <l1>PlayAnimation</l>, <l2>Wait</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btplayanimation#class-btplayanimation\"><span class=\"std std-ref\">PlayAnimation</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btwait#class-btwait\"><span class=\"std std-ref\">Wait</span></a>"
|
||
}
|
||
},
|
||
"<b>Conditions</b> are leaf tasks that conduct various checks.\u0000{}": {
|
||
"uid": 66,
|
||
"tpl": "<b>Conditions</b> are leaf tasks that conduct various checks.",
|
||
"markers": {}
|
||
},
|
||
"Examples: <l1>CheckVar</l>, <l2>InRange</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcheckvar#class-btcheckvar\\\"><span class=\\\"std std-ref\\\">CheckVar</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/custom-tasks#example-in-range\\\"><span class=\\\"std std-ref\\\">InRange</span></a>\"}": {
|
||
"uid": 67,
|
||
"tpl": "Examples: <l1>CheckVar</l>, <l2>InRange</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btcheckvar#class-btcheckvar\"><span class=\"std std-ref\">CheckVar</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-behavior-trees/custom-tasks#example-in-range\"><span class=\"std std-ref\">InRange</span></a>"
|
||
}
|
||
},
|
||
"<b>Composites</b> can have one or more child tasks, and dictate the execution flow of their children.\u0000{}": {
|
||
"uid": 68,
|
||
"tpl": "<b>Composites</b> can have one or more child tasks, and dictate the execution flow of their children.",
|
||
"markers": {}
|
||
},
|
||
"Examples: <l1>Sequence</l>, <l2>Selector</l>, <l3>Parallel</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">Sequence</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">Selector</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btparallel#class-btparallel\\\"><span class=\\\"std std-ref\\\">Parallel</span></a>\"}": {
|
||
"uid": 69,
|
||
"tpl": "Examples: <l1>Sequence</l>, <l2>Selector</l>, <l3>Parallel</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">Sequence</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">Selector</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btparallel#class-btparallel\"><span class=\"std std-ref\">Parallel</span></a>"
|
||
}
|
||
},
|
||
"<b>Decorators</b> can only have a single child and they change how their child task operates.\u0000{}": {
|
||
"uid": 70,
|
||
"tpl": "<b>Decorators</b> can only have a single child and they change how their child task operates.",
|
||
"markers": {}
|
||
},
|
||
"Examples: <l1>AlwaysSucceed</l>, <l2>Invert</l>, <l3>TimeLimit</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btalwayssucceed#class-btalwayssucceed\\\"><span class=\\\"std std-ref\\\">AlwaysSucceed</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinvert#class-btinvert\\\"><span class=\\\"std std-ref\\\">Invert</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttimelimit#class-bttimelimit\\\"><span class=\\\"std std-ref\\\">TimeLimit</span></a>\"}": {
|
||
"uid": 71,
|
||
"tpl": "Examples: <l1>AlwaysSucceed</l>, <l2>Invert</l>, <l3>TimeLimit</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btalwayssucceed#class-btalwayssucceed\"><span class=\"std std-ref\">AlwaysSucceed</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btinvert#class-btinvert\"><span class=\"std std-ref\">Invert</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bttimelimit#class-bttimelimit\"><span class=\"std std-ref\">TimeLimit</span></a>"
|
||
}
|
||
},
|
||
"<l1>Sequence</l> is one of the core composite tasks. It executes its child tasks sequentially, from first to last, until one of them returns <2/>, or all of them result in <3/>. In other words, if any child task results in <4/>, the <l5>Sequence</l> execution will be aborted, and the <l6>Sequence</l> itself will return <7/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">Sequence</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">Sequence</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">Sequence</span></a>\", \"7\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 72,
|
||
"tpl": "<l1>Sequence</l> is one of the core composite tasks. It executes its child tasks sequentially, from first to last, until one of them returns <2/>, or all of them result in <3/>. In other words, if any child task results in <4/>, the <l5>Sequence</l> execution will be aborted, and the <l6>Sequence</l> itself will return <7/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">Sequence</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">Sequence</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">Sequence</span></a>",
|
||
"7": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<l1>Selector</l> is another essential composite task. It executes its child tasks sequentially, from first to last, until one of them returns <2/> or all of them result in <3/>. In other words, when a child task results in <4/>, it moves on to the next one until it finds the one that returns <5/>. Once a child task results in <6/>, the <l7>Selector</l> stops and also returns <8/>. The purpose of the <l9>Selector</l> is to find a child that succeeds.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">Selector</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"6\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">Selector</span></a>\", \"8\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"9\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">Selector</span></a>\"}": {
|
||
"uid": 73,
|
||
"tpl": "<l1>Selector</l> is another essential composite task. It executes its child tasks sequentially, from first to last, until one of them returns <2/> or all of them result in <3/>. In other words, when a child task results in <4/>, it moves on to the next one until it finds the one that returns <5/>. Once a child task results in <6/>, the <l7>Selector</l> stops and also returns <8/>. The purpose of the <l9>Selector</l> is to find a child that succeeds.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">Selector</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"6": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">Selector</span></a>",
|
||
"8": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"9": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">Selector</span></a>"
|
||
}
|
||
},
|
||
"Behavior Trees handle conditional logic using <b>condition tasks</b>. These tasks check for specific conditions and return either <1/> or <2/> based on the state of the agent or its environment (e.g., “IsLowOnHealth”, “IsTargetInSight”). Conditions can be used together with <l3>Sequence</l> and <l4>Selector</l> to craft your decision-making logic.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">Sequence</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">Selector</span></a>\"}": {
|
||
"uid": 74,
|
||
"tpl": "Behavior Trees handle conditional logic using <b>condition tasks</b>. These tasks check for specific conditions and return either <1/> or <2/> based on the state of the agent or its environment (e.g., “IsLowOnHealth”, “IsTargetInSight”). Conditions can be used together with <l3>Sequence</l> and <l4>Selector</l> to craft your decision-making logic.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">Sequence</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">Selector</span></a>"
|
||
}
|
||
},
|
||
"<b>🛈 Note:</b> To <l1>create your own conditions</l>, extend the <l2>BTCondition</l> class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/custom-tasks#custom-tasks\\\"><span class=\\\"std std-ref\\\">create your own conditions</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcondition#class-btcondition\\\"><span class=\\\"std std-ref\\\">BTCondition</span></a>\"}": {
|
||
"uid": 75,
|
||
"tpl": "<b>🛈 Note:</b> To <l1>create your own conditions</l>, extend the <l2>BTCondition</l> class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-behavior-trees/custom-tasks#custom-tasks\"><span class=\"std std-ref\">create your own conditions</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btcondition#class-btcondition\"><span class=\"std std-ref\">BTCondition</span></a>"
|
||
}
|
||
},
|
||
"Check out the <l1>BTTask</l> class documentation, which provides the foundation for various building blocks of Behavior Trees.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 76,
|
||
"tpl": "Check out the <l1>BTTask</l> class documentation, which provides the foundation for various building blocks of Behavior Trees.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"Creating Behavior Trees\u0000{}": {
|
||
"uid": 77,
|
||
"tpl": "Creating Behavior Trees",
|
||
"markers": {}
|
||
},
|
||
"This chapter describes how to create and debug behavior trees.\u0000{}": {
|
||
"uid": 78,
|
||
"tpl": "This chapter describes how to create and debug behavior trees.",
|
||
"markers": {}
|
||
},
|
||
"Add a Behavior Tree to an agent\u0000{}": {
|
||
"uid": 79,
|
||
"tpl": "Add a Behavior Tree to an agent",
|
||
"markers": {}
|
||
},
|
||
"Follow these steps to add a behavior tree to a new or existing agent:\u0000{}": {
|
||
"uid": 80,
|
||
"tpl": "Follow these steps to add a behavior tree to a new or existing agent:",
|
||
"markers": {}
|
||
},
|
||
"Make a scene file for your agent, or open an existing scene.\u0000{}": {
|
||
"uid": 81,
|
||
"tpl": "Make a scene file for your agent, or open an existing scene.",
|
||
"markers": {}
|
||
},
|
||
"Add a <l1>BTPlayer</l> node to your scene.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\"}": {
|
||
"uid": 82,
|
||
"tpl": "Add a <l1>BTPlayer</l> node to your scene.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>"
|
||
}
|
||
},
|
||
"Select <l1>BTPlayer</l>, and create a new behavior tree in the inspector.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\"}": {
|
||
"uid": 83,
|
||
"tpl": "Select <l1>BTPlayer</l>, and create a new behavior tree in the inspector.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>"
|
||
}
|
||
},
|
||
"Optionally, you can save the behavior tree to a file using the property’s context menu.\u0000{}": {
|
||
"uid": 84,
|
||
"tpl": "Optionally, you can save the behavior tree to a file using the property’s context menu.",
|
||
"markers": {}
|
||
},
|
||
"Click the behavior tree property to open it in the LimboAI editor.\u0000{}": {
|
||
"uid": 85,
|
||
"tpl": "Click the behavior tree property to open it in the LimboAI editor.",
|
||
"markers": {}
|
||
},
|
||
"Debugging Behavior Trees\u0000{}": {
|
||
"uid": 86,
|
||
"tpl": "Debugging Behavior Trees",
|
||
"markers": {}
|
||
},
|
||
"In Godot Engine, follow to “Bottom Panel > Debugger > LimboAI” tab. With the LimboAI debugger, you can inspect any currently active behavior tree within the running project. The debugger can be detached from the main editor window, which can be particularly useful if you have a HiDPI or a secondary display.\u0000{}": {
|
||
"uid": 87,
|
||
"tpl": "In Godot Engine, follow to “Bottom Panel > Debugger > LimboAI” tab. With the LimboAI debugger, you can inspect any currently active behavior tree within the running project. The debugger can be detached from the main editor window, which can be particularly useful if you have a HiDPI or a secondary display.",
|
||
"markers": {}
|
||
},
|
||
"Inspecting task properties and blackboard\u0000{}": {
|
||
"uid": 88,
|
||
"tpl": "Inspecting task properties and blackboard",
|
||
"markers": {}
|
||
},
|
||
"When you click on a task in the LimboAI debugger, its properties are shown in the remote Inspector panel, including the <l1>Blackboard</l> reference. Click the <l2>Blackboard</l> to open it and view all variables across the full scope chain, grouped by scope. You can also edit variable values live, which can be useful for testing and debugging your game’s AI.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 89,
|
||
"tpl": "When you click on a task in the LimboAI debugger, its properties are shown in the remote Inspector panel, including the <l1>Blackboard</l> reference. Click the <l2>Blackboard</l> to open it and view all variables across the full scope chain, grouped by scope. You can also edit variable values live, which can be useful for testing and debugging your game’s AI.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Creating custom tasks\u0000{}": {
|
||
"uid": 90,
|
||
"tpl": "Creating custom tasks",
|
||
"markers": {}
|
||
},
|
||
"By default, user tasks should be placed in the <1/> directory. You can set an alternative location for user tasks in the <2/> (To see those options, <3/> should be enabled in the Project Settings).\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">res://ai/tasks</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Project</span> <span class=\\\"pre\\\">Settings</span> <span class=\\\"pre\\\">\\u2192</span> <span class=\\\"pre\\\">Limbo</span> <span class=\\\"pre\\\">AI</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Advanced</span> <span class=\\\"pre\\\">Settings</span></code>\"}": {
|
||
"uid": 91,
|
||
"tpl": "By default, user tasks should be placed in the <1/> directory. You can set an alternative location for user tasks in the <2/> (To see those options, <3/> should be enabled in the Project Settings).",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">res://ai/tasks</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Project</span> <span class=\"pre\">Settings</span> <span class=\"pre\">→</span> <span class=\"pre\">Limbo</span> <span class=\"pre\">AI</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Advanced</span> <span class=\"pre\">Settings</span></code>"
|
||
}
|
||
},
|
||
"Each subdirectory within the user tasks directory is treated as a category. Therefore, if you create a subdirectory named “motion_and_physics,” your custom tasks in that directory will automatically be categorized under “Motion And Physics.”\u0000{}": {
|
||
"uid": 92,
|
||
"tpl": "Each subdirectory within the user tasks directory is treated as a category. Therefore, if you create a subdirectory named “motion_and_physics,” your custom tasks in that directory will automatically be categorized under “Motion And Physics.”",
|
||
"markers": {}
|
||
},
|
||
"When creating custom tasks, <b>extend one of the following</b> base classes: <l1>BTAction</l>, <l2>BTCondition</l>, <l3>BTDecorator</l>, <l4>BTComposite</l>. More on task types you can read in the <l5>Introduction to Behavior Trees</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btaction#class-btaction\\\"><span class=\\\"std std-ref\\\">BTAction</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcondition#class-btcondition\\\"><span class=\\\"std std-ref\\\">BTCondition</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdecorator#class-btdecorator\\\"><span class=\\\"std std-ref\\\">BTDecorator</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcomposite#class-btcomposite\\\"><span class=\\\"std std-ref\\\">BTComposite</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/introduction#introduction\\\"><span class=\\\"std std-ref\\\">Introduction to Behavior Trees</span></a>\"}": {
|
||
"uid": 93,
|
||
"tpl": "When creating custom tasks, <b>extend one of the following</b> base classes: <l1>BTAction</l>, <l2>BTCondition</l>, <l3>BTDecorator</l>, <l4>BTComposite</l>. More on task types you can read in the <l5>Introduction to Behavior Trees</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btaction#class-btaction\"><span class=\"std std-ref\">BTAction</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btcondition#class-btcondition\"><span class=\"std std-ref\">BTCondition</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btdecorator#class-btdecorator\"><span class=\"std std-ref\">BTDecorator</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btcomposite#class-btcomposite\"><span class=\"std std-ref\">BTComposite</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-behavior-trees/introduction#introduction\"><span class=\"std std-ref\">Introduction to Behavior Trees</span></a>"
|
||
}
|
||
},
|
||
"<b>🛈 Note:</b> To help you write new tasks, you can add a script template to your project using “Misc → Create script template” menu option.\u0000{}": {
|
||
"uid": 94,
|
||
"tpl": "<b>🛈 Note:</b> To help you write new tasks, you can add a script template to your project using “Misc → Create script template” menu option.",
|
||
"markers": {}
|
||
},
|
||
"Using the <l1>Blackboard</l> is covered in <l2>Accessing the Blackboard in a Task</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/using-blackboard#accessing-blackboard\\\"><span class=\\\"std std-ref\\\">Accessing the Blackboard in a Task</span></a>\"}": {
|
||
"uid": 95,
|
||
"tpl": "Using the <l1>Blackboard</l> is covered in <l2>Accessing the Blackboard in a Task</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-behavior-trees/using-blackboard#accessing-blackboard\"><span class=\"std std-ref\">Accessing the Blackboard in a Task</span></a>"
|
||
}
|
||
},
|
||
"Task anatomy\u0000{}": {
|
||
"uid": 96,
|
||
"tpl": "Task anatomy",
|
||
"markers": {}
|
||
},
|
||
"Example 1: A simple action\u0000{}": {
|
||
"uid": 97,
|
||
"tpl": "Example 1: A simple action",
|
||
"markers": {}
|
||
},
|
||
"Example 2: InRange condition\u0000{}": {
|
||
"uid": 98,
|
||
"tpl": "Example 2: InRange condition",
|
||
"markers": {}
|
||
},
|
||
"Creating tasks in C#\u0000{}": {
|
||
"uid": 99,
|
||
"tpl": "Creating tasks in C#",
|
||
"markers": {}
|
||
},
|
||
"You can use the following script template for custom tasks:\u0000{}": {
|
||
"uid": 100,
|
||
"tpl": "You can use the following script template for custom tasks:",
|
||
"markers": {}
|
||
},
|
||
"Sharing data using Blackboard\u0000{}": {
|
||
"uid": 101,
|
||
"tpl": "Sharing data using Blackboard",
|
||
"markers": {}
|
||
},
|
||
"To share data between different tasks and states, we employ a feature known as the <l1>Blackboard</l>. The <l2>Blackboard</l> serves as a central repository where tasks and states can store and retrieve named variables, allowing for seamless data interchange. Each instance of a behavior tree or a state machine gets its own dedicated <l3>Blackboard</l>. It has the capability to store various data types, including objects and resources.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 102,
|
||
"tpl": "To share data between different tasks and states, we employ a feature known as the <l1>Blackboard</l>. The <l2>Blackboard</l> serves as a central repository where tasks and states can store and retrieve named variables, allowing for seamless data interchange. Each instance of a behavior tree or a state machine gets its own dedicated <l3>Blackboard</l>. It has the capability to store various data types, including objects and resources.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Using the <l1>Blackboard</l>, you can easily share data in your behavior trees, making the tasks in the behavior tree more flexible.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 103,
|
||
"tpl": "Using the <l1>Blackboard</l>, you can easily share data in your behavior trees, making the tasks in the behavior tree more flexible.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Accessing the Blackboard in a Task\u0000{}": {
|
||
"uid": 104,
|
||
"tpl": "Accessing the Blackboard in a Task",
|
||
"markers": {}
|
||
},
|
||
"Every <l1>BTTask</l> has access to the <l2>Blackboard</l>, providing a straightforward mechanism for data exchange. Here’s an example of how you can interact with the <l3>Blackboard</l> in GDScript:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 105,
|
||
"tpl": "Every <l1>BTTask</l> has access to the <l2>Blackboard</l>, providing a straightforward mechanism for data exchange. Here’s an example of how you can interact with the <l3>Blackboard</l> in GDScript:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"If you are accessing a variable that holds an object instance, and it is expected that the instance may be null or freed, you can do it like this:\u0000{}": {
|
||
"uid": 106,
|
||
"tpl": "If you are accessing a variable that holds an object instance, and it is expected that the instance may be null or freed, you can do it like this:",
|
||
"markers": {}
|
||
},
|
||
"It is recommended to suffix variable name properties with <1/>, like in the example above, which enables the inspector to provide a more convenient property editor for the variable. This editor allows you to select or add the variable to the blackboard plan, and provides a warning icon if the variable does not exist in the blackboard plan.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">_var</span></code>\"}": {
|
||
"uid": 107,
|
||
"tpl": "It is recommended to suffix variable name properties with <1/>, like in the example above, which enables the inspector to provide a more convenient property editor for the variable. This editor allows you to select or add the variable to the blackboard plan, and provides a warning icon if the variable does not exist in the blackboard plan.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">_var</span></code>"
|
||
}
|
||
},
|
||
"<b>🛈 Note:</b> The variable doesn’t need to exist when you set it in code.\u0000{}": {
|
||
"uid": 108,
|
||
"tpl": "<b>🛈 Note:</b> The variable doesn’t need to exist when you set it in code.",
|
||
"markers": {}
|
||
},
|
||
"Editing the Blackboard Plan\u0000{}": {
|
||
"uid": 109,
|
||
"tpl": "Editing the Blackboard Plan",
|
||
"markers": {}
|
||
},
|
||
"The Blackboard Plan, associated with each <l1>BehaviorTree</l> resource, dictates how the <l2>Blackboard</l> initializes for each new instance of the <l3>BehaviorTree</l>. BlackboardPlan resource stores default values, type information, and data bindings necessary for <l4>BehaviorTree</l> initialization.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 110,
|
||
"tpl": "The Blackboard Plan, associated with each <l1>BehaviorTree</l> resource, dictates how the <l2>Blackboard</l> initializes for each new instance of the <l3>BehaviorTree</l>. BlackboardPlan resource stores default values, type information, and data bindings necessary for <l4>BehaviorTree</l> initialization.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"To add, modify, or remove variables from the Blackboard Plan, follow these steps:\u0000{}": {
|
||
"uid": 111,
|
||
"tpl": "To add, modify, or remove variables from the Blackboard Plan, follow these steps:",
|
||
"markers": {}
|
||
},
|
||
"Open the LimboAI editor and load the behavior tree you want to edit.\u0000{}": {
|
||
"uid": 112,
|
||
"tpl": "Open the LimboAI editor and load the behavior tree you want to edit.",
|
||
"markers": {}
|
||
},
|
||
"In the editor, click on the small button located inside the tab. This will open the <l1>BlackboardPlan</l> in the Inspector.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 113,
|
||
"tpl": "In the editor, click on the small button located inside the tab. This will open the <l1>BlackboardPlan</l> in the Inspector.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"In the Inspector, click the “Manage…” button to show the blackboard plan editor.\u0000{}": {
|
||
"uid": 114,
|
||
"tpl": "In the Inspector, click the “Manage…” button to show the blackboard plan editor.",
|
||
"markers": {}
|
||
},
|
||
"In the blackboard plan editor, you can add, remove, or reorder variables, and modify their data type and hint.\u0000{}": {
|
||
"uid": 115,
|
||
"tpl": "In the blackboard plan editor, you can add, remove, or reorder variables, and modify their data type and hint.",
|
||
"markers": {}
|
||
},
|
||
"The hint provides additional information about the variable to the Inspector, such as minimum and maximum values for an integer variable. Learn more about <l1>property hints in the official Godot documentation</l>.\u0000{\"1\": \"<a class=\\\"reference external\\\" href=\\\"https://docs.godotengine.org/en/stable/classes/class_%40globalscope.html#enum-globalscope-propertyhint\\\">property hints in the official Godot documentation</a>\"}": {
|
||
"uid": 116,
|
||
"tpl": "The hint provides additional information about the variable to the Inspector, such as minimum and maximum values for an integer variable. Learn more about <l1>property hints in the official Godot documentation</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference external\" href=\"https://docs.godotengine.org/en/stable/classes/class_%40globalscope.html#enum-globalscope-propertyhint\">property hints in the official Godot documentation</a>"
|
||
}
|
||
},
|
||
"You can specify the default values of the variables directly in the Inspector.\u0000{}": {
|
||
"uid": 117,
|
||
"tpl": "You can specify the default values of the variables directly in the Inspector.",
|
||
"markers": {}
|
||
},
|
||
"Overriding variables in BTPlayer\u0000{}": {
|
||
"uid": 118,
|
||
"tpl": "Overriding variables in BTPlayer",
|
||
"markers": {}
|
||
},
|
||
"Each <l1>BTPlayer</l> node also has a “Blackboard Plan” property, providing the ability to override values of the BehaviorTree’s blackboard variables. These overrides are specific to the BTPlayer’s scene and do not impact other scenes using the same <l2>BehaviorTree</l>. To modify these values:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 119,
|
||
"tpl": "Each <l1>BTPlayer</l> node also has a “Blackboard Plan” property, providing the ability to override values of the BehaviorTree’s blackboard variables. These overrides are specific to the BTPlayer’s scene and do not impact other scenes using the same <l2>BehaviorTree</l>. To modify these values:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Select the BTPlayer node in the scene tree.\u0000{}": {
|
||
"uid": 120,
|
||
"tpl": "Select the BTPlayer node in the scene tree.",
|
||
"markers": {}
|
||
},
|
||
"In the Inspector, locate the “Blackboard Plan” property.\u0000{}": {
|
||
"uid": 121,
|
||
"tpl": "In the Inspector, locate the “Blackboard Plan” property.",
|
||
"markers": {}
|
||
},
|
||
"Override the desired values to tailor the blackboard variables for the specific scene.\u0000{}": {
|
||
"uid": 122,
|
||
"tpl": "Override the desired values to tailor the blackboard variables for the specific scene.",
|
||
"markers": {}
|
||
},
|
||
"Task parameters\u0000{}": {
|
||
"uid": 123,
|
||
"tpl": "Task parameters",
|
||
"markers": {}
|
||
},
|
||
"In some cases, it can be beneficial to allow behavior tree tasks to export parameters that can either be <b>bound to a blackboard variable or specified directly</b> by the user. For this purpose, LimboAI provides special parameter types that begin with “BB”, such as <l1>BBInt</l>, <l2>BBBool</l>, <l3>BBString</l>, <l4>BBFloat</l>, <l5>BBNode</l>, and more. For a complete list, please refer to the <l6>BBParam</l> class reference.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbint#class-bbint\\\"><span class=\\\"std std-ref\\\">BBInt</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbbool#class-bbbool\\\"><span class=\\\"std std-ref\\\">BBBool</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbstring#class-bbstring\\\"><span class=\\\"std std-ref\\\">BBString</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbfloat#class-bbfloat\\\"><span class=\\\"std std-ref\\\">BBFloat</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 124,
|
||
"tpl": "In some cases, it can be beneficial to allow behavior tree tasks to export parameters that can either be <b>bound to a blackboard variable or specified directly</b> by the user. For this purpose, LimboAI provides special parameter types that begin with “BB”, such as <l1>BBInt</l>, <l2>BBBool</l>, <l3>BBString</l>, <l4>BBFloat</l>, <l5>BBNode</l>, and more. For a complete list, please refer to the <l6>BBParam</l> class reference.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbint#class-bbint\"><span class=\"std std-ref\">BBInt</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbbool#class-bbbool\"><span class=\"std std-ref\">BBBool</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bbstring#class-bbstring\"><span class=\"std std-ref\">BBString</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_bbfloat#class-bbfloat\"><span class=\"std std-ref\">BBFloat</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"Usage example:\u0000{}": {
|
||
"uid": 125,
|
||
"tpl": "Usage example:",
|
||
"markers": {}
|
||
},
|
||
"Connecting variables in BTs to HSMs: Variable mapping\u0000{}": {
|
||
"uid": 126,
|
||
"tpl": "Connecting variables in BTs to HSMs: Variable mapping",
|
||
"markers": {}
|
||
},
|
||
"Each <l1>BTState</l> creates a new blackboard scope for its BehaviorTree instance. Because BehaviorTrees are reusable resources that can run in different contexts or on different agents, they do not automatically see variables defined in the HSM. At runtime, HSM variables are usually accessible inside the BT via the parent scope blackboard, but the recommended way to access them is through <b>mapping</b>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\"}": {
|
||
"uid": 127,
|
||
"tpl": "Each <l1>BTState</l> creates a new blackboard scope for its BehaviorTree instance. Because BehaviorTrees are reusable resources that can run in different contexts or on different agents, they do not automatically see variables defined in the HSM. At runtime, HSM variables are usually accessible inside the BT via the parent scope blackboard, but the recommended way to access them is through <b>mapping</b>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>"
|
||
}
|
||
},
|
||
"Note\u0000{}": {
|
||
"uid": 128,
|
||
"tpl": "Note",
|
||
"markers": {}
|
||
},
|
||
"To learn more about scopes, see <l1>Blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 129,
|
||
"tpl": "To learn more about scopes, see <l1>Blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"When both the BehaviorTree and the HSM declare variables in their respective <l1>BlackboardPlan</l> resources, the editor provides a <b>Mapping</b> section in the BlackboardPlan inspector. Mapping is the intended and recommended way to connect variables between related plans.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 130,
|
||
"tpl": "When both the BehaviorTree and the HSM declare variables in their respective <l1>BlackboardPlan</l> resources, the editor provides a <b>Mapping</b> section in the BlackboardPlan inspector. Mapping is the intended and recommended way to connect variables between related plans.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"Key points about mapping\u0000{}": {
|
||
"uid": 131,
|
||
"tpl": "Key points about mapping",
|
||
"markers": {}
|
||
},
|
||
"Mapping connects two variables so they behave as a single logical variable at runtime.\u0000{}": {
|
||
"uid": 132,
|
||
"tpl": "Mapping connects two variables so they behave as a single logical variable at runtime.",
|
||
"markers": {}
|
||
},
|
||
"Linked variables are updated immediately in both scopes — they literally share the same state in memory (no polling or copying).\u0000{}": {
|
||
"uid": 133,
|
||
"tpl": "Linked variables are updated immediately in both scopes — they literally share the same state in memory (no polling or copying).",
|
||
"markers": {}
|
||
},
|
||
"Mapping is explicit: you decide which variables the BT exposes as inputs and outputs.\u0000{}": {
|
||
"uid": 134,
|
||
"tpl": "Mapping is explicit: you decide which variables the BT exposes as inputs and outputs.",
|
||
"markers": {}
|
||
},
|
||
"Linkage is bidirectional — there is no distinction between input and output.\u0000{}": {
|
||
"uid": 135,
|
||
"tpl": "Linkage is bidirectional — there is no distinction between input and output.",
|
||
"markers": {}
|
||
},
|
||
"Mapping does not create new variables automatically — the variables must already exist in both blackboard plans before they can be linked.\u0000{}": {
|
||
"uid": 136,
|
||
"tpl": "Mapping does not create new variables automatically — the variables must already exist in both blackboard plans before they can be linked.",
|
||
"markers": {}
|
||
},
|
||
"Inspector workflow\u0000{}": {
|
||
"uid": 137,
|
||
"tpl": "Inspector workflow",
|
||
"markers": {}
|
||
},
|
||
"Define the required variables in each BlackboardPlan (HSM plan and BT plan, for example).\u0000{}": {
|
||
"uid": 138,
|
||
"tpl": "Define the required variables in each BlackboardPlan (HSM plan and BT plan, for example).",
|
||
"markers": {}
|
||
},
|
||
"Select the <l1>BTState</l> node in the scene or a <l2>BTSubtree</l> inside a behavior tree.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsubtree#class-btsubtree\\\"><span class=\\\"std std-ref\\\">BTSubtree</span></a>\"}": {
|
||
"uid": 139,
|
||
"tpl": "Select the <l1>BTState</l> node in the scene or a <l2>BTSubtree</l> inside a behavior tree.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btsubtree#class-btsubtree\"><span class=\"std std-ref\">BTSubtree</span></a>"
|
||
}
|
||
},
|
||
"In the Inspector, select the Blackboard Plan property.\u0000{}": {
|
||
"uid": 140,
|
||
"tpl": "In the Inspector, select the Blackboard Plan property.",
|
||
"markers": {}
|
||
},
|
||
"In the BlackboardPlan resource inspector, locate the <b>Mapping</b> section.\u0000{}": {
|
||
"uid": 141,
|
||
"tpl": "In the BlackboardPlan resource inspector, locate the <b>Mapping</b> section.",
|
||
"markers": {}
|
||
},
|
||
"Create mappings by pairing variables (<1/>).\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">BT</span> <span class=\\\"pre\\\">variable</span> <span class=\\\"pre\\\">\\u2194</span> <span class=\\\"pre\\\">parent</span> <span class=\\\"pre\\\">variable</span></code>\"}": {
|
||
"uid": 142,
|
||
"tpl": "Create mappings by pairing variables (<1/>).",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">BT</span> <span class=\"pre\">variable</span> <span class=\"pre\">↔</span> <span class=\"pre\">parent</span> <span class=\"pre\">variable</span></code>"
|
||
}
|
||
},
|
||
"On startup the mappings are applied, and the variables are automatically linked for the running instance.\u0000{}": {
|
||
"uid": 143,
|
||
"tpl": "On startup the mappings are applied, and the variables are automatically linked for the running instance.",
|
||
"markers": {}
|
||
},
|
||
"Programmatic alternative: linking variables in code\u0000{}": {
|
||
"uid": 144,
|
||
"tpl": "Programmatic alternative: linking variables in code",
|
||
"markers": {}
|
||
},
|
||
"You can also link variables directly in code using <l1>Blackboard.link_var</l>:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard-method-link-var\\\"><span class=\\\"std std-ref\\\">Blackboard.link_var</span></a>\"}": {
|
||
"uid": 145,
|
||
"tpl": "You can also link variables directly in code using <l1>Blackboard.link_var</l>:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard-method-link-var\"><span class=\"std std-ref\">Blackboard.link_var</span></a>"
|
||
}
|
||
},
|
||
"Best practices\u0000{}": {
|
||
"uid": 146,
|
||
"tpl": "Best practices",
|
||
"markers": {}
|
||
},
|
||
"Declare all BT dependencies in the BT’s BlackboardPlan instead of relying on parent scopes.\u0000{}": {
|
||
"uid": 147,
|
||
"tpl": "Declare all BT dependencies in the BT’s BlackboardPlan instead of relying on parent scopes.",
|
||
"markers": {}
|
||
},
|
||
"Use <b>Mapping</b> to explicitly declare which variables should be shared with the HSM.\u0000{}": {
|
||
"uid": 148,
|
||
"tpl": "Use <b>Mapping</b> to explicitly declare which variables should be shared with the HSM.",
|
||
"markers": {}
|
||
},
|
||
"Prefer the inspector-based Mapping workflow for clarity and editor support; use <1/> only when runtime or programmatic setup is required.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">link_var</span></code>\"}": {
|
||
"uid": 149,
|
||
"tpl": "Prefer the inspector-based Mapping workflow for clarity and editor support; use <1/> only when runtime or programmatic setup is required.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">link_var</span></code>"
|
||
}
|
||
},
|
||
"Avoid writing to <1/> from inside BT tasks unless you have a very specific reason and accept the coupling it introduces.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">blackboard.get_parent()</span></code>\"}": {
|
||
"uid": 150,
|
||
"tpl": "Avoid writing to <1/> from inside BT tasks unless you have a very specific reason and accept the coupling it introduces.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">blackboard.get_parent()</span></code>"
|
||
}
|
||
},
|
||
"Advanced topic: Blackboard scopes\u0000{}": {
|
||
"uid": 151,
|
||
"tpl": "Advanced topic: Blackboard scopes",
|
||
"markers": {}
|
||
},
|
||
"The <l1>Blackboard</l> in LimboAI can act as a parent scope for another <l2>Blackboard</l>. This means that if a specific variable is not found in the active scope, the system will look in the parent <l3>Blackboard</l> to find it. This creates a “blackboard scope chain,” where each <l4>Blackboard</l> can have its own parent scope, and there is no limit to how many blackboards can be in this chain. It’s important to note that the <l5>Blackboard</l> doesn’t modify values in the parent scopes.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 152,
|
||
"tpl": "The <l1>Blackboard</l> in LimboAI can act as a parent scope for another <l2>Blackboard</l>. This means that if a specific variable is not found in the active scope, the system will look in the parent <l3>Blackboard</l> to find it. This creates a “blackboard scope chain,” where each <l4>Blackboard</l> can have its own parent scope, and there is no limit to how many blackboards can be in this chain. It’s important to note that the <l5>Blackboard</l> doesn’t modify values in the parent scopes.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Scopes are created automatically to prevent naming collisions between contextually separate environments:\u0000{}": {
|
||
"uid": 153,
|
||
"tpl": "Scopes are created automatically to prevent naming collisions between contextually separate environments:",
|
||
"markers": {}
|
||
},
|
||
"Within <l1>BTNewScope</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btnewscope#class-btnewscope\\\"><span class=\\\"std std-ref\\\">BTNewScope</span></a>\"}": {
|
||
"uid": 154,
|
||
"tpl": "Within <l1>BTNewScope</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btnewscope#class-btnewscope\"><span class=\"std std-ref\">BTNewScope</span></a>"
|
||
}
|
||
},
|
||
"Under <l1>BTSubtree</l> decorators.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsubtree#class-btsubtree\\\"><span class=\\\"std std-ref\\\">BTSubtree</span></a>\"}": {
|
||
"uid": 155,
|
||
"tpl": "Under <l1>BTSubtree</l> decorators.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btsubtree#class-btsubtree\"><span class=\"std std-ref\">BTSubtree</span></a>"
|
||
}
|
||
},
|
||
"With <l1>LimboState</l> that have a non-empty blackboard plan defined.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 156,
|
||
"tpl": "With <l1>LimboState</l> that have a non-empty blackboard plan defined.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"Under <l1>LimboHSM</l> nodes: A new scope is created at the root level, and each <l2>BTState</l> child also receives its own separate scope.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\"}": {
|
||
"uid": 157,
|
||
"tpl": "Under <l1>LimboHSM</l> nodes: A new scope is created at the root level, and each <l2>BTState</l> child also receives its own separate scope.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>"
|
||
}
|
||
},
|
||
"Sharing data between several agents\u0000{}": {
|
||
"uid": 158,
|
||
"tpl": "Sharing data between several agents",
|
||
"markers": {}
|
||
},
|
||
"The blackboard scope mechanism can also be used for sharing data between several agents. In the following example, we have a group of agents, and we want to share a common target between them:\u0000{}": {
|
||
"uid": 159,
|
||
"tpl": "The blackboard scope mechanism can also be used for sharing data between several agents. In the following example, we have a group of agents, and we want to share a common target between them:",
|
||
"markers": {}
|
||
},
|
||
"In this example, <l1>blackboard.top()</l> accesses the root scope of the <l2>Blackboard</l> chain. We assign that scope to each agent in a group through code:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard-method-top\\\"><span class=\\\"std std-ref\\\">blackboard.top()</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 160,
|
||
"tpl": "In this example, <l1>blackboard.top()</l> accesses the root scope of the <l2>Blackboard</l> chain. We assign that scope to each agent in a group through code:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard-method-top\"><span class=\"std std-ref\">blackboard.top()</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"In conclusion, the <l1>Blackboard</l> scope chain not only prevents naming conflicts that can occur between state machines, behavior trees, and sub-trees, but it can also be used to share data between several agents.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 161,
|
||
"tpl": "In conclusion, the <l1>Blackboard</l> scope chain not only prevents naming conflicts that can occur between state machines, behavior trees, and sub-trees, but it can also be used to share data between several agents.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Debugging blackboard variables\u0000{}": {
|
||
"uid": 162,
|
||
"tpl": "Debugging blackboard variables",
|
||
"markers": {}
|
||
},
|
||
"When debugging a running project, you can inspect <l1>Blackboard</l> variables in the remote Inspector. Click on a task in the LimboAI debugger to view its properties, then click the <l2>Blackboard</l> reference to see all variables across the full scope chain, grouped by scope. Variables can be edited live to aid in debugging. For state machines, select a <l3>LimboState</l> node in the Remote Scene Tree to access its <l4>Blackboard</l> in the same way.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 163,
|
||
"tpl": "When debugging a running project, you can inspect <l1>Blackboard</l> variables in the remote Inspector. Click on a task in the LimboAI debugger to view its properties, then click the <l2>Blackboard</l> reference to see all variables across the full scope chain, grouped by scope. Variables can be edited live to aid in debugging. For state machines, select a <l3>LimboState</l> node in the Remote Scene Tree to access its <l4>Blackboard</l> in the same way.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Accessing nodes in the scene tree\u0000{}": {
|
||
"uid": 164,
|
||
"tpl": "Accessing nodes in the scene tree",
|
||
"markers": {}
|
||
},
|
||
"There are several ways to access nodes in the agent’s scene tree from a <l1>BTTask</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 165,
|
||
"tpl": "There are several ways to access nodes in the agent’s scene tree from a <l1>BTTask</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<b>🛈 Note:</b> The root node of the agent’s scene tree can be accessed with the <l1>scene_root</l> property.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask-property-scene-root\\\"><span class=\\\"std std-ref\\\">scene_root</span></a>\"}": {
|
||
"uid": 166,
|
||
"tpl": "<b>🛈 Note:</b> The root node of the agent’s scene tree can be accessed with the <l1>scene_root</l> property.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask-property-scene-root\"><span class=\"std std-ref\">scene_root</span></a>"
|
||
}
|
||
},
|
||
"With <1/> property\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">BBNode</span></code>\"}": {
|
||
"uid": 167,
|
||
"tpl": "With <1/> property",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">BBNode</span></code>"
|
||
}
|
||
},
|
||
"With <1/> property\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\"}": {
|
||
"uid": 168,
|
||
"tpl": "With <1/> property",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>"
|
||
}
|
||
},
|
||
"Using blackboard plan\u0000{}": {
|
||
"uid": 169,
|
||
"tpl": "Using blackboard plan",
|
||
"markers": {}
|
||
},
|
||
"You can <l1>create a blackboard variable</l> in the editor with the type <2/> and point it to the proper node in the <l3>BTPlayer</l> blackboard plan. By default, any <4/> variable will be replaced with the node instance when the blackboard is instantiated at runtime (see <l5>BlackboardPlan.prefetch_nodepath_vars</l>).\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-behavior-trees/using-blackboard#editing-plan\\\"><span class=\\\"std std-ref\\\">create a blackboard variable</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan-property-prefetch-nodepath-vars\\\"><span class=\\\"std std-ref\\\">BlackboardPlan.prefetch_nodepath_vars</span></a>\"}": {
|
||
"uid": 170,
|
||
"tpl": "You can <l1>create a blackboard variable</l> in the editor with the type <2/> and point it to the proper node in the <l3>BTPlayer</l> blackboard plan. By default, any <4/> variable will be replaced with the node instance when the blackboard is instantiated at runtime (see <l5>BlackboardPlan.prefetch_nodepath_vars</l>).",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-behavior-trees/using-blackboard#editing-plan\"><span class=\"std std-ref\">create a blackboard variable</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan-property-prefetch-nodepath-vars\"><span class=\"std std-ref\">BlackboardPlan.prefetch_nodepath_vars</span></a>"
|
||
}
|
||
},
|
||
"The property BTPlayer.prefetch_nodepath_vars should be set to <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 171,
|
||
"tpl": "The property BTPlayer.prefetch_nodepath_vars should be set to <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"Create State Machines\u0000{}": {
|
||
"uid": 172,
|
||
"tpl": "Create State Machines",
|
||
"markers": {}
|
||
},
|
||
"This guide will show how to set up and use a state machine using <l1>LimboHSM</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 173,
|
||
"tpl": "This guide will show how to set up and use a state machine using <l1>LimboHSM</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"Initialization\u0000{}": {
|
||
"uid": 174,
|
||
"tpl": "Initialization",
|
||
"markers": {}
|
||
},
|
||
"To use the <l1>LimboHSM</l> state machine, you first need to initialize it in your code. This is typically done in the <2/> function of your script. Here’s an example of how to do this:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">_ready</span></code>\"}": {
|
||
"uid": 175,
|
||
"tpl": "To use the <l1>LimboHSM</l> state machine, you first need to initialize it in your code. This is typically done in the <2/> function of your script. Here’s an example of how to do this:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">_ready</span></code>"
|
||
}
|
||
},
|
||
"In this example, we first declare the state machine and the states we want to use. Then, in the <1/> function, we add transitions between the states. Finally, we initialize the state machine and set it to active.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">_init_state_machine</span></code>\"}": {
|
||
"uid": 176,
|
||
"tpl": "In this example, we first declare the state machine and the states we want to use. Then, in the <1/> function, we add transitions between the states. Finally, we initialize the state machine and set it to active.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">_init_state_machine</span></code>"
|
||
}
|
||
},
|
||
"State example\u0000{}": {
|
||
"uid": 177,
|
||
"tpl": "State example",
|
||
"markers": {}
|
||
},
|
||
"You can define the behavior of a state in a script and attach it to the state node. Here’s an example of a state that plays an animation on an <1/> and waits for it to finish:\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 178,
|
||
"tpl": "You can define the behavior of a state in a script and attach it to the state node. Here’s an example of a state that plays an animation on an <1/> and waits for it to finish:",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"In this example, the <1/> method is called when the state is entered, and it plays the specified animation. The <2/> method is called every frame, and it checks if the animation is finished. If it is, it dispatches the <3/> event, which can result in a transition to the next state.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">_enter</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">_update</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">EVENT_FINISHED</span></code>\"}": {
|
||
"uid": 179,
|
||
"tpl": "In this example, the <1/> method is called when the state is entered, and it plays the specified animation. The <2/> method is called every frame, and it checks if the animation is finished. If it is, it dispatches the <3/> event, which can result in a transition to the next state.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">_enter</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">_update</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">EVENT_FINISHED</span></code>"
|
||
}
|
||
},
|
||
"Events and transitions\u0000{}": {
|
||
"uid": 180,
|
||
"tpl": "Events and transitions",
|
||
"markers": {}
|
||
},
|
||
"The <l1>LimboHSM</l> comes with an <b>event system</b> that helps to <b>decouple transitions</b> from the state implementations. A transition is associated with a specific event, a starting state, and a destination state, and it is performed automatically when such an event is dispatched.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 181,
|
||
"tpl": "The <l1>LimboHSM</l> comes with an <b>event system</b> that helps to <b>decouple transitions</b> from the state implementations. A transition is associated with a specific event, a starting state, and a destination state, and it is performed automatically when such an event is dispatched.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"To register a transition and associate it with a specific event, you can use the <l1>LimboHSM.add_transition</l> method:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm-method-add-transition\\\"><span class=\\\"std std-ref\\\">LimboHSM.add_transition</span></a>\"}": {
|
||
"uid": 182,
|
||
"tpl": "To register a transition and associate it with a specific event, you can use the <l1>LimboHSM.add_transition</l> method:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm-method-add-transition\"><span class=\"std std-ref\">LimboHSM.add_transition</span></a>"
|
||
}
|
||
},
|
||
"In this example, we’re registering a transition from the <1/> to the <2/> when the <3/> event is dispatched.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">idle_state</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">move_state</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">movement_started</span></code>\"}": {
|
||
"uid": 183,
|
||
"tpl": "In this example, we’re registering a transition from the <1/> to the <2/> when the <3/> event is dispatched.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">idle_state</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">move_state</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">movement_started</span></code>"
|
||
}
|
||
},
|
||
"A transition can be also associated with no particular starting state:\u0000{}": {
|
||
"uid": 184,
|
||
"tpl": "A transition can be also associated with no particular starting state:",
|
||
"markers": {}
|
||
},
|
||
"<b>Events are dispatched</b> with the <l1>LimboState.dispatch</l> method. It’s important to note that this method can be called from anywhere in the state machine hierarchy and outside of it. Events are <b>propagated from the leaf to the root</b> state. This means that if an event is consumed by a state, it won’t be propagated to its parent states.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-method-dispatch\\\"><span class=\\\"std std-ref\\\">LimboState.dispatch</span></a>\"}": {
|
||
"uid": 185,
|
||
"tpl": "<b>Events are dispatched</b> with the <l1>LimboState.dispatch</l> method. It’s important to note that this method can be called from anywhere in the state machine hierarchy and outside of it. Events are <b>propagated from the leaf to the root</b> state. This means that if an event is consumed by a state, it won’t be propagated to its parent states.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-method-dispatch\"><span class=\"std std-ref\">LimboState.dispatch</span></a>"
|
||
}
|
||
},
|
||
"States can also define <b>event handlers</b>, which are methods that react to specific events. These event handlers typically don’t result in a state transition; they are simply a mechanism for states to react to particular events. You can use the <l1>LimboState.add_event_handler</l> method to register event handlers in your states:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-method-add-event-handler\\\"><span class=\\\"std std-ref\\\">LimboState.add_event_handler</span></a>\"}": {
|
||
"uid": 186,
|
||
"tpl": "States can also define <b>event handlers</b>, which are methods that react to specific events. These event handlers typically don’t result in a state transition; they are simply a mechanism for states to react to particular events. You can use the <l1>LimboState.add_event_handler</l> method to register event handlers in your states:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-method-add-event-handler\"><span class=\"std std-ref\">LimboState.add_event_handler</span></a>"
|
||
}
|
||
},
|
||
"If the event handler returns <1/>, the event will be considered as consumed, and it won’t propagate further or result in a state transition.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 187,
|
||
"tpl": "If the event handler returns <1/>, the event will be considered as consumed, and it won’t propagate further or result in a state transition.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"State anatomy\u0000{}": {
|
||
"uid": 188,
|
||
"tpl": "State anatomy",
|
||
"markers": {}
|
||
},
|
||
"Using behavior trees with state machines\u0000{}": {
|
||
"uid": 189,
|
||
"tpl": "Using behavior trees with state machines",
|
||
"markers": {}
|
||
},
|
||
"The <l1>BTState</l> is a specialized state node in <l2>LimboHSM</l> that can host a behavior tree. When a <l3>BTState</l> is active, it executes the hosted behavior tree each frame, effectively using the behavior tree as its implementation.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\"}": {
|
||
"uid": 190,
|
||
"tpl": "The <l1>BTState</l> is a specialized state node in <l2>LimboHSM</l> that can host a behavior tree. When a <l3>BTState</l> is active, it executes the hosted behavior tree each frame, effectively using the behavior tree as its implementation.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>"
|
||
}
|
||
},
|
||
"This allows you to combine the power of behavior trees with the structure and control of state machines. Behavior trees are excellent for defining complex, hierarchical behaviors, while state machines are great for managing the flow and transitions between different behaviors.\u0000{}": {
|
||
"uid": 191,
|
||
"tpl": "This allows you to combine the power of behavior trees with the structure and control of state machines. Behavior trees are excellent for defining complex, hierarchical behaviors, while state machines are great for managing the flow and transitions between different behaviors.",
|
||
"markers": {}
|
||
},
|
||
"Once the <l1>LimboHSM</l> has been created, a <l2>BTState</l> can be created for a given <l3>LimboHSM</l>:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 192,
|
||
"tpl": "Once the <l1>LimboHSM</l> has been created, a <l2>BTState</l> can be created for a given <l3>LimboHSM</l>:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"Single-file state machine setup\u0000{}": {
|
||
"uid": 193,
|
||
"tpl": "Single-file state machine setup",
|
||
"markers": {}
|
||
},
|
||
"In certain scenarios, such as prototyping or during game jams, it’s practical to keep the state machine code in a single file. For such cases, <l1>LimboHSM</l> <b>supports delegation</b> and provides <b>chained methods</b> for easier setup. Let’s illustrate this with a practical code example:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 194,
|
||
"tpl": "In certain scenarios, such as prototyping or during game jams, it’s practical to keep the state machine code in a single file. For such cases, <l1>LimboHSM</l> <b>supports delegation</b> and provides <b>chained methods</b> for easier setup. Let’s illustrate this with a practical code example:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"Important classes\u0000{}": {
|
||
"uid": 195,
|
||
"tpl": "Important classes",
|
||
"markers": {}
|
||
},
|
||
"There are a lot of classes introduced in LimboAI. Here is a list of the most important ones you should know about:\u0000{}": {
|
||
"uid": 196,
|
||
"tpl": "There are a lot of classes introduced in LimboAI. Here is a list of the most important ones you should know about:",
|
||
"markers": {}
|
||
},
|
||
"BTTask\u0000{}": {
|
||
"uid": 197,
|
||
"tpl": "BTTask",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BT</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#class-bt\\\"><span class=\\\"std std-ref\\\">BT</span></a>\"}": {
|
||
"uid": 198,
|
||
"tpl": "<b>Inherits:</b> <l1>BT</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#class-bt\"><span class=\"std std-ref\">BT</span></a>"
|
||
}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTAction</l>, <l2>BTComment</l>, <l3>BTComposite</l>, <l4>BTCondition</l>, <l5>BTDecorator</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btaction#class-btaction\\\"><span class=\\\"std std-ref\\\">BTAction</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcomment#class-btcomment\\\"><span class=\\\"std std-ref\\\">BTComment</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcomposite#class-btcomposite\\\"><span class=\\\"std std-ref\\\">BTComposite</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcondition#class-btcondition\\\"><span class=\\\"std std-ref\\\">BTCondition</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdecorator#class-btdecorator\\\"><span class=\\\"std std-ref\\\">BTDecorator</span></a>\"}": {
|
||
"uid": 199,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTAction</l>, <l2>BTComment</l>, <l3>BTComposite</l>, <l4>BTCondition</l>, <l5>BTDecorator</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btaction#class-btaction\"><span class=\"std std-ref\">BTAction</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btcomment#class-btcomment\"><span class=\"std std-ref\">BTComment</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btcomposite#class-btcomposite\"><span class=\"std std-ref\">BTComposite</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btcondition#class-btcondition\"><span class=\"std std-ref\">BTCondition</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btdecorator#class-btdecorator\"><span class=\"std std-ref\">BTDecorator</span></a>"
|
||
}
|
||
},
|
||
"Base class for all <l1>BehaviorTree</l> tasks.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 200,
|
||
"tpl": "Base class for all <l1>BehaviorTree</l> tasks.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Description\u0000{}": {
|
||
"uid": 201,
|
||
"tpl": "Description",
|
||
"markers": {}
|
||
},
|
||
"Base class for all <l1>BehaviorTree</l> tasks. A task is a basic building block in a <l2>BehaviorTree</l> that represents a specific behavior or control flow. Tasks are used to create complex behaviors by combining and nesting them in a hierarchy.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 202,
|
||
"tpl": "Base class for all <l1>BehaviorTree</l> tasks. A task is a basic building block in a <l2>BehaviorTree</l> that represents a specific behavior or control flow. Tasks are used to create complex behaviors by combining and nesting them in a hierarchy.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"A task can be one of the following types: action, condition, composite, or decorator. Each type of task has its own corresponding subclass: <l1>BTAction</l>, <l2>BTCondition</l>, <l3>BTDecorator</l>, <l4>BTComposite</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btaction#class-btaction\\\"><span class=\\\"std std-ref\\\">BTAction</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcondition#class-btcondition\\\"><span class=\\\"std std-ref\\\">BTCondition</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdecorator#class-btdecorator\\\"><span class=\\\"std std-ref\\\">BTDecorator</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcomposite#class-btcomposite\\\"><span class=\\\"std std-ref\\\">BTComposite</span></a>\"}": {
|
||
"uid": 203,
|
||
"tpl": "A task can be one of the following types: action, condition, composite, or decorator. Each type of task has its own corresponding subclass: <l1>BTAction</l>, <l2>BTCondition</l>, <l3>BTDecorator</l>, <l4>BTComposite</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btaction#class-btaction\"><span class=\"std std-ref\">BTAction</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btcondition#class-btcondition\"><span class=\"std std-ref\">BTCondition</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btdecorator#class-btdecorator\"><span class=\"std std-ref\">BTDecorator</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btcomposite#class-btcomposite\"><span class=\"std std-ref\">BTComposite</span></a>"
|
||
}
|
||
},
|
||
"Tasks perform their work and return their status using the <l1>_tick</l> method. Status values are defined in <l2>Status</l>. Tasks can be initialized using the <l3>_setup</l> method. See also <l4>_enter</l> & <l5>_exit</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-setup\\\"><span class=\\\"std std-ref\\\">_setup</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-enter\\\"><span class=\\\"std std-ref\\\">_enter</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-exit\\\"><span class=\\\"std std-ref\\\">_exit</span></a>\"}": {
|
||
"uid": 204,
|
||
"tpl": "Tasks perform their work and return their status using the <l1>_tick</l> method. Status values are defined in <l2>Status</l>. Tasks can be initialized using the <l3>_setup</l> method. See also <l4>_enter</l> & <l5>_exit</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-private-method-setup\"><span class=\"std std-ref\">_setup</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-private-method-enter\"><span class=\"std std-ref\">_enter</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-bttask-private-method-exit\"><span class=\"std std-ref\">_exit</span></a>"
|
||
}
|
||
},
|
||
"<b>Note:</b> Do not extend <b>BTTask</b> directly for your own tasks. Instead, extend one of the subtypes mentioned above.\u0000{}": {
|
||
"uid": 205,
|
||
"tpl": "<b>Note:</b> Do not extend <b>BTTask</b> directly for your own tasks. Instead, extend one of the subtypes mentioned above.",
|
||
"markers": {}
|
||
},
|
||
"Properties\u0000{}": {
|
||
"uid": 206,
|
||
"tpl": "Properties",
|
||
"markers": {}
|
||
},
|
||
"<l1>agent</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-agent\\\"><span class=\\\"std std-ref\\\">agent</span></a>\"}": {
|
||
"uid": 207,
|
||
"tpl": "<l1>agent</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-agent\"><span class=\"std std-ref\">agent</span></a>"
|
||
}
|
||
},
|
||
"<l1>Blackboard</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 208,
|
||
"tpl": "<l1>Blackboard</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>blackboard</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-blackboard\\\"><span class=\\\"std std-ref\\\">blackboard</span></a>\"}": {
|
||
"uid": 209,
|
||
"tpl": "<l1>blackboard</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-blackboard\"><span class=\"std std-ref\">blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>custom_name</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-custom-name\\\"><span class=\\\"std std-ref\\\">custom_name</span></a>\"}": {
|
||
"uid": 210,
|
||
"tpl": "<l1>custom_name</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-custom-name\"><span class=\"std std-ref\">custom_name</span></a>"
|
||
}
|
||
},
|
||
"<l1>elapsed_time</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-elapsed-time\\\"><span class=\\\"std std-ref\\\">elapsed_time</span></a>\"}": {
|
||
"uid": 211,
|
||
"tpl": "<l1>elapsed_time</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-elapsed-time\"><span class=\"std std-ref\">elapsed_time</span></a>"
|
||
}
|
||
},
|
||
"<l1>scene_root</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-scene-root\\\"><span class=\\\"std std-ref\\\">scene_root</span></a>\"}": {
|
||
"uid": 212,
|
||
"tpl": "<l1>scene_root</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-scene-root\"><span class=\"std std-ref\">scene_root</span></a>"
|
||
}
|
||
},
|
||
"<l1>Status</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\"}": {
|
||
"uid": 213,
|
||
"tpl": "<l1>Status</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>"
|
||
}
|
||
},
|
||
"<l1>status</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-status\\\"><span class=\\\"std std-ref\\\">status</span></a>\"}": {
|
||
"uid": 214,
|
||
"tpl": "<l1>status</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-status\"><span class=\"std std-ref\">status</span></a>"
|
||
}
|
||
},
|
||
"Methods\u0000{}": {
|
||
"uid": 215,
|
||
"tpl": "Methods",
|
||
"markers": {}
|
||
},
|
||
"<l1>_enter</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-enter\\\"><span class=\\\"std std-ref\\\">_enter</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 216,
|
||
"tpl": "<l1>_enter</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-enter\"><span class=\"std std-ref\">_enter</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>_exit</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-exit\\\"><span class=\\\"std std-ref\\\">_exit</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 217,
|
||
"tpl": "<l1>_exit</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-exit\"><span class=\"std std-ref\">_exit</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>_generate_name</l>() <2/> <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-generate-name\\\"><span class=\\\"std std-ref\\\">_generate_name</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 218,
|
||
"tpl": "<l1>_generate_name</l>() <2/> <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-generate-name\"><span class=\"std std-ref\">_generate_name</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>_get_configuration_warnings</l>() <2/> <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-get-configuration-warnings\\\"><span class=\\\"std std-ref\\\">_get_configuration_warnings</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 219,
|
||
"tpl": "<l1>_get_configuration_warnings</l>() <2/> <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-get-configuration-warnings\"><span class=\"std std-ref\">_get_configuration_warnings</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>_setup</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-setup\\\"><span class=\\\"std std-ref\\\">_setup</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 220,
|
||
"tpl": "<l1>_setup</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-setup\"><span class=\"std std-ref\">_setup</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>_tick</l>(delta: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 221,
|
||
"tpl": "<l1>_tick</l>(delta: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>abort</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-abort\\\"><span class=\\\"std std-ref\\\">abort</span></a>\"}": {
|
||
"uid": 222,
|
||
"tpl": "<l1>abort</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-abort\"><span class=\"std std-ref\">abort</span></a>"
|
||
}
|
||
},
|
||
"<l1>add_child</l>(task: <l2>BTTask</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-add-child\\\"><span class=\\\"std std-ref\\\">add_child</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 223,
|
||
"tpl": "<l1>add_child</l>(task: <l2>BTTask</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-add-child\"><span class=\"std std-ref\">add_child</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<l1>add_child_at_index</l>(task: <l2>BTTask</l>, idx: <3/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-add-child-at-index\\\"><span class=\\\"std std-ref\\\">add_child_at_index</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 224,
|
||
"tpl": "<l1>add_child_at_index</l>(task: <l2>BTTask</l>, idx: <3/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-add-child-at-index\"><span class=\"std std-ref\">add_child_at_index</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<l1>BTTask</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 225,
|
||
"tpl": "<l1>BTTask</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<l1>clone</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-clone\\\"><span class=\\\"std std-ref\\\">clone</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 226,
|
||
"tpl": "<l1>clone</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-clone\"><span class=\"std std-ref\">clone</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 227,
|
||
"tpl": "<l1>BehaviorTree</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>editor_get_behavior_tree</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-editor-get-behavior-tree\\\"><span class=\\\"std std-ref\\\">editor_get_behavior_tree</span></a>\"}": {
|
||
"uid": 228,
|
||
"tpl": "<l1>editor_get_behavior_tree</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-editor-get-behavior-tree\"><span class=\"std std-ref\">editor_get_behavior_tree</span></a>"
|
||
}
|
||
},
|
||
"<l1>execute</l>(delta: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-execute\\\"><span class=\\\"std std-ref\\\">execute</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 229,
|
||
"tpl": "<l1>execute</l>(delta: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-execute\"><span class=\"std std-ref\">execute</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<l1>get_child</l>(idx: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-child\\\"><span class=\\\"std std-ref\\\">get_child</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 230,
|
||
"tpl": "<l1>get_child</l>(idx: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-child\"><span class=\"std std-ref\">get_child</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_child_count</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-child-count\\\"><span class=\\\"std std-ref\\\">get_child_count</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 231,
|
||
"tpl": "<l1>get_child_count</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-child-count\"><span class=\"std std-ref\">get_child_count</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_child_count_excluding_comments</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-child-count-excluding-comments\\\"><span class=\\\"std std-ref\\\">get_child_count_excluding_comments</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 232,
|
||
"tpl": "<l1>get_child_count_excluding_comments</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-child-count-excluding-comments\"><span class=\"std std-ref\">get_child_count_excluding_comments</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_index</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-index\\\"><span class=\\\"std std-ref\\\">get_index</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 233,
|
||
"tpl": "<l1>get_index</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-index\"><span class=\"std std-ref\">get_index</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_parent</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-parent\\\"><span class=\\\"std std-ref\\\">get_parent</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 234,
|
||
"tpl": "<l1>get_parent</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-parent\"><span class=\"std std-ref\">get_parent</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_root</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-root\\\"><span class=\\\"std std-ref\\\">get_root</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 235,
|
||
"tpl": "<l1>get_root</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-root\"><span class=\"std std-ref\">get_root</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_task_name</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-task-name\\\"><span class=\\\"std std-ref\\\">get_task_name</span></a>\"}": {
|
||
"uid": 236,
|
||
"tpl": "<l1>get_task_name</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-task-name\"><span class=\"std std-ref\">get_task_name</span></a>"
|
||
}
|
||
},
|
||
"<l1>has_child</l>(task: <l2>BTTask</l>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-has-child\\\"><span class=\\\"std std-ref\\\">has_child</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 237,
|
||
"tpl": "<l1>has_child</l>(task: <l2>BTTask</l>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-has-child\"><span class=\"std std-ref\">has_child</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>initialize</l>(agent: <2/>, blackboard: <l3>Blackboard</l>, scene_root: <4/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-initialize\\\"><span class=\\\"std std-ref\\\">initialize</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 238,
|
||
"tpl": "<l1>initialize</l>(agent: <2/>, blackboard: <l3>Blackboard</l>, scene_root: <4/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-initialize\"><span class=\"std std-ref\">initialize</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"<l1>is_descendant_of</l>(task: <l2>BTTask</l>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-is-descendant-of\\\"><span class=\\\"std std-ref\\\">is_descendant_of</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 239,
|
||
"tpl": "<l1>is_descendant_of</l>(task: <l2>BTTask</l>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-is-descendant-of\"><span class=\"std std-ref\">is_descendant_of</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>is_root</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-is-root\\\"><span class=\\\"std std-ref\\\">is_root</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 240,
|
||
"tpl": "<l1>is_root</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-is-root\"><span class=\"std std-ref\">is_root</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>next_sibling</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-next-sibling\\\"><span class=\\\"std std-ref\\\">next_sibling</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 241,
|
||
"tpl": "<l1>next_sibling</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-next-sibling\"><span class=\"std std-ref\">next_sibling</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>print_tree</l>(initial_tabs: <2/> = 0)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-print-tree\\\"><span class=\\\"std std-ref\\\">print_tree</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 242,
|
||
"tpl": "<l1>print_tree</l>(initial_tabs: <2/> = 0)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-print-tree\"><span class=\"std std-ref\">print_tree</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<l1>remove_child</l>(task: <l2>BTTask</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-remove-child\\\"><span class=\\\"std std-ref\\\">remove_child</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 243,
|
||
"tpl": "<l1>remove_child</l>(task: <l2>BTTask</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-remove-child\"><span class=\"std std-ref\">remove_child</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<l1>remove_child_at_index</l>(idx: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-remove-child-at-index\\\"><span class=\\\"std std-ref\\\">remove_child_at_index</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 244,
|
||
"tpl": "<l1>remove_child_at_index</l>(idx: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-remove-child-at-index\"><span class=\"std std-ref\">remove_child_at_index</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"Property Descriptions\u0000{}": {
|
||
"uid": 245,
|
||
"tpl": "Property Descriptions",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>agent</b> <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-agent\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 246,
|
||
"tpl": "<1/> <b>agent</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-agent\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_agent</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 247,
|
||
"tpl": "<1/> <b>set_agent</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_agent</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 248,
|
||
"tpl": "<1/> <b>get_agent</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"The agent is the contextual object for the <l1>BehaviorTree</l> instance. This is usually the parent of the <l2>BTPlayer</l> node that utilizes the <l3>BehaviorTree</l> resource.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 249,
|
||
"tpl": "The agent is the contextual object for the <l1>BehaviorTree</l> instance. This is usually the parent of the <l2>BTPlayer</l> node that utilizes the <l3>BehaviorTree</l> resource.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>Blackboard</l> <b>blackboard</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-blackboard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 250,
|
||
"tpl": "<l1>Blackboard</l> <b>blackboard</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-blackboard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>Blackboard</l> <b>get_blackboard</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 251,
|
||
"tpl": "<l1>Blackboard</l> <b>get_blackboard</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Provides access to the <l1>Blackboard</l>. Blackboard is used to share data among tasks of the associated <l2>BehaviorTree</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 252,
|
||
"tpl": "Provides access to the <l1>Blackboard</l>. Blackboard is used to share data among tasks of the associated <l2>BehaviorTree</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"See <l1>Blackboard</l> for additional info.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 253,
|
||
"tpl": "See <l1>Blackboard</l> for additional info.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>custom_name</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-custom-name\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 254,
|
||
"tpl": "<1/> <b>custom_name</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-property-custom-name\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_custom_name</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 255,
|
||
"tpl": "<1/> <b>set_custom_name</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_custom_name</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 256,
|
||
"tpl": "<1/> <b>get_custom_name</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"User-provided name for the task. If not empty, it is used by the editor to represent the task. See <l1>get_task_name</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-task-name\\\"><span class=\\\"std std-ref\\\">get_task_name</span></a>\"}": {
|
||
"uid": 257,
|
||
"tpl": "User-provided name for the task. If not empty, it is used by the editor to represent the task. See <l1>get_task_name</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-method-get-task-name\"><span class=\"std std-ref\">get_task_name</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>elapsed_time</b> <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-elapsed-time\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 258,
|
||
"tpl": "<1/> <b>elapsed_time</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-elapsed-time\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_elapsed_time</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 259,
|
||
"tpl": "<1/> <b>get_elapsed_time</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Elapsed time since the task was “entered”. See <l1>_enter</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-enter\\\"><span class=\\\"std std-ref\\\">_enter</span></a>\"}": {
|
||
"uid": 260,
|
||
"tpl": "Elapsed time since the task was “entered”. See <l1>_enter</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-enter\"><span class=\"std std-ref\">_enter</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> when task is not <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 261,
|
||
"tpl": "Returns <1/> when task is not <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>scene_root</b> <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-scene-root\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 262,
|
||
"tpl": "<1/> <b>scene_root</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-scene-root\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_scene_root</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 263,
|
||
"tpl": "<1/> <b>get_scene_root</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"Root node of the scene the behavior tree is used in (e.g., the owner of the <l1>BTPlayer</l> node). Can be uses to retrieve <2/> references.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\"}": {
|
||
"uid": 264,
|
||
"tpl": "Root node of the scene the behavior tree is used in (e.g., the owner of the <l1>BTPlayer</l> node). Can be uses to retrieve <2/> references.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>"
|
||
}
|
||
},
|
||
"<b>Example:</b>\u0000{}": {
|
||
"uid": 265,
|
||
"tpl": "<b>Example:</b>",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>status</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-status\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 266,
|
||
"tpl": "<l1>Status</l> <b>status</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-status\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>Status</l> <b>get_status</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\"}": {
|
||
"uid": 267,
|
||
"tpl": "<l1>Status</l> <b>get_status</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>"
|
||
}
|
||
},
|
||
"Last execution <l1>Status</l> returned by <l2>_tick</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\"}": {
|
||
"uid": 268,
|
||
"tpl": "Last execution <l1>Status</l> returned by <l2>_tick</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>"
|
||
}
|
||
},
|
||
"Method Descriptions\u0000{}": {
|
||
"uid": 269,
|
||
"tpl": "Method Descriptions",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>_enter</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-enter\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 270,
|
||
"tpl": "<1/> <b>_enter</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-private-method-enter\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called when task is “entered”, i.e. when task is executed while not having a <1/> <l2>status</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-status\\\"><span class=\\\"std std-ref\\\">status</span></a>\"}": {
|
||
"uid": 271,
|
||
"tpl": "Called when task is “entered”, i.e. when task is executed while not having a <1/> <l2>status</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-status\"><span class=\"std std-ref\">status</span></a>"
|
||
}
|
||
},
|
||
"It is called before <l1>_tick</l> in the execution order. This method is used when preparation is needed before main work begins, usually when it takes more than one tick to finish the task. See also <l2>execute</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-execute\\\"><span class=\\\"std std-ref\\\">execute</span></a>\"}": {
|
||
"uid": 272,
|
||
"tpl": "It is called before <l1>_tick</l> in the execution order. This method is used when preparation is needed before main work begins, usually when it takes more than one tick to finish the task. See also <l2>execute</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-method-execute\"><span class=\"std std-ref\">execute</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>_exit</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-exit\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 273,
|
||
"tpl": "<1/> <b>_exit</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-private-method-exit\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called when task is “exited”, i.e. after <l1>_tick</l> returns <2/> or <3/> status. See also <l4>execute</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-execute\\\"><span class=\\\"std std-ref\\\">execute</span></a>\"}": {
|
||
"uid": 274,
|
||
"tpl": "Called when task is “exited”, i.e. after <l1>_tick</l> returns <2/> or <3/> status. See also <l4>execute</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-method-execute\"><span class=\"std std-ref\">execute</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>_generate_name</b>() <2/> <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-generate-name\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 275,
|
||
"tpl": "<1/> <b>_generate_name</b>() <2/> <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-private-method-generate-name\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called to generate a display name for the task unless <l1>custom_name</l> is set. See <l2>get_task_name</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-custom-name\\\"><span class=\\\"std std-ref\\\">custom_name</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-task-name\\\"><span class=\\\"std std-ref\\\">get_task_name</span></a>\"}": {
|
||
"uid": 276,
|
||
"tpl": "Called to generate a display name for the task unless <l1>custom_name</l> is set. See <l2>get_task_name</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-custom-name\"><span class=\"std std-ref\">custom_name</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-method-get-task-name\"><span class=\"std std-ref\">get_task_name</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>_get_configuration_warnings</b>() <2/> <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-get-configuration-warnings\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 277,
|
||
"tpl": "<1/> <b>_get_configuration_warnings</b>() <2/> <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-private-method-get-configuration-warnings\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"The string returned by this method is shown as a warning message in the behavior tree editor. Any task script that overrides this method must include <1/> annotation at the top of the file.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">@tool</span></code>\"}": {
|
||
"uid": 278,
|
||
"tpl": "The string returned by this method is shown as a warning message in the behavior tree editor. Any task script that overrides this method must include <1/> annotation at the top of the file.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">@tool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>_setup</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-setup\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 279,
|
||
"tpl": "<1/> <b>_setup</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-private-method-setup\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called to initialize a task during initialization step. It is called only once before the task’s first execution tick. This method allows you to set up any necessary state or configurations for the task before it begins executing.\u0000{}": {
|
||
"uid": 280,
|
||
"tpl": "Called to initialize a task during initialization step. It is called only once before the task’s first execution tick. This method allows you to set up any necessary state or configurations for the task before it begins executing.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>_tick</b>(delta: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 281,
|
||
"tpl": "<l1>Status</l> <b>_tick</b>(delta: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called when task is “ticked”, i.e. executed by <l1>BTPlayer</l> or <l2>BTState</l> during an update.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\"}": {
|
||
"uid": 282,
|
||
"tpl": "Called when task is “ticked”, i.e. executed by <l1>BTPlayer</l> or <l2>BTState</l> during an update.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>"
|
||
}
|
||
},
|
||
"Returns execution status as defined in <l1>Status</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\"}": {
|
||
"uid": 283,
|
||
"tpl": "Returns execution status as defined in <l1>Status</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>"
|
||
}
|
||
},
|
||
"<b>Note:</b> Tasks perform their main function by implementing this method.\u0000{}": {
|
||
"uid": 284,
|
||
"tpl": "<b>Note:</b> Tasks perform their main function by implementing this method.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>abort</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-abort\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 285,
|
||
"tpl": "<1/> <b>abort</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-method-abort\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Resets the task and its children recursively. If a task is in the <1/> state, it is exited and its status is reset to <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FRESH</span></code>\"}": {
|
||
"uid": 286,
|
||
"tpl": "Resets the task and its children recursively. If a task is in the <1/> state, it is exited and its status is reset to <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FRESH</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>add_child</b>(task: <l2>BTTask</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-add-child\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 287,
|
||
"tpl": "<1/> <b>add_child</b>(task: <l2>BTTask</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-add-child\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Adds a child task. The <1/> is placed at the end of the children list.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">task</span></code>\"}": {
|
||
"uid": 288,
|
||
"tpl": "Adds a child task. The <1/> is placed at the end of the children list.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">task</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>add_child_at_index</b>(task: <l2>BTTask</l>, idx: <3/>) <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-add-child-at-index\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 289,
|
||
"tpl": "<1/> <b>add_child_at_index</b>(task: <l2>BTTask</l>, idx: <3/>) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-method-add-child-at-index\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Adds a child task. The <1/> is placed at <2/> position in the children list.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">task</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">idx</span></code>\"}": {
|
||
"uid": 290,
|
||
"tpl": "Adds a child task. The <1/> is placed at <2/> position in the children list.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">task</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">idx</span></code>"
|
||
}
|
||
},
|
||
"<l1>BTTask</l> <b>clone</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-clone\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 291,
|
||
"tpl": "<l1>BTTask</l> <b>clone</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-clone\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Duplicates the task and its children, copying the exported members. Sub-resources are shared for efficiency, except for <l1>BBParam</l> subtypes, which are always copied. Used by the editor to instantiate <l2>BehaviorTree</l> and copy-paste tasks.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 292,
|
||
"tpl": "Duplicates the task and its children, copying the exported members. Sub-resources are shared for efficiency, except for <l1>BBParam</l> subtypes, which are always copied. Used by the editor to instantiate <l2>BehaviorTree</l> and copy-paste tasks.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l> <b>editor_get_behavior_tree</b>() <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-editor-get-behavior-tree\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 293,
|
||
"tpl": "<l1>BehaviorTree</l> <b>editor_get_behavior_tree</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-method-editor-get-behavior-tree\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the behavior tree that owns this task. This is only available in the editor.\u0000{}": {
|
||
"uid": 294,
|
||
"tpl": "Returns the behavior tree that owns this task. This is only available in the editor.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>execute</b>(delta: <2/>) <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-execute\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 295,
|
||
"tpl": "<l1>Status</l> <b>execute</b>(delta: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-execute\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Performs task’s execution. The execution follows a specific sequence:\u0000{}": {
|
||
"uid": 296,
|
||
"tpl": "Performs task’s execution. The execution follows a specific sequence:",
|
||
"markers": {}
|
||
},
|
||
"If task’s current <l1>status</l> is not <2/>, the <l3>_enter</l> method is called first.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-status\\\"><span class=\\\"std std-ref\\\">status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-enter\\\"><span class=\\\"std std-ref\\\">_enter</span></a>\"}": {
|
||
"uid": 297,
|
||
"tpl": "If task’s current <l1>status</l> is not <2/>, the <l3>_enter</l> method is called first.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-status\"><span class=\"std std-ref\">status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-private-method-enter\"><span class=\"std std-ref\">_enter</span></a>"
|
||
}
|
||
},
|
||
"Next, the <l1>_tick</l> method is called next to perform the task’s work.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\"}": {
|
||
"uid": 298,
|
||
"tpl": "Next, the <l1>_tick</l> method is called next to perform the task’s work.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>"
|
||
}
|
||
},
|
||
"If the <l1>_tick</l> method returns <2/> or <3/> status, the <l4>_exit</l> method will be called next as part of the execution cleanup.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-tick\\\"><span class=\\\"std std-ref\\\">_tick</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-exit\\\"><span class=\\\"std std-ref\\\">_exit</span></a>\"}": {
|
||
"uid": 299,
|
||
"tpl": "If the <l1>_tick</l> method returns <2/> or <3/> status, the <l4>_exit</l> method will be called next as part of the execution cleanup.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-tick\"><span class=\"std std-ref\">_tick</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-private-method-exit\"><span class=\"std std-ref\">_exit</span></a>"
|
||
}
|
||
},
|
||
"<l1>BTTask</l> <b>get_child</b>(idx: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-child\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 300,
|
||
"tpl": "<l1>BTTask</l> <b>get_child</b>(idx: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-method-get-child\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns a child task by specifying its index.\u0000{}": {
|
||
"uid": 301,
|
||
"tpl": "Returns a child task by specifying its index.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_child_count</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-child-count\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 302,
|
||
"tpl": "<1/> <b>get_child_count</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-get-child-count\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the number of child tasks.\u0000{}": {
|
||
"uid": 303,
|
||
"tpl": "Returns the number of child tasks.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_child_count_excluding_comments</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-child-count-excluding-comments\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 304,
|
||
"tpl": "<1/> <b>get_child_count_excluding_comments</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-get-child-count-excluding-comments\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the number of child tasks not counting <l1>BTComment</l> tasks.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcomment#class-btcomment\\\"><span class=\\\"std std-ref\\\">BTComment</span></a>\"}": {
|
||
"uid": 305,
|
||
"tpl": "Returns the number of child tasks not counting <l1>BTComment</l> tasks.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btcomment#class-btcomment\"><span class=\"std std-ref\">BTComment</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_index</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-index\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 306,
|
||
"tpl": "<1/> <b>get_index</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-get-index\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the task’s position in the behavior tree branch. Returns <1/> if the task doesn’t belong to a task tree, i.e. doesn’t have a parent.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">-1</span></code>\"}": {
|
||
"uid": 307,
|
||
"tpl": "Returns the task’s position in the behavior tree branch. Returns <1/> if the task doesn’t belong to a task tree, i.e. doesn’t have a parent.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">-1</span></code>"
|
||
}
|
||
},
|
||
"<l1>BTTask</l> <b>get_parent</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-parent\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 308,
|
||
"tpl": "<l1>BTTask</l> <b>get_parent</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-get-parent\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the task’s parent.\u0000{}": {
|
||
"uid": 309,
|
||
"tpl": "Returns the task’s parent.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BTTask</l> <b>get_root</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-root\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 310,
|
||
"tpl": "<l1>BTTask</l> <b>get_root</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-get-root\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the root task of the behavior tree.\u0000{}": {
|
||
"uid": 311,
|
||
"tpl": "Returns the root task of the behavior tree.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_task_name</b>() <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-get-task-name\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 312,
|
||
"tpl": "<1/> <b>get_task_name</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-method-get-task-name\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"The string returned by this method is used to represent the task in the editor.\u0000{}": {
|
||
"uid": 313,
|
||
"tpl": "The string returned by this method is used to represent the task in the editor.",
|
||
"markers": {}
|
||
},
|
||
"Method <l1>_generate_name</l> is called to generate a display name for the task unless <l2>custom_name</l> is set.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-generate-name\\\"><span class=\\\"std std-ref\\\">_generate_name</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-custom-name\\\"><span class=\\\"std std-ref\\\">custom_name</span></a>\"}": {
|
||
"uid": 314,
|
||
"tpl": "Method <l1>_generate_name</l> is called to generate a display name for the task unless <l2>custom_name</l> is set.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-private-method-generate-name\"><span class=\"std std-ref\">_generate_name</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-custom-name\"><span class=\"std std-ref\">custom_name</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>has_child</b>(task: <l2>BTTask</l>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-has-child\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 315,
|
||
"tpl": "<1/> <b>has_child</b>(task: <l2>BTTask</l>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-method-has-child\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if <2/> is a child of this task.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">task</span></code>\"}": {
|
||
"uid": 316,
|
||
"tpl": "Returns <1/> if <2/> is a child of this task.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">task</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>initialize</b>(agent: <2/>, blackboard: <l3>Blackboard</l>, scene_root: <4/>) <l5>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-initialize\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 317,
|
||
"tpl": "<1/> <b>initialize</b>(agent: <2/>, blackboard: <l3>Blackboard</l>, scene_root: <4/>) <l5>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-bttask-method-initialize\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Initilizes the task. Assigns <l1>agent</l> and <l2>blackboard</l>, and calls <l3>_setup</l> for the task and its children.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-agent\\\"><span class=\\\"std std-ref\\\">agent</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-property-blackboard\\\"><span class=\\\"std std-ref\\\">blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-private-method-setup\\\"><span class=\\\"std std-ref\\\">_setup</span></a>\"}": {
|
||
"uid": 318,
|
||
"tpl": "Initilizes the task. Assigns <l1>agent</l> and <l2>blackboard</l>, and calls <l3>_setup</l> for the task and its children.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask-property-agent\"><span class=\"std std-ref\">agent</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask-property-blackboard\"><span class=\"std std-ref\">blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-private-method-setup\"><span class=\"std std-ref\">_setup</span></a>"
|
||
}
|
||
},
|
||
"The method is called recursively for each child task. <1/> should be the root node of the scene the behavior tree is used in (e.g., the owner of the node that contains the behavior tree).\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">scene_root</span></code>\"}": {
|
||
"uid": 319,
|
||
"tpl": "The method is called recursively for each child task. <1/> should be the root node of the scene the behavior tree is used in (e.g., the owner of the node that contains the behavior tree).",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">scene_root</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>is_descendant_of</b>(task: <l2>BTTask</l>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-is-descendant-of\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 320,
|
||
"tpl": "<1/> <b>is_descendant_of</b>(task: <l2>BTTask</l>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-bttask-method-is-descendant-of\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if this task is a descendant of <2/>. In other words, this task must be a child of <3/> or one of its children or grandchildren.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">task</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">task</span></code>\"}": {
|
||
"uid": 321,
|
||
"tpl": "Returns <1/> if this task is a descendant of <2/>. In other words, this task must be a child of <3/> or one of its children or grandchildren.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">task</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">task</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>is_root</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-is-root\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 322,
|
||
"tpl": "<1/> <b>is_root</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-is-root\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if this task is the root task of its behavior tree. A behavior tree can have only one root task.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 323,
|
||
"tpl": "Returns <1/> if this task is the root task of its behavior tree. A behavior tree can have only one root task.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<l1>BTTask</l> <b>next_sibling</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-next-sibling\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 324,
|
||
"tpl": "<l1>BTTask</l> <b>next_sibling</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-next-sibling\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the next task after this task in the parent’s children list.\u0000{}": {
|
||
"uid": 325,
|
||
"tpl": "Returns the next task after this task in the parent’s children list.",
|
||
"markers": {}
|
||
},
|
||
"Returns <1/> if this task has no parent or it is the last child in the parent’s children list.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">null</span></code>\"}": {
|
||
"uid": 326,
|
||
"tpl": "Returns <1/> if this task has no parent or it is the last child in the parent’s children list.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">null</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>print_tree</b>(initial_tabs: <2/> = 0) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-print-tree\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 327,
|
||
"tpl": "<1/> <b>print_tree</b>(initial_tabs: <2/> = 0) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-print-tree\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Prints the subtree that starts with this task to the console.\u0000{}": {
|
||
"uid": 328,
|
||
"tpl": "Prints the subtree that starts with this task to the console.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>remove_child</b>(task: <l2>BTTask</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-remove-child\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 329,
|
||
"tpl": "<1/> <b>remove_child</b>(task: <l2>BTTask</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-remove-child\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Removes <1/> from children.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">task</span></code>\"}": {
|
||
"uid": 330,
|
||
"tpl": "Removes <1/> from children.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">task</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>remove_child_at_index</b>(idx: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttask-method-remove-child-at-index\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 331,
|
||
"tpl": "<1/> <b>remove_child_at_index</b>(idx: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttask-method-remove-child-at-index\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Removes a child task at a specified index from children.\u0000{}": {
|
||
"uid": 332,
|
||
"tpl": "Removes a child task at a specified index from children.",
|
||
"markers": {}
|
||
},
|
||
"BTPlayer\u0000{}": {
|
||
"uid": 333,
|
||
"tpl": "BTPlayer",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b>\u0000{}": {
|
||
"uid": 334,
|
||
"tpl": "<b>Inherits:</b>",
|
||
"markers": {}
|
||
},
|
||
"Player of <l1>BehaviorTree</l> resources.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 335,
|
||
"tpl": "Player of <l1>BehaviorTree</l> resources.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<b>BTPlayer</b> node is used to instantiate and play <l1>BehaviorTree</l> resources at runtime. During initialization, the behavior tree instance is given references to the agent, the <l2>blackboard</l>, and the current scene root. The agent can be specified by the <l3>agent_node</l> property (defaults to the BTPlayer’s parent node).\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-blackboard\\\"><span class=\\\"std std-ref\\\">blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-agent-node\\\"><span class=\\\"std std-ref\\\">agent_node</span></a>\"}": {
|
||
"uid": 336,
|
||
"tpl": "<b>BTPlayer</b> node is used to instantiate and play <l1>BehaviorTree</l> resources at runtime. During initialization, the behavior tree instance is given references to the agent, the <l2>blackboard</l>, and the current scene root. The agent can be specified by the <l3>agent_node</l> property (defaults to the BTPlayer’s parent node).",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-property-blackboard\"><span class=\"std std-ref\">blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-property-agent-node\"><span class=\"std std-ref\">agent_node</span></a>"
|
||
}
|
||
},
|
||
"For an introduction to behavior trees, see <l1>BehaviorTree</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 337,
|
||
"tpl": "For an introduction to behavior trees, see <l1>BehaviorTree</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>active</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-active\\\"><span class=\\\"std std-ref\\\">active</span></a>\"}": {
|
||
"uid": 338,
|
||
"tpl": "<l1>active</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-active\"><span class=\"std std-ref\">active</span></a>"
|
||
}
|
||
},
|
||
"<l1>agent_node</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-agent-node\\\"><span class=\\\"std std-ref\\\">agent_node</span></a>\"}": {
|
||
"uid": 339,
|
||
"tpl": "<l1>agent_node</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-agent-node\"><span class=\"std std-ref\">agent_node</span></a>"
|
||
}
|
||
},
|
||
"<l1>behavior_tree</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-behavior-tree\\\"><span class=\\\"std std-ref\\\">behavior_tree</span></a>\"}": {
|
||
"uid": 340,
|
||
"tpl": "<l1>behavior_tree</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-behavior-tree\"><span class=\"std std-ref\">behavior_tree</span></a>"
|
||
}
|
||
},
|
||
"<l1>blackboard</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-blackboard\\\"><span class=\\\"std std-ref\\\">blackboard</span></a>\"}": {
|
||
"uid": 341,
|
||
"tpl": "<l1>blackboard</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-blackboard\"><span class=\"std std-ref\">blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>BlackboardPlan</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 342,
|
||
"tpl": "<l1>BlackboardPlan</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"<l1>blackboard_plan</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">blackboard_plan</span></a>\"}": {
|
||
"uid": 343,
|
||
"tpl": "<l1>blackboard_plan</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-blackboard-plan\"><span class=\"std std-ref\">blackboard_plan</span></a>"
|
||
}
|
||
},
|
||
"<l1>monitor_performance</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-monitor-performance\\\"><span class=\\\"std std-ref\\\">monitor_performance</span></a>\"}": {
|
||
"uid": 344,
|
||
"tpl": "<l1>monitor_performance</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-monitor-performance\"><span class=\"std std-ref\">monitor_performance</span></a>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 345,
|
||
"tpl": "<l1>UpdateMode</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"<l1>update_mode</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-update-mode\\\"><span class=\\\"std std-ref\\\">update_mode</span></a>\"}": {
|
||
"uid": 346,
|
||
"tpl": "<l1>update_mode</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-update-mode\"><span class=\"std std-ref\">update_mode</span></a>"
|
||
}
|
||
},
|
||
"<l1>BTInstance</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\"}": {
|
||
"uid": 347,
|
||
"tpl": "<l1>BTInstance</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_bt_instance</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-get-bt-instance\\\"><span class=\\\"std std-ref\\\">get_bt_instance</span></a>\"}": {
|
||
"uid": 348,
|
||
"tpl": "<l1>get_bt_instance</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-method-get-bt-instance\"><span class=\"std std-ref\">get_bt_instance</span></a>"
|
||
}
|
||
},
|
||
"<l1>restart</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-restart\\\"><span class=\\\"std std-ref\\\">restart</span></a>\"}": {
|
||
"uid": 349,
|
||
"tpl": "<l1>restart</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-method-restart\"><span class=\"std std-ref\">restart</span></a>"
|
||
}
|
||
},
|
||
"<l1>set_bt_instance</l>(bt_instance: <l2>BTInstance</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-set-bt-instance\\\"><span class=\\\"std std-ref\\\">set_bt_instance</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\"}": {
|
||
"uid": 350,
|
||
"tpl": "<l1>set_bt_instance</l>(bt_instance: <l2>BTInstance</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-method-set-bt-instance\"><span class=\"std std-ref\">set_bt_instance</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>"
|
||
}
|
||
},
|
||
"<l1>set_scene_root_hint</l>(scene_root: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-set-scene-root-hint\\\"><span class=\\\"std std-ref\\\">set_scene_root_hint</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 351,
|
||
"tpl": "<l1>set_scene_root_hint</l>(scene_root: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-method-set-scene-root-hint\"><span class=\"std std-ref\">set_scene_root_hint</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"<l1>update</l>(delta: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-update\\\"><span class=\\\"std std-ref\\\">update</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 352,
|
||
"tpl": "<l1>update</l>(delta: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-method-update\"><span class=\"std std-ref\">update</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Signals\u0000{}": {
|
||
"uid": 353,
|
||
"tpl": "Signals",
|
||
"markers": {}
|
||
},
|
||
"<b>behavior_tree_finished</b>(status: <1/>) <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-signal-behavior-tree-finished\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 354,
|
||
"tpl": "<b>behavior_tree_finished</b>(status: <1/>) <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-signal-behavior-tree-finished\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<b>Deprecated:</b> Use <l1>updated</l> signal instead.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-signal-updated\\\"><span class=\\\"std std-ref\\\">updated</span></a>\"}": {
|
||
"uid": 355,
|
||
"tpl": "<b>Deprecated:</b> Use <l1>updated</l> signal instead.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-signal-updated\"><span class=\"std std-ref\">updated</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the behavior tree has finished executing and returned <1/> or <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 356,
|
||
"tpl": "Emitted when the behavior tree has finished executing and returned <1/> or <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Argument <1/> holds the status returned by the behavior tree. See <l2>Status</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">status</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\"}": {
|
||
"uid": 357,
|
||
"tpl": "Argument <1/> holds the status returned by the behavior tree. See <l2>Status</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">status</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>"
|
||
}
|
||
},
|
||
"<b>updated</b>(status: <1/>) <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-signal-updated\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 358,
|
||
"tpl": "<b>updated</b>(status: <1/>) <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-signal-updated\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when BTPlayer has finished the behavior tree update.\u0000{}": {
|
||
"uid": 359,
|
||
"tpl": "Emitted when BTPlayer has finished the behavior tree update.",
|
||
"markers": {}
|
||
},
|
||
"Enumerations\u0000{}": {
|
||
"uid": 360,
|
||
"tpl": "Enumerations",
|
||
"markers": {}
|
||
},
|
||
"enum <b>UpdateMode</b>: <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 361,
|
||
"tpl": "enum <b>UpdateMode</b>: <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l> <b>IDLE</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\"}": {
|
||
"uid": 362,
|
||
"tpl": "<l1>UpdateMode</l> <b>IDLE</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>"
|
||
}
|
||
},
|
||
"Execute behavior tree during the idle process.\u0000{}": {
|
||
"uid": 363,
|
||
"tpl": "Execute behavior tree during the idle process.",
|
||
"markers": {}
|
||
},
|
||
"<l1>UpdateMode</l> <b>PHYSICS</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\"}": {
|
||
"uid": 364,
|
||
"tpl": "<l1>UpdateMode</l> <b>PHYSICS</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>"
|
||
}
|
||
},
|
||
"Execute behavior tree during the physics process.\u0000{}": {
|
||
"uid": 365,
|
||
"tpl": "Execute behavior tree during the physics process.",
|
||
"markers": {}
|
||
},
|
||
"<l1>UpdateMode</l> <b>MANUAL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">2</span></code>\"}": {
|
||
"uid": 366,
|
||
"tpl": "<l1>UpdateMode</l> <b>MANUAL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">2</span></code>"
|
||
}
|
||
},
|
||
"Behavior tree is executed manually by calling <l1>update</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-update\\\"><span class=\\\"std std-ref\\\">update</span></a>\"}": {
|
||
"uid": 367,
|
||
"tpl": "Behavior tree is executed manually by calling <l1>update</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-method-update\"><span class=\"std std-ref\">update</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>active</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-active\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 368,
|
||
"tpl": "<1/> <b>active</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-property-active\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_active</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 369,
|
||
"tpl": "<1/> <b>set_active</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_active</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 370,
|
||
"tpl": "<1/> <b>get_active</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, the behavior tree will be executed during update.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 371,
|
||
"tpl": "If <1/>, the behavior tree will be executed during update.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>agent_node</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath(\\\"..\\\")</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-agent-node\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 372,
|
||
"tpl": "<1/> <b>agent_node</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath(\"..\")</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-property-agent-node\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_agent_node</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\"}": {
|
||
"uid": 373,
|
||
"tpl": "<1/> <b>set_agent_node</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_agent_node</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\"}": {
|
||
"uid": 374,
|
||
"tpl": "<1/> <b>get_agent_node</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>"
|
||
}
|
||
},
|
||
"Path to the node that will be used as the agent. Setting it after instantiation will have no effect.\u0000{}": {
|
||
"uid": 375,
|
||
"tpl": "Path to the node that will be used as the agent. Setting it after instantiation will have no effect.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BehaviorTree</l> <b>behavior_tree</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-behavior-tree\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 376,
|
||
"tpl": "<l1>BehaviorTree</l> <b>behavior_tree</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-property-behavior-tree\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_behavior_tree</b>(value: <l2>BehaviorTree</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 377,
|
||
"tpl": "<1/> <b>set_behavior_tree</b>(value: <l2>BehaviorTree</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l> <b>get_behavior_tree</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 378,
|
||
"tpl": "<l1>BehaviorTree</l> <b>get_behavior_tree</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l> resource to instantiate and execute at runtime.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 379,
|
||
"tpl": "<l1>BehaviorTree</l> resource to instantiate and execute at runtime.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>Blackboard</l> <b>blackboard</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-blackboard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 380,
|
||
"tpl": "<l1>Blackboard</l> <b>blackboard</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-property-blackboard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_blackboard</b>(value: <l2>Blackboard</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 381,
|
||
"tpl": "<1/> <b>set_blackboard</b>(value: <l2>Blackboard</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Holds data shared by the behavior tree tasks. See <l1>Blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 382,
|
||
"tpl": "Holds data shared by the behavior tree tasks. See <l1>Blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 383,
|
||
"tpl": "<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-property-blackboard-plan\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_blackboard_plan</b>(value: <l2>BlackboardPlan</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 384,
|
||
"tpl": "<1/> <b>set_blackboard_plan</b>(value: <l2>BlackboardPlan</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"<l1>BlackboardPlan</l> <b>get_blackboard_plan</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 385,
|
||
"tpl": "<l1>BlackboardPlan</l> <b>get_blackboard_plan</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"Stores and manages variables that will be used in constructing new <l1>Blackboard</l> instances.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 386,
|
||
"tpl": "Stores and manages variables that will be used in constructing new <l1>Blackboard</l> instances.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>monitor_performance</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-monitor-performance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 387,
|
||
"tpl": "<1/> <b>monitor_performance</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-property-monitor-performance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_monitor_performance</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 388,
|
||
"tpl": "<1/> <b>set_monitor_performance</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_monitor_performance</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 389,
|
||
"tpl": "<1/> <b>get_monitor_performance</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, adds a performance monitor to “Debugger->Monitors” for each instance of this <b>BTPlayer</b> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 390,
|
||
"tpl": "If <1/>, adds a performance monitor to “Debugger->Monitors” for each instance of this <b>BTPlayer</b> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l> <b>update_mode</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-update-mode\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 391,
|
||
"tpl": "<l1>UpdateMode</l> <b>update_mode</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-property-update-mode\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_update_mode</b>(value: <l2>UpdateMode</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 392,
|
||
"tpl": "<1/> <b>set_update_mode</b>(value: <l2>UpdateMode</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l> <b>get_update_mode</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 393,
|
||
"tpl": "<l1>UpdateMode</l> <b>get_update_mode</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"Determines when the behavior tree is executed. See <l1>UpdateMode</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 394,
|
||
"tpl": "Determines when the behavior tree is executed. See <l1>UpdateMode</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"<l1>BTInstance</l> <b>get_bt_instance</b>() <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-get-bt-instance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 395,
|
||
"tpl": "<l1>BTInstance</l> <b>get_bt_instance</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-method-get-bt-instance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the behavior tree instance.\u0000{}": {
|
||
"uid": 396,
|
||
"tpl": "Returns the behavior tree instance.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>restart</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-restart\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 397,
|
||
"tpl": "<1/> <b>restart</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayer-method-restart\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Resets the behavior tree’s execution. Each running task will be aborted and the next tree execution will start anew. This method does not reset <l1>Blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 398,
|
||
"tpl": "Resets the behavior tree’s execution. Each running task will be aborted and the next tree execution will start anew. This method does not reset <l1>Blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_bt_instance</b>(bt_instance: <l2>BTInstance</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-set-bt-instance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 399,
|
||
"tpl": "<1/> <b>set_bt_instance</b>(bt_instance: <l2>BTInstance</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-method-set-bt-instance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the <l1>BTInstance</l> to play. This method is useful when you want to switch to a different behavior tree instance at runtime. See also <l2>BehaviorTree.instantiate</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree-method-instantiate\\\"><span class=\\\"std std-ref\\\">BehaviorTree.instantiate</span></a>\"}": {
|
||
"uid": 400,
|
||
"tpl": "Sets the <l1>BTInstance</l> to play. This method is useful when you want to switch to a different behavior tree instance at runtime. See also <l2>BehaviorTree.instantiate</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree-method-instantiate\"><span class=\"std std-ref\">BehaviorTree.instantiate</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_scene_root_hint</b>(scene_root: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-set-scene-root-hint\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 401,
|
||
"tpl": "<1/> <b>set_scene_root_hint</b>(scene_root: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-method-set-scene-root-hint\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the <1/> that will be used as the scene root for the newly instantiated behavior tree. Should be called before the <b>BTPlayer</b> is added to the scene tree (before <2/>). This is typically useful when creating <b>BTPlayer</b> nodes dynamically from code.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NOTIFICATION_READY</span></code>\"}": {
|
||
"uid": 402,
|
||
"tpl": "Sets the <1/> that will be used as the scene root for the newly instantiated behavior tree. Should be called before the <b>BTPlayer</b> is added to the scene tree (before <2/>). This is typically useful when creating <b>BTPlayer</b> nodes dynamically from code.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NOTIFICATION_READY</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>update</b>(delta: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-update\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 403,
|
||
"tpl": "<1/> <b>update</b>(delta: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-method-update\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Executes the root task of the behavior tree instance if <l1>active</l> is <2/>. Call this method when <l3>update_mode</l> is set to <l4>MANUAL</l>. When <l5>update_mode</l> is not <l6>MANUAL</l>, the <l7>update</l> will be called automatically. See <l8>UpdateMode</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-active\\\"><span class=\\\"std std-ref\\\">active</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-update-mode\\\"><span class=\\\"std std-ref\\\">update_mode</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-constant-manual\\\"><span class=\\\"std std-ref\\\">MANUAL</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-property-update-mode\\\"><span class=\\\"std std-ref\\\">update_mode</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-constant-manual\\\"><span class=\\\"std std-ref\\\">MANUAL</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayer-method-update\\\"><span class=\\\"std std-ref\\\">update</span></a>\", \"8\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btplayer-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 404,
|
||
"tpl": "Executes the root task of the behavior tree instance if <l1>active</l> is <2/>. Call this method when <l3>update_mode</l> is set to <l4>MANUAL</l>. When <l5>update_mode</l> is not <l6>MANUAL</l>, the <l7>update</l> will be called automatically. See <l8>UpdateMode</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayer-property-active\"><span class=\"std std-ref\">active</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayer-property-update-mode\"><span class=\"std std-ref\">update_mode</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btplayer-constant-manual\"><span class=\"std std-ref\">MANUAL</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-btplayer-property-update-mode\"><span class=\"std std-ref\">update_mode</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-btplayer-constant-manual\"><span class=\"std std-ref\">MANUAL</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#class-btplayer-method-update\"><span class=\"std std-ref\">update</span></a>",
|
||
"8": "<a class=\"reference internal\" href=\"#enum-btplayer-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"Blackboard\u0000{}": {
|
||
"uid": 405,
|
||
"tpl": "Blackboard",
|
||
"markers": {}
|
||
},
|
||
"A key/value storage for sharing among <l1>LimboHSM</l> states and <l2>BehaviorTree</l> tasks.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 406,
|
||
"tpl": "A key/value storage for sharing among <l1>LimboHSM</l> states and <l2>BehaviorTree</l> tasks.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Blackboard is where data is stored and shared between states in the <l1>LimboHSM</l> system and tasks in a <l2>BehaviorTree</l>. Each state and task in the <l3>BehaviorTree</l> can access this Blackboard, allowing them to read and write data. This makes it easy to share information between different actions and behaviors.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 407,
|
||
"tpl": "Blackboard is where data is stored and shared between states in the <l1>LimboHSM</l> system and tasks in a <l2>BehaviorTree</l>. Each state and task in the <l3>BehaviorTree</l> can access this Blackboard, allowing them to read and write data. This makes it easy to share information between different actions and behaviors.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Blackboard can also act as a parent scope for another Blackboard. If a specific variable is not found in the active scope, it looks in the parent Blackboard to find it. A parent Blackboard can itself have its own parent scope, forming what we call a “blackboard scope chain.” Importantly, there is no limit to how many Blackboards can be in this chain, and the Blackboard doesn’t modify values in the parent scopes.\u0000{}": {
|
||
"uid": 408,
|
||
"tpl": "Blackboard can also act as a parent scope for another Blackboard. If a specific variable is not found in the active scope, it looks in the parent Blackboard to find it. A parent Blackboard can itself have its own parent scope, forming what we call a “blackboard scope chain.” Importantly, there is no limit to how many Blackboards can be in this chain, and the Blackboard doesn’t modify values in the parent scopes.",
|
||
"markers": {}
|
||
},
|
||
"New scopes can be created using the <l1>BTNewScope</l> and <l2>BTSubtree</l> decorators. Additionally, a new scope is automatically created for any <l3>LimboState</l> that has defined non-empty Blackboard data or for any root-level <l4>LimboHSM</l> node.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btnewscope#class-btnewscope\\\"><span class=\\\"std std-ref\\\">BTNewScope</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsubtree#class-btsubtree\\\"><span class=\\\"std std-ref\\\">BTSubtree</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 409,
|
||
"tpl": "New scopes can be created using the <l1>BTNewScope</l> and <l2>BTSubtree</l> decorators. Additionally, a new scope is automatically created for any <l3>LimboState</l> that has defined non-empty Blackboard data or for any root-level <l4>LimboHSM</l> node.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btnewscope#class-btnewscope\"><span class=\"std std-ref\">BTNewScope</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btsubtree#class-btsubtree\"><span class=\"std std-ref\">BTSubtree</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"<l1>bind_var_to_property</l>(var_name: <2/>, object: <3/>, property: <4/>, create: <5/> = false)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-bind-var-to-property\\\"><span class=\\\"std std-ref\\\">bind_var_to_property</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 410,
|
||
"tpl": "<l1>bind_var_to_property</l>(var_name: <2/>, object: <3/>, property: <4/>, create: <5/> = false)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-bind-var-to-property\"><span class=\"std std-ref\">bind_var_to_property</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<l1>clear</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-clear\\\"><span class=\\\"std std-ref\\\">clear</span></a>\"}": {
|
||
"uid": 411,
|
||
"tpl": "<l1>clear</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-clear\"><span class=\"std std-ref\">clear</span></a>"
|
||
}
|
||
},
|
||
"<l1>erase_var</l>(var_name: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-erase-var\\\"><span class=\\\"std std-ref\\\">erase_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 412,
|
||
"tpl": "<l1>erase_var</l>(var_name: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-erase-var\"><span class=\"std std-ref\">erase_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<l1>Blackboard</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 413,
|
||
"tpl": "<l1>Blackboard</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_parent</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-get-parent\\\"><span class=\\\"std std-ref\\\">get_parent</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 414,
|
||
"tpl": "<l1>get_parent</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-get-parent\"><span class=\"std std-ref\">get_parent</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_var</l>(var_name: <2/>, default: <3/> = null, complain: <4/> = true) <5/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-get-var\\\"><span class=\\\"std std-ref\\\">get_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"5\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 415,
|
||
"tpl": "<l1>get_var</l>(var_name: <2/>, default: <3/> = null, complain: <4/> = true) <5/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-get-var\"><span class=\"std std-ref\">get_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"5": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_vars_as_dict</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-get-vars-as-dict\\\"><span class=\\\"std std-ref\\\">get_vars_as_dict</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 416,
|
||
"tpl": "<l1>get_vars_as_dict</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-get-vars-as-dict\"><span class=\"std std-ref\">get_vars_as_dict</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>has_var</l>(var_name: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-has-var\\\"><span class=\\\"std std-ref\\\">has_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 417,
|
||
"tpl": "<l1>has_var</l>(var_name: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-has-var\"><span class=\"std std-ref\">has_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>link_var</l>(var_name: <2/>, target_blackboard: <l3>Blackboard</l>, target_var: <4/>, create: <5/> = false)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-link-var\\\"><span class=\\\"std std-ref\\\">link_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 418,
|
||
"tpl": "<l1>link_var</l>(var_name: <2/>, target_blackboard: <l3>Blackboard</l>, target_var: <4/>, create: <5/> = false)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-link-var\"><span class=\"std std-ref\">link_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"Array[<1/>]\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 419,
|
||
"tpl": "Array[<1/>]",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<l1>list_vars</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-list-vars\\\"><span class=\\\"std std-ref\\\">list_vars</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 420,
|
||
"tpl": "<l1>list_vars</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-list-vars\"><span class=\"std std-ref\">list_vars</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>populate_from_dict</l>(dictionary: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-populate-from-dict\\\"><span class=\\\"std std-ref\\\">populate_from_dict</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Dictionary</span></code>\"}": {
|
||
"uid": 421,
|
||
"tpl": "<l1>populate_from_dict</l>(dictionary: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-populate-from-dict\"><span class=\"std std-ref\">populate_from_dict</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Dictionary</span></code>"
|
||
}
|
||
},
|
||
"<l1>print_state</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-print-state\\\"><span class=\\\"std std-ref\\\">print_state</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 422,
|
||
"tpl": "<l1>print_state</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-print-state\"><span class=\"std std-ref\">print_state</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>set_parent</l>(blackboard: <l2>Blackboard</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-set-parent\\\"><span class=\\\"std std-ref\\\">set_parent</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 423,
|
||
"tpl": "<l1>set_parent</l>(blackboard: <l2>Blackboard</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-set-parent\"><span class=\"std std-ref\">set_parent</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>set_var</l>(var_name: <2/>, value: <3/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-set-var\\\"><span class=\\\"std std-ref\\\">set_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\"}": {
|
||
"uid": 424,
|
||
"tpl": "<l1>set_var</l>(var_name: <2/>, value: <3/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-set-var\"><span class=\"std std-ref\">set_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>"
|
||
}
|
||
},
|
||
"<l1>top</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-top\\\"><span class=\\\"std std-ref\\\">top</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 425,
|
||
"tpl": "<l1>top</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-top\"><span class=\"std std-ref\">top</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>unbind_var</l>(var_name: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-unbind-var\\\"><span class=\\\"std std-ref\\\">unbind_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 426,
|
||
"tpl": "<l1>unbind_var</l>(var_name: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard-method-unbind-var\"><span class=\"std std-ref\">unbind_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>bind_var_to_property</b>(var_name: <2/>, object: <3/>, property: <4/>, create: <5/> = false) <l6>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-bind-var-to-property\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 427,
|
||
"tpl": "<1/> <b>bind_var_to_property</b>(var_name: <2/>, object: <3/>, property: <4/>, create: <5/> = false) <l6>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-blackboard-method-bind-var-to-property\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Establish a binding between a variable and the object’s property specified by <1/> and <2/>. Changes to the variable update the property, and vice versa. If <3/> is <4/>, the variable will be created if it doesn’t exist.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">property</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">object</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">create</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 428,
|
||
"tpl": "Establish a binding between a variable and the object’s property specified by <1/> and <2/>. Changes to the variable update the property, and vice versa. If <3/> is <4/>, the variable will be created if it doesn’t exist.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">property</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">object</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">create</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>clear</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-clear\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 429,
|
||
"tpl": "<1/> <b>clear</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-blackboard-method-clear\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Removes all variables from the Blackboard. Parent scopes are not affected.\u0000{}": {
|
||
"uid": 430,
|
||
"tpl": "Removes all variables from the Blackboard. Parent scopes are not affected.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>erase_var</b>(var_name: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-erase-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 431,
|
||
"tpl": "<1/> <b>erase_var</b>(var_name: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-erase-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Removes a variable by its name.\u0000{}": {
|
||
"uid": 432,
|
||
"tpl": "Removes a variable by its name.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Blackboard</l> <b>get_parent</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-get-parent\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 433,
|
||
"tpl": "<l1>Blackboard</l> <b>get_parent</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-get-parent\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns a Blackboard that serves as the parent scope for this instance.\u0000{}": {
|
||
"uid": 434,
|
||
"tpl": "Returns a Blackboard that serves as the parent scope for this instance.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_var</b>(var_name: <2/>, default: <3/> = null, complain: <4/> = true) <5/> <l6>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"5\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-get-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 435,
|
||
"tpl": "<1/> <b>get_var</b>(var_name: <2/>, default: <3/> = null, complain: <4/> = true) <5/> <l6>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"5": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-blackboard-method-get-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns variable value or <1/> if variable doesn’t exist. If <2/> is <3/>, an error will be printed if variable doesn’t exist. If the variable doesn’t exist in the current <b>Blackboard</b> scope, it will look in the parent scope <b>Blackboard</b> to find it.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">default</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">complain</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 436,
|
||
"tpl": "Returns variable value or <1/> if variable doesn’t exist. If <2/> is <3/>, an error will be printed if variable doesn’t exist. If the variable doesn’t exist in the current <b>Blackboard</b> scope, it will look in the parent scope <b>Blackboard</b> to find it.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">default</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">complain</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_vars_as_dict</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Dictionary</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-get-vars-as-dict\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 437,
|
||
"tpl": "<1/> <b>get_vars_as_dict</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Dictionary</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-get-vars-as-dict\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns all variables in the Blackboard as a dictionary. Keys are the variable names, values are the variable values. Parent scopes are not included.\u0000{}": {
|
||
"uid": 438,
|
||
"tpl": "Returns all variables in the Blackboard as a dictionary. Keys are the variable names, values are the variable values. Parent scopes are not included.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>has_var</b>(var_name: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-has-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 439,
|
||
"tpl": "<1/> <b>has_var</b>(var_name: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-blackboard-method-has-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if the Blackboard contains the <2/> variable, including the parent scopes.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">var_name</span></code>\"}": {
|
||
"uid": 440,
|
||
"tpl": "Returns <1/> if the Blackboard contains the <2/> variable, including the parent scopes.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">var_name</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>link_var</b>(var_name: <2/>, target_blackboard: <l3>Blackboard</l>, target_var: <4/>, create: <5/> = false) <l6>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-link-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 441,
|
||
"tpl": "<1/> <b>link_var</b>(var_name: <2/>, target_blackboard: <l3>Blackboard</l>, target_var: <4/>, create: <5/> = false) <l6>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-blackboard-method-link-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Links a variable to another Blackboard variable. If a variable is linked to another variable, their state will always be identical, and any change to one will be reflected in the other. If <1/> is <2/>, the variable will be created if it doesn’t exist.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">create</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 442,
|
||
"tpl": "Links a variable to another Blackboard variable. If a variable is linked to another variable, their state will always be identical, and any change to one will be reflected in the other. If <1/> is <2/>, the variable will be created if it doesn’t exist.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">create</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"You can use this method to link a variable in the current scope to a variable in another scope, or in another Blackboard instance. A variable can only be linked to one other variable. Calling this method again will overwrite the previous link. However, it is possible to link to the same variable from multiple different variables.\u0000{}": {
|
||
"uid": 443,
|
||
"tpl": "You can use this method to link a variable in the current scope to a variable in another scope, or in another Blackboard instance. A variable can only be linked to one other variable. Calling this method again will overwrite the previous link. However, it is possible to link to the same variable from multiple different variables.",
|
||
"markers": {}
|
||
},
|
||
"Array[<1/>] <b>list_vars</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-list-vars\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 444,
|
||
"tpl": "Array[<1/>] <b>list_vars</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-list-vars\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns all variable names in the Blackboard. Parent scopes are not included.\u0000{}": {
|
||
"uid": 445,
|
||
"tpl": "Returns all variable names in the Blackboard. Parent scopes are not included.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>populate_from_dict</b>(dictionary: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Dictionary</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-populate-from-dict\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 446,
|
||
"tpl": "<1/> <b>populate_from_dict</b>(dictionary: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Dictionary</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-populate-from-dict\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Fills the Blackboard with multiple variables from a dictionary. The dictionary keys must be variable names and the dictionary values must be variable values. Keys must be StringName or String.\u0000{}": {
|
||
"uid": 447,
|
||
"tpl": "Fills the Blackboard with multiple variables from a dictionary. The dictionary keys must be variable names and the dictionary values must be variable values. Keys must be StringName or String.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>print_state</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-print-state\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 448,
|
||
"tpl": "<1/> <b>print_state</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-print-state\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Prints the values of all variables in each scope.\u0000{}": {
|
||
"uid": 449,
|
||
"tpl": "Prints the values of all variables in each scope.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>set_parent</b>(blackboard: <l2>Blackboard</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-set-parent\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 450,
|
||
"tpl": "<1/> <b>set_parent</b>(blackboard: <l2>Blackboard</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-set-parent\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Assigns the parent scope. If a value isn’t in the current Blackboard scope, it will look in the parent scope Blackboard to find it.\u0000{}": {
|
||
"uid": 451,
|
||
"tpl": "Assigns the parent scope. If a value isn’t in the current Blackboard scope, it will look in the parent scope Blackboard to find it.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>set_var</b>(var_name: <2/>, value: <3/>) <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-set-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 452,
|
||
"tpl": "<1/> <b>set_var</b>(var_name: <2/>, value: <3/>) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-blackboard-method-set-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Assigns a value to a variable in the current Blackboard scope. If the variable doesn’t exist, it will be created. If the variable already exists in the parent scope, the parent scope value will NOT be changed.\u0000{}": {
|
||
"uid": 453,
|
||
"tpl": "Assigns a value to a variable in the current Blackboard scope. If the variable doesn’t exist, it will be created. If the variable already exists in the parent scope, the parent scope value will NOT be changed.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Blackboard</l> <b>top</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-top\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 454,
|
||
"tpl": "<l1>Blackboard</l> <b>top</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-top\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the topmost <b>Blackboard</b> in the scope chain.\u0000{}": {
|
||
"uid": 455,
|
||
"tpl": "Returns the topmost <b>Blackboard</b> in the scope chain.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>unbind_var</b>(var_name: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboard-method-unbind-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 456,
|
||
"tpl": "<1/> <b>unbind_var</b>(var_name: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboard-method-unbind-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Remove binding from a variable.\u0000{}": {
|
||
"uid": 457,
|
||
"tpl": "Remove binding from a variable.",
|
||
"markers": {}
|
||
},
|
||
"BBParam\u0000{}": {
|
||
"uid": 458,
|
||
"tpl": "BBParam",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BBAabb</l>, <l2>BBArray</l>, <l3>BBBasis</l>, <l4>BBBool</l>, <l5>BBByteArray</l>, <l6>BBColor</l>, <l7>BBColorArray</l>, <l8>BBDictionary</l>, <l9>BBFloat</l>, <l10>BBFloat32Array</l>, <l11>BBFloat64Array</l>, <l12>BBInt</l>, <l13>BBInt32Array</l>, <l14>BBInt64Array</l>, <l15>BBNode</l>, <l16>BBPlane</l>, <l17>BBProjection</l>, <l18>BBQuaternion</l>, <l19>BBRect2</l>, <l20>BBRect2i</l>, <l21>BBString</l>, <l22>BBStringArray</l>, <l23>BBStringName</l>, <l24>BBTransform2D</l>, <l25>BBTransform3D</l>, <l26>BBVariant</l>, <l27>BBVector2</l>, <l28>BBVector2Array</l>, <l29>BBVector2i</l>, <l30>BBVector3</l>, <l31>BBVector3Array</l>, <l32>BBVector3i</l>, <l33>BBVector4</l>, <l34>BBVector4i</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbaabb#class-bbaabb\\\"><span class=\\\"std std-ref\\\">BBAabb</span></a>\", \"10\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbfloat32array#class-bbfloat32array\\\"><span class=\\\"std std-ref\\\">BBFloat32Array</span></a>\", \"11\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbfloat64array#class-bbfloat64array\\\"><span class=\\\"std std-ref\\\">BBFloat64Array</span></a>\", \"12\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbint#class-bbint\\\"><span class=\\\"std std-ref\\\">BBInt</span></a>\", \"13\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbint32array#class-bbint32array\\\"><span class=\\\"std std-ref\\\">BBInt32Array</span></a>\", \"14\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbint64array#class-bbint64array\\\"><span class=\\\"std std-ref\\\">BBInt64Array</span></a>\", \"15\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"16\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbplane#class-bbplane\\\"><span class=\\\"std std-ref\\\">BBPlane</span></a>\", \"17\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbprojection#class-bbprojection\\\"><span class=\\\"std std-ref\\\">BBProjection</span></a>\", \"18\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbquaternion#class-bbquaternion\\\"><span class=\\\"std std-ref\\\">BBQuaternion</span></a>\", \"19\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbrect2#class-bbrect2\\\"><span class=\\\"std std-ref\\\">BBRect2</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbarray#class-bbarray\\\"><span class=\\\"std std-ref\\\">BBArray</span></a>\", \"20\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbrect2i#class-bbrect2i\\\"><span class=\\\"std std-ref\\\">BBRect2i</span></a>\", \"21\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbstring#class-bbstring\\\"><span class=\\\"std std-ref\\\">BBString</span></a>\", \"22\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbstringarray#class-bbstringarray\\\"><span class=\\\"std std-ref\\\">BBStringArray</span></a>\", \"23\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbstringname#class-bbstringname\\\"><span class=\\\"std std-ref\\\">BBStringName</span></a>\", \"24\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbtransform2d#class-bbtransform2d\\\"><span class=\\\"std std-ref\\\">BBTransform2D</span></a>\", \"25\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbtransform3d#class-bbtransform3d\\\"><span class=\\\"std std-ref\\\">BBTransform3D</span></a>\", \"26\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\", \"27\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector2#class-bbvector2\\\"><span class=\\\"std std-ref\\\">BBVector2</span></a>\", \"28\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector2array#class-bbvector2array\\\"><span class=\\\"std std-ref\\\">BBVector2Array</span></a>\", \"29\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector2i#class-bbvector2i\\\"><span class=\\\"std std-ref\\\">BBVector2i</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbbasis#class-bbbasis\\\"><span class=\\\"std std-ref\\\">BBBasis</span></a>\", \"30\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector3#class-bbvector3\\\"><span class=\\\"std std-ref\\\">BBVector3</span></a>\", \"31\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector3array#class-bbvector3array\\\"><span class=\\\"std std-ref\\\">BBVector3Array</span></a>\", \"32\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector3i#class-bbvector3i\\\"><span class=\\\"std std-ref\\\">BBVector3i</span></a>\", \"33\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector4#class-bbvector4\\\"><span class=\\\"std std-ref\\\">BBVector4</span></a>\", \"34\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvector4i#class-bbvector4i\\\"><span class=\\\"std std-ref\\\">BBVector4i</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbbool#class-bbbool\\\"><span class=\\\"std std-ref\\\">BBBool</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbbytearray#class-bbbytearray\\\"><span class=\\\"std std-ref\\\">BBByteArray</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbcolor#class-bbcolor\\\"><span class=\\\"std std-ref\\\">BBColor</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbcolorarray#class-bbcolorarray\\\"><span class=\\\"std std-ref\\\">BBColorArray</span></a>\", \"8\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbdictionary#class-bbdictionary\\\"><span class=\\\"std std-ref\\\">BBDictionary</span></a>\", \"9\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbfloat#class-bbfloat\\\"><span class=\\\"std std-ref\\\">BBFloat</span></a>\"}": {
|
||
"uid": 459,
|
||
"tpl": "<b>Inherited By:</b> <l1>BBAabb</l>, <l2>BBArray</l>, <l3>BBBasis</l>, <l4>BBBool</l>, <l5>BBByteArray</l>, <l6>BBColor</l>, <l7>BBColorArray</l>, <l8>BBDictionary</l>, <l9>BBFloat</l>, <l10>BBFloat32Array</l>, <l11>BBFloat64Array</l>, <l12>BBInt</l>, <l13>BBInt32Array</l>, <l14>BBInt64Array</l>, <l15>BBNode</l>, <l16>BBPlane</l>, <l17>BBProjection</l>, <l18>BBQuaternion</l>, <l19>BBRect2</l>, <l20>BBRect2i</l>, <l21>BBString</l>, <l22>BBStringArray</l>, <l23>BBStringName</l>, <l24>BBTransform2D</l>, <l25>BBTransform3D</l>, <l26>BBVariant</l>, <l27>BBVector2</l>, <l28>BBVector2Array</l>, <l29>BBVector2i</l>, <l30>BBVector3</l>, <l31>BBVector3Array</l>, <l32>BBVector3i</l>, <l33>BBVector4</l>, <l34>BBVector4i</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbaabb#class-bbaabb\"><span class=\"std std-ref\">BBAabb</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbarray#class-bbarray\"><span class=\"std std-ref\">BBArray</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bbbasis#class-bbbasis\"><span class=\"std std-ref\">BBBasis</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_bbbool#class-bbbool\"><span class=\"std std-ref\">BBBool</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_bbbytearray#class-bbbytearray\"><span class=\"std std-ref\">BBByteArray</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_bbcolor#class-bbcolor\"><span class=\"std std-ref\">BBColor</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_bbcolorarray#class-bbcolorarray\"><span class=\"std std-ref\">BBColorArray</span></a>",
|
||
"8": "<a class=\"reference internal\" href=\"#document-classes/class_bbdictionary#class-bbdictionary\"><span class=\"std std-ref\">BBDictionary</span></a>",
|
||
"9": "<a class=\"reference internal\" href=\"#document-classes/class_bbfloat#class-bbfloat\"><span class=\"std std-ref\">BBFloat</span></a>",
|
||
"10": "<a class=\"reference internal\" href=\"#document-classes/class_bbfloat32array#class-bbfloat32array\"><span class=\"std std-ref\">BBFloat32Array</span></a>",
|
||
"11": "<a class=\"reference internal\" href=\"#document-classes/class_bbfloat64array#class-bbfloat64array\"><span class=\"std std-ref\">BBFloat64Array</span></a>",
|
||
"12": "<a class=\"reference internal\" href=\"#document-classes/class_bbint#class-bbint\"><span class=\"std std-ref\">BBInt</span></a>",
|
||
"13": "<a class=\"reference internal\" href=\"#document-classes/class_bbint32array#class-bbint32array\"><span class=\"std std-ref\">BBInt32Array</span></a>",
|
||
"14": "<a class=\"reference internal\" href=\"#document-classes/class_bbint64array#class-bbint64array\"><span class=\"std std-ref\">BBInt64Array</span></a>",
|
||
"15": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"16": "<a class=\"reference internal\" href=\"#document-classes/class_bbplane#class-bbplane\"><span class=\"std std-ref\">BBPlane</span></a>",
|
||
"17": "<a class=\"reference internal\" href=\"#document-classes/class_bbprojection#class-bbprojection\"><span class=\"std std-ref\">BBProjection</span></a>",
|
||
"18": "<a class=\"reference internal\" href=\"#document-classes/class_bbquaternion#class-bbquaternion\"><span class=\"std std-ref\">BBQuaternion</span></a>",
|
||
"19": "<a class=\"reference internal\" href=\"#document-classes/class_bbrect2#class-bbrect2\"><span class=\"std std-ref\">BBRect2</span></a>",
|
||
"20": "<a class=\"reference internal\" href=\"#document-classes/class_bbrect2i#class-bbrect2i\"><span class=\"std std-ref\">BBRect2i</span></a>",
|
||
"21": "<a class=\"reference internal\" href=\"#document-classes/class_bbstring#class-bbstring\"><span class=\"std std-ref\">BBString</span></a>",
|
||
"22": "<a class=\"reference internal\" href=\"#document-classes/class_bbstringarray#class-bbstringarray\"><span class=\"std std-ref\">BBStringArray</span></a>",
|
||
"23": "<a class=\"reference internal\" href=\"#document-classes/class_bbstringname#class-bbstringname\"><span class=\"std std-ref\">BBStringName</span></a>",
|
||
"24": "<a class=\"reference internal\" href=\"#document-classes/class_bbtransform2d#class-bbtransform2d\"><span class=\"std std-ref\">BBTransform2D</span></a>",
|
||
"25": "<a class=\"reference internal\" href=\"#document-classes/class_bbtransform3d#class-bbtransform3d\"><span class=\"std std-ref\">BBTransform3D</span></a>",
|
||
"26": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>",
|
||
"27": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector2#class-bbvector2\"><span class=\"std std-ref\">BBVector2</span></a>",
|
||
"28": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector2array#class-bbvector2array\"><span class=\"std std-ref\">BBVector2Array</span></a>",
|
||
"29": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector2i#class-bbvector2i\"><span class=\"std std-ref\">BBVector2i</span></a>",
|
||
"30": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector3#class-bbvector3\"><span class=\"std std-ref\">BBVector3</span></a>",
|
||
"31": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector3array#class-bbvector3array\"><span class=\"std std-ref\">BBVector3Array</span></a>",
|
||
"32": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector3i#class-bbvector3i\"><span class=\"std std-ref\">BBVector3i</span></a>",
|
||
"33": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector4#class-bbvector4\"><span class=\"std std-ref\">BBVector4</span></a>",
|
||
"34": "<a class=\"reference internal\" href=\"#document-classes/class_bbvector4i#class-bbvector4i\"><span class=\"std std-ref\">BBVector4i</span></a>"
|
||
}
|
||
},
|
||
"A base class for LimboAI typed parameters.\u0000{}": {
|
||
"uid": 460,
|
||
"tpl": "A base class for LimboAI typed parameters.",
|
||
"markers": {}
|
||
},
|
||
"A base class for LimboAI typed parameters, with the ability to reference a <l1>Blackboard</l> variable or hold a raw value of a specific Variant.Type.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 461,
|
||
"tpl": "A base class for LimboAI typed parameters, with the ability to reference a <l1>Blackboard</l> variable or hold a raw value of a specific Variant.Type.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<b>Note</b>: Don’t instantiate. Use specific subtypes instead.\u0000{}": {
|
||
"uid": 462,
|
||
"tpl": "<b>Note</b>: Don’t instantiate. Use specific subtypes instead.",
|
||
"markers": {}
|
||
},
|
||
"<l1>saved_value</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-saved-value\\\"><span class=\\\"std std-ref\\\">saved_value</span></a>\"}": {
|
||
"uid": 463,
|
||
"tpl": "<l1>saved_value</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbparam-property-saved-value\"><span class=\"std std-ref\">saved_value</span></a>"
|
||
}
|
||
},
|
||
"<l1>ValueSource</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">ValueSource</span></a>\"}": {
|
||
"uid": 464,
|
||
"tpl": "<l1>ValueSource</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">ValueSource</span></a>"
|
||
}
|
||
},
|
||
"<l1>value_source</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-value-source\\\"><span class=\\\"std std-ref\\\">value_source</span></a>\"}": {
|
||
"uid": 465,
|
||
"tpl": "<l1>value_source</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbparam-property-value-source\"><span class=\"std std-ref\">value_source</span></a>"
|
||
}
|
||
},
|
||
"<l1>variable</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\"}": {
|
||
"uid": 466,
|
||
"tpl": "<l1>variable</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbparam-property-variable\"><span class=\"std std-ref\">variable</span></a>"
|
||
}
|
||
},
|
||
"Variant.Type\u0000{}": {
|
||
"uid": 467,
|
||
"tpl": "Variant.Type",
|
||
"markers": {}
|
||
},
|
||
"<l1>get_type</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-method-get-type\\\"><span class=\\\"std std-ref\\\">get_type</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 468,
|
||
"tpl": "<l1>get_type</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbparam-method-get-type\"><span class=\"std std-ref\">get_type</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_value</l>(scene_root: <2/>, blackboard: <l3>Blackboard</l>, default: <4/> = null)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-method-get-value\\\"><span class=\\\"std std-ref\\\">get_value</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\"}": {
|
||
"uid": 469,
|
||
"tpl": "<l1>get_value</l>(scene_root: <2/>, blackboard: <l3>Blackboard</l>, default: <4/> = null)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbparam-method-get-value\"><span class=\"std std-ref\">get_value</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>"
|
||
}
|
||
},
|
||
"enum <b>ValueSource</b>: <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 470,
|
||
"tpl": "enum <b>ValueSource</b>: <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>ValueSource</l> <b>SAVED_VALUE</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">ValueSource</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\"}": {
|
||
"uid": 471,
|
||
"tpl": "<l1>ValueSource</l> <b>SAVED_VALUE</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">ValueSource</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>"
|
||
}
|
||
},
|
||
"The value is stored directly within the BBParam resource.\u0000{}": {
|
||
"uid": 472,
|
||
"tpl": "The value is stored directly within the BBParam resource.",
|
||
"markers": {}
|
||
},
|
||
"<l1>ValueSource</l> <b>BLACKBOARD_VAR</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">ValueSource</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\"}": {
|
||
"uid": 473,
|
||
"tpl": "<l1>ValueSource</l> <b>BLACKBOARD_VAR</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">ValueSource</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>"
|
||
}
|
||
},
|
||
"The value is referenced by a variable name and retrieved from the <l1>Blackboard</l>. The variable name is stored within the BBParam resource.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 474,
|
||
"tpl": "The value is referenced by a variable name and retrieved from the <l1>Blackboard</l>. The variable name is stored within the BBParam resource.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>saved_value</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">null</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-saved-value\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 475,
|
||
"tpl": "<1/> <b>saved_value</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">null</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bbparam-property-saved-value\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_saved_value</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\"}": {
|
||
"uid": 476,
|
||
"tpl": "<1/> <b>set_saved_value</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_saved_value</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\"}": {
|
||
"uid": 477,
|
||
"tpl": "<1/> <b>get_saved_value</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>"
|
||
}
|
||
},
|
||
"Stores the parameter value when <l1>value_source</l> is set to <l2>SAVED_VALUE</l>. The data type of the value is determined by <l3>get_type</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-value-source\\\"><span class=\\\"std std-ref\\\">value_source</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-constant-saved-value\\\"><span class=\\\"std std-ref\\\">SAVED_VALUE</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-method-get-type\\\"><span class=\\\"std std-ref\\\">get_type</span></a>\"}": {
|
||
"uid": 478,
|
||
"tpl": "Stores the parameter value when <l1>value_source</l> is set to <l2>SAVED_VALUE</l>. The data type of the value is determined by <l3>get_type</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbparam-property-value-source\"><span class=\"std std-ref\">value_source</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bbparam-constant-saved-value\"><span class=\"std std-ref\">SAVED_VALUE</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bbparam-method-get-type\"><span class=\"std std-ref\">get_type</span></a>"
|
||
}
|
||
},
|
||
"<l1>ValueSource</l> <b>value_source</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">ValueSource</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-value-source\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 479,
|
||
"tpl": "<l1>ValueSource</l> <b>value_source</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">ValueSource</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bbparam-property-value-source\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_value_source</b>(value: <l2>ValueSource</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">ValueSource</span></a>\"}": {
|
||
"uid": 480,
|
||
"tpl": "<1/> <b>set_value_source</b>(value: <l2>ValueSource</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">ValueSource</span></a>"
|
||
}
|
||
},
|
||
"<l1>ValueSource</l> <b>get_value_source</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">ValueSource</span></a>\"}": {
|
||
"uid": 481,
|
||
"tpl": "<l1>ValueSource</l> <b>get_value_source</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">ValueSource</span></a>"
|
||
}
|
||
},
|
||
"Specifies the source of the value for BBParam. See <l1>ValueSource</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bbparam-valuesource\\\"><span class=\\\"std std-ref\\\">ValueSource</span></a>\"}": {
|
||
"uid": 482,
|
||
"tpl": "Specifies the source of the value for BBParam. See <l1>ValueSource</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bbparam-valuesource\"><span class=\"std std-ref\">ValueSource</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>variable</b> <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-variable\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 483,
|
||
"tpl": "<1/> <b>variable</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bbparam-property-variable\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_variable</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 484,
|
||
"tpl": "<1/> <b>set_variable</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_variable</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 485,
|
||
"tpl": "<1/> <b>get_variable</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"Stores the name of a <l1>Blackboard</l> variable when <l2>value_source</l> is set to <l3>BLACKBOARD_VAR</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-property-value-source\\\"><span class=\\\"std std-ref\\\">value_source</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-constant-blackboard-var\\\"><span class=\\\"std std-ref\\\">BLACKBOARD_VAR</span></a>\"}": {
|
||
"uid": 486,
|
||
"tpl": "Stores the name of a <l1>Blackboard</l> variable when <l2>value_source</l> is set to <l3>BLACKBOARD_VAR</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bbparam-property-value-source\"><span class=\"std std-ref\">value_source</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bbparam-constant-blackboard-var\"><span class=\"std std-ref\">BLACKBOARD_VAR</span></a>"
|
||
}
|
||
},
|
||
"Variant.Type <b>get_type</b>() <1/> <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-method-get-type\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 487,
|
||
"tpl": "Variant.Type <b>get_type</b>() <1/> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bbparam-method-get-type\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the expected data type of the parameter.\u0000{}": {
|
||
"uid": 488,
|
||
"tpl": "Returns the expected data type of the parameter.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_value</b>(scene_root: <2/>, blackboard: <l3>Blackboard</l>, default: <4/> = null) <l5>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbparam-method-get-value\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 489,
|
||
"tpl": "<1/> <b>get_value</b>(scene_root: <2/>, blackboard: <l3>Blackboard</l>, default: <4/> = null) <l5>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-bbparam-method-get-value\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the value of the parameter.\u0000{}": {
|
||
"uid": 490,
|
||
"tpl": "Returns the value of the parameter.",
|
||
"markers": {}
|
||
},
|
||
"LimboState\u0000{}": {
|
||
"uid": 491,
|
||
"tpl": "LimboState",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTState</l>, <l2>LimboHSM</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 492,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTState</l>, <l2>LimboHSM</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"A state node for Hierarchical State Machines (HSM).\u0000{}": {
|
||
"uid": 493,
|
||
"tpl": "A state node for Hierarchical State Machines (HSM).",
|
||
"markers": {}
|
||
},
|
||
"A LimboAI state node for Hierarchical State Machines (HSM).\u0000{}": {
|
||
"uid": 494,
|
||
"tpl": "A LimboAI state node for Hierarchical State Machines (HSM).",
|
||
"markers": {}
|
||
},
|
||
"You can create your state behavior by extending this class. To implement your state logic, you can override <l1>_enter</l>, <l2>_exit</l>, <l3>_setup</l>, and <l4>_update</l>. Alternatively, you can delegate state implementation to external methods using the <5/> methods.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-enter\\\"><span class=\\\"std std-ref\\\">_enter</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-exit\\\"><span class=\\\"std std-ref\\\">_exit</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-setup\\\"><span class=\\\"std std-ref\\\">_setup</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-update\\\"><span class=\\\"std std-ref\\\">_update</span></a>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">call_on_*</span></code>\"}": {
|
||
"uid": 495,
|
||
"tpl": "You can create your state behavior by extending this class. To implement your state logic, you can override <l1>_enter</l>, <l2>_exit</l>, <l3>_setup</l>, and <l4>_update</l>. Alternatively, you can delegate state implementation to external methods using the <5/> methods.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-enter\"><span class=\"std std-ref\">_enter</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-exit\"><span class=\"std std-ref\">_exit</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-setup\"><span class=\"std std-ref\">_setup</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-update\"><span class=\"std std-ref\">_update</span></a>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">call_on_*</span></code>"
|
||
}
|
||
},
|
||
"For additional details on state machines, refer to <l1>LimboHSM</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 496,
|
||
"tpl": "For additional details on state machines, refer to <l1>LimboHSM</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"<l1>EVENT_FINISHED</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-event-finished\\\"><span class=\\\"std std-ref\\\">EVENT_FINISHED</span></a>\"}": {
|
||
"uid": 497,
|
||
"tpl": "<l1>EVENT_FINISHED</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-property-event-finished\"><span class=\"std std-ref\">EVENT_FINISHED</span></a>"
|
||
}
|
||
},
|
||
"<l1>agent</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-agent\\\"><span class=\\\"std std-ref\\\">agent</span></a>\"}": {
|
||
"uid": 498,
|
||
"tpl": "<l1>agent</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-property-agent\"><span class=\"std std-ref\">agent</span></a>"
|
||
}
|
||
},
|
||
"<l1>blackboard</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-blackboard\\\"><span class=\\\"std std-ref\\\">blackboard</span></a>\"}": {
|
||
"uid": 499,
|
||
"tpl": "<l1>blackboard</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-property-blackboard\"><span class=\"std std-ref\">blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>blackboard_plan</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">blackboard_plan</span></a>\"}": {
|
||
"uid": 500,
|
||
"tpl": "<l1>blackboard_plan</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-property-blackboard-plan\"><span class=\"std std-ref\">blackboard_plan</span></a>"
|
||
}
|
||
},
|
||
"<l1>_enter</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-enter\\\"><span class=\\\"std std-ref\\\">_enter</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 501,
|
||
"tpl": "<l1>_enter</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-enter\"><span class=\"std std-ref\">_enter</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>_exit</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-exit\\\"><span class=\\\"std std-ref\\\">_exit</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 502,
|
||
"tpl": "<l1>_exit</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-exit\"><span class=\"std std-ref\">_exit</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>_setup</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-setup\\\"><span class=\\\"std std-ref\\\">_setup</span></a>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 503,
|
||
"tpl": "<l1>_setup</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-setup\"><span class=\"std std-ref\">_setup</span></a>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>_update</l>(delta: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-update\\\"><span class=\\\"std std-ref\\\">_update</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\"}": {
|
||
"uid": 504,
|
||
"tpl": "<l1>_update</l>(delta: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-update\"><span class=\"std std-ref\">_update</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>"
|
||
}
|
||
},
|
||
"<l1>add_event_handler</l>(event: <2/>, handler: <3/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-add-event-handler\\\"><span class=\\\"std std-ref\\\">add_event_handler</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\"}": {
|
||
"uid": 505,
|
||
"tpl": "<l1>add_event_handler</l>(event: <2/>, handler: <3/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-add-event-handler\"><span class=\"std std-ref\">add_event_handler</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 506,
|
||
"tpl": "<l1>LimboState</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"<l1>call_on_enter</l>(callable: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-call-on-enter\\\"><span class=\\\"std std-ref\\\">call_on_enter</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\"}": {
|
||
"uid": 507,
|
||
"tpl": "<l1>call_on_enter</l>(callable: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-call-on-enter\"><span class=\"std std-ref\">call_on_enter</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>call_on_exit</l>(callable: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-call-on-exit\\\"><span class=\\\"std std-ref\\\">call_on_exit</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\"}": {
|
||
"uid": 508,
|
||
"tpl": "<l1>call_on_exit</l>(callable: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-call-on-exit\"><span class=\"std std-ref\">call_on_exit</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>call_on_update</l>(callable: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-call-on-update\\\"><span class=\\\"std std-ref\\\">call_on_update</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\"}": {
|
||
"uid": 509,
|
||
"tpl": "<l1>call_on_update</l>(callable: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-call-on-update\"><span class=\"std std-ref\">call_on_update</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>clear_guard</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-clear-guard\\\"><span class=\\\"std std-ref\\\">clear_guard</span></a>\"}": {
|
||
"uid": 510,
|
||
"tpl": "<l1>clear_guard</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-clear-guard\"><span class=\"std std-ref\">clear_guard</span></a>"
|
||
}
|
||
},
|
||
"<l1>dispatch</l>(event: <2/>, cargo: <3/> = null)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-dispatch\\\"><span class=\\\"std std-ref\\\">dispatch</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\"}": {
|
||
"uid": 511,
|
||
"tpl": "<l1>dispatch</l>(event: <2/>, cargo: <3/> = null)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-dispatch\"><span class=\"std std-ref\">dispatch</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>"
|
||
}
|
||
},
|
||
"<l1>get_root</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-get-root\\\"><span class=\\\"std std-ref\\\">get_root</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 512,
|
||
"tpl": "<l1>get_root</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-get-root\"><span class=\"std std-ref\">get_root</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>is_active</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-is-active\\\"><span class=\\\"std std-ref\\\">is_active</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 513,
|
||
"tpl": "<l1>is_active</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-is-active\"><span class=\"std std-ref\">is_active</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>named</l>(name: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-named\\\"><span class=\\\"std std-ref\\\">named</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 514,
|
||
"tpl": "<l1>named</l>(name: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-named\"><span class=\"std std-ref\">named</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"<l1>set_guard</l>(guard_callable: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-set-guard\\\"><span class=\\\"std std-ref\\\">set_guard</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\"}": {
|
||
"uid": 515,
|
||
"tpl": "<l1>set_guard</l>(guard_callable: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-set-guard\"><span class=\"std std-ref\">set_guard</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>"
|
||
}
|
||
},
|
||
"<b>entered</b>() <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-signal-entered\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 516,
|
||
"tpl": "<b>entered</b>() <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-signal-entered\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the state is entered.\u0000{}": {
|
||
"uid": 517,
|
||
"tpl": "Emitted when the state is entered.",
|
||
"markers": {}
|
||
},
|
||
"<b>exited</b>() <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-signal-exited\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 518,
|
||
"tpl": "<b>exited</b>() <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-signal-exited\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the state is exited.\u0000{}": {
|
||
"uid": 519,
|
||
"tpl": "Emitted when the state is exited.",
|
||
"markers": {}
|
||
},
|
||
"<b>setup</b>() <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-signal-setup\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 520,
|
||
"tpl": "<b>setup</b>() <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-signal-setup\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the state is initialized.\u0000{}": {
|
||
"uid": 521,
|
||
"tpl": "Emitted when the state is initialized.",
|
||
"markers": {}
|
||
},
|
||
"<b>updated</b>(delta: <1/>) <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-signal-updated\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 522,
|
||
"tpl": "<b>updated</b>(delta: <1/>) <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-signal-updated\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the state is updated.\u0000{}": {
|
||
"uid": 523,
|
||
"tpl": "Emitted when the state is updated.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>EVENT_FINISHED</b> <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-event-finished\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 524,
|
||
"tpl": "<1/> <b>EVENT_FINISHED</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-property-event-finished\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>event_finished</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 525,
|
||
"tpl": "<1/> <b>event_finished</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"A commonly used event that indicates that the state has finished its work.\u0000{}": {
|
||
"uid": 526,
|
||
"tpl": "A commonly used event that indicates that the state has finished its work.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>agent</b> <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-agent\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 527,
|
||
"tpl": "<1/> <b>agent</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-property-agent\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"An agent associated with the state, assigned during initialization.\u0000{}": {
|
||
"uid": 528,
|
||
"tpl": "An agent associated with the state, assigned during initialization.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Blackboard</l> <b>blackboard</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-blackboard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 529,
|
||
"tpl": "<l1>Blackboard</l> <b>blackboard</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-property-blackboard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A key/value data store shared by states within the state machine to which this state belongs.\u0000{}": {
|
||
"uid": 530,
|
||
"tpl": "A key/value data store shared by states within the state machine to which this state belongs.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 531,
|
||
"tpl": "<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-property-blackboard-plan\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>_enter</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-enter\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 532,
|
||
"tpl": "<1/> <b>_enter</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-enter\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called when the state is entered.\u0000{}": {
|
||
"uid": 533,
|
||
"tpl": "Called when the state is entered.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>_exit</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-exit\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 534,
|
||
"tpl": "<1/> <b>_exit</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-exit\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called when the state is exited. This happens on a transition to another state, and when the state machine is removed from the scene tree (e.g., when the node is freed with Node.queue_free or the scene changes). Due to implementation details, <l1>_exit</l> will not be called on Object.free!\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-exit\\\"><span class=\\\"std std-ref\\\">_exit</span></a>\"}": {
|
||
"uid": 535,
|
||
"tpl": "Called when the state is exited. This happens on a transition to another state, and when the state machine is removed from the scene tree (e.g., when the node is freed with Node.queue_free or the scene changes). Due to implementation details, <l1>_exit</l> will not be called on Object.free!",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-exit\"><span class=\"std std-ref\">_exit</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>_setup</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-setup\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 536,
|
||
"tpl": "<1/> <b>_setup</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-setup\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called once during initialization. Use this method to initialize your state.\u0000{}": {
|
||
"uid": 537,
|
||
"tpl": "Called once during initialization. Use this method to initialize your state.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>_update</b>(delta: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<abbr title=\\\"This method should typically be overridden by the user to have any effect.\\\">virtual</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-private-method-update\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 538,
|
||
"tpl": "<1/> <b>_update</b>(delta: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<abbr title=\"This method should typically be overridden by the user to have any effect.\">virtual</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limbostate-private-method-update\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Called during the update. Implement your state’s behavior with this method.\u0000{}": {
|
||
"uid": 539,
|
||
"tpl": "Called during the update. Implement your state’s behavior with this method.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>add_event_handler</b>(event: <2/>, handler: <3/>) <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-add-event-handler\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 540,
|
||
"tpl": "<1/> <b>add_event_handler</b>(event: <2/>, handler: <3/>) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limbostate-method-add-event-handler\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Registers a <1/> to be called when <2/> is dispatched. The handler function should have the following signature:\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">handler</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">event</span></code>\"}": {
|
||
"uid": 541,
|
||
"tpl": "Registers a <1/> to be called when <2/> is dispatched. The handler function should have the following signature:",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">handler</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">event</span></code>"
|
||
}
|
||
},
|
||
"If the handler returns <1/>, the event will be consumed. Cargo is an optional parameter that can be passed to the handler. See also <l2>dispatch</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-dispatch\\\"><span class=\\\"std std-ref\\\">dispatch</span></a>\"}": {
|
||
"uid": 542,
|
||
"tpl": "If the handler returns <1/>, the event will be consumed. Cargo is an optional parameter that can be passed to the handler. See also <l2>dispatch</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-method-dispatch\"><span class=\"std std-ref\">dispatch</span></a>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>call_on_enter</b>(callable: <2/>) <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-call-on-enter\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 543,
|
||
"tpl": "<l1>LimboState</l> <b>call_on_enter</b>(callable: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-method-call-on-enter\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A chained method that connects the <l1>entered</l> signal to a <2/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-signal-entered\\\"><span class=\\\"std std-ref\\\">entered</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">callable</span></code>\"}": {
|
||
"uid": 544,
|
||
"tpl": "A chained method that connects the <l1>entered</l> signal to a <2/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-signal-entered\"><span class=\"std std-ref\">entered</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>call_on_exit</b>(callable: <2/>) <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-call-on-exit\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 545,
|
||
"tpl": "<l1>LimboState</l> <b>call_on_exit</b>(callable: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-method-call-on-exit\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A chained method that connects the <l1>exited</l> signal to a <2/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-signal-exited\\\"><span class=\\\"std std-ref\\\">exited</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">callable</span></code>\"}": {
|
||
"uid": 546,
|
||
"tpl": "A chained method that connects the <l1>exited</l> signal to a <2/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-signal-exited\"><span class=\"std std-ref\">exited</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>call_on_update</b>(callable: <2/>) <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-call-on-update\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 547,
|
||
"tpl": "<l1>LimboState</l> <b>call_on_update</b>(callable: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-method-call-on-update\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A chained method that connects the <l1>updated</l> signal to a <2/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-signal-updated\\\"><span class=\\\"std std-ref\\\">updated</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">callable</span></code>\"}": {
|
||
"uid": 548,
|
||
"tpl": "A chained method that connects the <l1>updated</l> signal to a <2/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-signal-updated\"><span class=\"std std-ref\">updated</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">callable</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>clear_guard</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-clear-guard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 549,
|
||
"tpl": "<1/> <b>clear_guard</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-method-clear-guard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Clears the guard function, removing the <1/> previously set by <l2>set_guard</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-set-guard\\\"><span class=\\\"std std-ref\\\">set_guard</span></a>\"}": {
|
||
"uid": 550,
|
||
"tpl": "Clears the guard function, removing the <1/> previously set by <l2>set_guard</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbostate-method-set-guard\"><span class=\"std std-ref\">set_guard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>dispatch</b>(event: <2/>, cargo: <3/> = null) <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-dispatch\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 551,
|
||
"tpl": "<1/> <b>dispatch</b>(event: <2/>, cargo: <3/> = null) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limbostate-method-dispatch\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Recursively dispatches a state machine event named <1/> with an optional argument <2/>. Returns <3/> if the event was consumed.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">event</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">cargo</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 552,
|
||
"tpl": "Recursively dispatches a state machine event named <1/> with an optional argument <2/>. Returns <3/> if the event was consumed.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">event</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">cargo</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"Events propagate from the leaf state to the root state, and propagation stops as soon as any state consumes the event. States will consume the event if they have a related transition or event handler. For more information on event handlers, see <l1>add_event_handler</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-add-event-handler\\\"><span class=\\\"std std-ref\\\">add_event_handler</span></a>\"}": {
|
||
"uid": 553,
|
||
"tpl": "Events propagate from the leaf state to the root state, and propagation stops as soon as any state consumes the event. States will consume the event if they have a related transition or event handler. For more information on event handlers, see <l1>add_event_handler</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate-method-add-event-handler\"><span class=\"std std-ref\">add_event_handler</span></a>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>get_root</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-get-root\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 554,
|
||
"tpl": "<l1>LimboState</l> <b>get_root</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-method-get-root\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the root <b>LimboState</b>.\u0000{}": {
|
||
"uid": 555,
|
||
"tpl": "Returns the root <b>LimboState</b>.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>is_active</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-is-active\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 556,
|
||
"tpl": "<1/> <b>is_active</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-method-is-active\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if it is currently active, meaning it is the active substate of the parent <l2>LimboHSM</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\"}": {
|
||
"uid": 557,
|
||
"tpl": "Returns <1/> if it is currently active, meaning it is the active substate of the parent <l2>LimboHSM</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>named</b>(name: <2/>) <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-named\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 558,
|
||
"tpl": "<l1>LimboState</l> <b>named</b>(name: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-method-named\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A chained method for setting the name of this state.\u0000{}": {
|
||
"uid": 559,
|
||
"tpl": "A chained method for setting the name of this state.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>set_guard</b>(guard_callable: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbostate-method-set-guard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 560,
|
||
"tpl": "<1/> <b>set_guard</b>(guard_callable: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbostate-method-set-guard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the guard function, which is a function called each time a transition to this state is considered. If the function returns <1/>, the transition will be disallowed.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\"}": {
|
||
"uid": 561,
|
||
"tpl": "Sets the guard function, which is a function called each time a transition to this state is considered. If the function returns <1/>, the transition will be disallowed.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>"
|
||
}
|
||
},
|
||
"LimboHSM\u0000{}": {
|
||
"uid": 562,
|
||
"tpl": "LimboHSM",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>LimboState</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 563,
|
||
"tpl": "<b>Inherits:</b> <l1>LimboState</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"Event-based Hierarchical State Machine (HSM).\u0000{}": {
|
||
"uid": 564,
|
||
"tpl": "Event-based Hierarchical State Machine (HSM).",
|
||
"markers": {}
|
||
},
|
||
"Event-based Hierarchical State Machine (HSM) that manages <l1>LimboState</l> instances and facilitates transitions between them. LimboHSM is a <l2>LimboState</l> in itself and can also serve as a child of another LimboHSM node.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 565,
|
||
"tpl": "Event-based Hierarchical State Machine (HSM) that manages <l1>LimboState</l> instances and facilitates transitions between them. LimboHSM is a <l2>LimboState</l> in itself and can also serve as a child of another LimboHSM node.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 566,
|
||
"tpl": "<l1>LimboState</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"<l1>ANYSTATE</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-anystate\\\"><span class=\\\"std std-ref\\\">ANYSTATE</span></a>\"}": {
|
||
"uid": 567,
|
||
"tpl": "<l1>ANYSTATE</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-property-anystate\"><span class=\"std std-ref\">ANYSTATE</span></a>"
|
||
}
|
||
},
|
||
"<l1>initial_state</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-initial-state\\\"><span class=\\\"std std-ref\\\">initial_state</span></a>\"}": {
|
||
"uid": 568,
|
||
"tpl": "<l1>initial_state</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-property-initial-state\"><span class=\"std std-ref\">initial_state</span></a>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 569,
|
||
"tpl": "<l1>UpdateMode</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"<l1>update_mode</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-update-mode\\\"><span class=\\\"std std-ref\\\">update_mode</span></a>\"}": {
|
||
"uid": 570,
|
||
"tpl": "<l1>update_mode</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-property-update-mode\"><span class=\"std std-ref\">update_mode</span></a>"
|
||
}
|
||
},
|
||
"<l1>add_transition</l>(from_state: <l2>LimboState</l>, to_state: <l3>LimboState</l>, event: <4/>, guard: <5/> = Callable())\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-add-transition\\\"><span class=\\\"std std-ref\\\">add_transition</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\"}": {
|
||
"uid": 571,
|
||
"tpl": "<l1>add_transition</l>(from_state: <l2>LimboState</l>, to_state: <l3>LimboState</l>, event: <4/>, guard: <5/> = Callable())",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-add-transition\"><span class=\"std std-ref\">add_transition</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>change_active_state</l>(state: <l2>LimboState</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-change-active-state\\\"><span class=\\\"std std-ref\\\">change_active_state</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 572,
|
||
"tpl": "<l1>change_active_state</l>(state: <l2>LimboState</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-change-active-state\"><span class=\"std std-ref\">change_active_state</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_active_state</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-get-active-state\\\"><span class=\\\"std std-ref\\\">get_active_state</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 573,
|
||
"tpl": "<l1>get_active_state</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-get-active-state\"><span class=\"std std-ref\">get_active_state</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_leaf_state</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-get-leaf-state\\\"><span class=\\\"std std-ref\\\">get_leaf_state</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 574,
|
||
"tpl": "<l1>get_leaf_state</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-get-leaf-state\"><span class=\"std std-ref\">get_leaf_state</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_previous_active_state</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-get-previous-active-state\\\"><span class=\\\"std std-ref\\\">get_previous_active_state</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 575,
|
||
"tpl": "<l1>get_previous_active_state</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-get-previous-active-state\"><span class=\"std std-ref\">get_previous_active_state</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>has_transition</l>(from_state: <l2>LimboState</l>, event: <3/>) <4/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-has-transition\\\"><span class=\\\"std std-ref\\\">has_transition</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"4\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 576,
|
||
"tpl": "<l1>has_transition</l>(from_state: <l2>LimboState</l>, event: <3/>) <4/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-has-transition\"><span class=\"std std-ref\">has_transition</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"4": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>initialize</l>(agent: <2/>, parent_scope: <l3>Blackboard</l> = null)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-initialize\\\"><span class=\\\"std std-ref\\\">initialize</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 577,
|
||
"tpl": "<l1>initialize</l>(agent: <2/>, parent_scope: <l3>Blackboard</l> = null)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-initialize\"><span class=\"std std-ref\">initialize</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>remove_transition</l>(from_state: <l2>LimboState</l>, event: <3/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-remove-transition\\\"><span class=\\\"std std-ref\\\">remove_transition</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 578,
|
||
"tpl": "<l1>remove_transition</l>(from_state: <l2>LimboState</l>, event: <3/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-remove-transition\"><span class=\"std std-ref\">remove_transition</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<l1>set_active</l>(active: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-set-active\\\"><span class=\\\"std std-ref\\\">set_active</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 579,
|
||
"tpl": "<l1>set_active</l>(active: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-set-active\"><span class=\"std std-ref\">set_active</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<l1>update</l>(delta: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-update\\\"><span class=\\\"std std-ref\\\">update</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 580,
|
||
"tpl": "<l1>update</l>(delta: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-update\"><span class=\"std std-ref\">update</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<b>active_state_changed</b>(current: <l1>LimboState</l>, previous: <l2>LimboState</l>) <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-signal-active-state-changed\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 581,
|
||
"tpl": "<b>active_state_changed</b>(current: <l1>LimboState</l>, previous: <l2>LimboState</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-signal-active-state-changed\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the currently active substate is switched to a different substate.\u0000{}": {
|
||
"uid": 582,
|
||
"tpl": "Emitted when the currently active substate is switched to a different substate.",
|
||
"markers": {}
|
||
},
|
||
"enum <b>UpdateMode</b>: <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 583,
|
||
"tpl": "enum <b>UpdateMode</b>: <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l> <b>IDLE</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\"}": {
|
||
"uid": 584,
|
||
"tpl": "<l1>UpdateMode</l> <b>IDLE</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>"
|
||
}
|
||
},
|
||
"Update the state machine during the idle process.\u0000{}": {
|
||
"uid": 585,
|
||
"tpl": "Update the state machine during the idle process.",
|
||
"markers": {}
|
||
},
|
||
"<l1>UpdateMode</l> <b>PHYSICS</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\"}": {
|
||
"uid": 586,
|
||
"tpl": "<l1>UpdateMode</l> <b>PHYSICS</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>"
|
||
}
|
||
},
|
||
"Update the state machine during the physics process.\u0000{}": {
|
||
"uid": 587,
|
||
"tpl": "Update the state machine during the physics process.",
|
||
"markers": {}
|
||
},
|
||
"<l1>UpdateMode</l> <b>MANUAL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">2</span></code>\"}": {
|
||
"uid": 588,
|
||
"tpl": "<l1>UpdateMode</l> <b>MANUAL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">2</span></code>"
|
||
}
|
||
},
|
||
"Manually update the state machine by calling <l1>update</l> from a script.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-update\\\"><span class=\\\"std std-ref\\\">update</span></a>\"}": {
|
||
"uid": 589,
|
||
"tpl": "Manually update the state machine by calling <l1>update</l> from a script.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-update\"><span class=\"std std-ref\">update</span></a>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>ANYSTATE</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-anystate\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 590,
|
||
"tpl": "<l1>LimboState</l> <b>ANYSTATE</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbohsm-property-anystate\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>anystate</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 591,
|
||
"tpl": "<l1>LimboState</l> <b>anystate</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"Useful for defining a transition from any state.\u0000{}": {
|
||
"uid": 592,
|
||
"tpl": "Useful for defining a transition from any state.",
|
||
"markers": {}
|
||
},
|
||
"<l1>LimboState</l> <b>initial_state</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-initial-state\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 593,
|
||
"tpl": "<l1>LimboState</l> <b>initial_state</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbohsm-property-initial-state\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_initial_state</b>(value: <l2>LimboState</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 594,
|
||
"tpl": "<1/> <b>set_initial_state</b>(value: <l2>LimboState</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>get_initial_state</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\"}": {
|
||
"uid": 595,
|
||
"tpl": "<l1>LimboState</l> <b>get_initial_state</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>"
|
||
}
|
||
},
|
||
"The substate that becomes active when the state machine is activated using the <l1>set_active</l> method. If not explicitly set, the first child of the LimboHSM will be considered the initial state.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-set-active\\\"><span class=\\\"std std-ref\\\">set_active</span></a>\"}": {
|
||
"uid": 596,
|
||
"tpl": "The substate that becomes active when the state machine is activated using the <l1>set_active</l> method. If not explicitly set, the first child of the LimboHSM will be considered the initial state.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limbohsm-method-set-active\"><span class=\"std std-ref\">set_active</span></a>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l> <b>update_mode</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-update-mode\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 597,
|
||
"tpl": "<l1>UpdateMode</l> <b>update_mode</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-property-update-mode\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_update_mode</b>(value: <l2>UpdateMode</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 598,
|
||
"tpl": "<1/> <b>set_update_mode</b>(value: <l2>UpdateMode</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"<l1>UpdateMode</l> <b>get_update_mode</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 599,
|
||
"tpl": "<l1>UpdateMode</l> <b>get_update_mode</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"Specifies when the state machine should be updated. See <l1>UpdateMode</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limbohsm-updatemode\\\"><span class=\\\"std std-ref\\\">UpdateMode</span></a>\"}": {
|
||
"uid": 600,
|
||
"tpl": "Specifies when the state machine should be updated. See <l1>UpdateMode</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limbohsm-updatemode\"><span class=\"std std-ref\">UpdateMode</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>add_transition</b>(from_state: <l2>LimboState</l>, to_state: <l3>LimboState</l>, event: <4/>, guard: <5/> = Callable()) <l6>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-add-transition\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 601,
|
||
"tpl": "<1/> <b>add_transition</b>(from_state: <l2>LimboState</l>, to_state: <l3>LimboState</l>, event: <4/>, guard: <5/> = Callable()) <l6>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-limbohsm-method-add-transition\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Establishes a transition from one state to another when <1/> is dispatched. Both <2/> and <3/> must be immediate children of this <b>LimboHSM</b>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">event</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">from_state</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">to_state</span></code>\"}": {
|
||
"uid": 602,
|
||
"tpl": "Establishes a transition from one state to another when <1/> is dispatched. Both <2/> and <3/> must be immediate children of this <b>LimboHSM</b>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">event</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">from_state</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">to_state</span></code>"
|
||
}
|
||
},
|
||
"Optionally, a <1/> function can be specified, which must return a boolean value. If the guard function returns <2/>, the transition will not occur. The guard function is called immediately before the transition is considered. For a state-wide guard function, check out <l3>LimboState.set_guard</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">guard</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-method-set-guard\\\"><span class=\\\"std std-ref\\\">LimboState.set_guard</span></a>\"}": {
|
||
"uid": 603,
|
||
"tpl": "Optionally, a <1/> function can be specified, which must return a boolean value. If the guard function returns <2/>, the transition will not occur. The guard function is called immediately before the transition is considered. For a state-wide guard function, check out <l3>LimboState.set_guard</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">guard</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-method-set-guard\"><span class=\"std std-ref\">LimboState.set_guard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>change_active_state</b>(state: <l2>LimboState</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-change-active-state\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 604,
|
||
"tpl": "<1/> <b>change_active_state</b>(state: <l2>LimboState</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-method-change-active-state\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Changes the currently active substate to <1/>. If <2/> is already active, it will be exited and reentered.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">state</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">state</span></code>\"}": {
|
||
"uid": 605,
|
||
"tpl": "Changes the currently active substate to <1/>. If <2/> is already active, it will be exited and reentered.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">state</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">state</span></code>"
|
||
}
|
||
},
|
||
"<1/> must be a child of this <b>LimboHSM</b>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">state</span></code>\"}": {
|
||
"uid": 606,
|
||
"tpl": "<1/> must be a child of this <b>LimboHSM</b>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">state</span></code>"
|
||
}
|
||
},
|
||
"<l1>LimboState</l> <b>get_active_state</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-get-active-state\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 607,
|
||
"tpl": "<l1>LimboState</l> <b>get_active_state</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-method-get-active-state\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the currently active substate.\u0000{}": {
|
||
"uid": 608,
|
||
"tpl": "Returns the currently active substate.",
|
||
"markers": {}
|
||
},
|
||
"<l1>LimboState</l> <b>get_leaf_state</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-get-leaf-state\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 609,
|
||
"tpl": "<l1>LimboState</l> <b>get_leaf_state</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-method-get-leaf-state\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the currently active leaf state within the state machine.\u0000{}": {
|
||
"uid": 610,
|
||
"tpl": "Returns the currently active leaf state within the state machine.",
|
||
"markers": {}
|
||
},
|
||
"<l1>LimboState</l> <b>get_previous_active_state</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-get-previous-active-state\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 611,
|
||
"tpl": "<l1>LimboState</l> <b>get_previous_active_state</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-method-get-previous-active-state\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the previously active substate.\u0000{}": {
|
||
"uid": 612,
|
||
"tpl": "Returns the previously active substate.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>has_transition</b>(from_state: <l2>LimboState</l>, event: <3/>) <4/> <l5>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"4\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-has-transition\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 613,
|
||
"tpl": "<1/> <b>has_transition</b>(from_state: <l2>LimboState</l>, event: <3/>) <4/> <l5>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"4": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-limbohsm-method-has-transition\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if there is a transition from <2/> for a given <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">from_state</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">event</span></code>\"}": {
|
||
"uid": 614,
|
||
"tpl": "Returns <1/> if there is a transition from <2/> for a given <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">from_state</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">event</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>initialize</b>(agent: <2/>, parent_scope: <l3>Blackboard</l> = null) <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-initialize\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 615,
|
||
"tpl": "<1/> <b>initialize</b>(agent: <2/>, parent_scope: <l3>Blackboard</l> = null) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limbohsm-method-initialize\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Initiates the state and calls <l1>LimboState._setup</l> for both itself and all substates.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-private-method-setup\\\"><span class=\\\"std std-ref\\\">LimboState._setup</span></a>\"}": {
|
||
"uid": 616,
|
||
"tpl": "Initiates the state and calls <l1>LimboState._setup</l> for both itself and all substates.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-private-method-setup\"><span class=\"std std-ref\">LimboState._setup</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>remove_transition</b>(from_state: <l2>LimboState</l>, event: <3/>) <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-remove-transition\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 617,
|
||
"tpl": "<1/> <b>remove_transition</b>(from_state: <l2>LimboState</l>, event: <3/>) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limbohsm-method-remove-transition\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Removes a transition from a state associated with specific <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">event</span></code>\"}": {
|
||
"uid": 618,
|
||
"tpl": "Removes a transition from a state associated with specific <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">event</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>set_active</b>(active: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-set-active\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 619,
|
||
"tpl": "<1/> <b>set_active</b>(active: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-method-set-active\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"When set to <1/>, switches the state to <l2>initial_state</l> and activates state processing according to <l3>update_mode</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-initial-state\\\"><span class=\\\"std std-ref\\\">initial_state</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-update-mode\\\"><span class=\\\"std std-ref\\\">update_mode</span></a>\"}": {
|
||
"uid": 620,
|
||
"tpl": "When set to <1/>, switches the state to <l2>initial_state</l> and activates state processing according to <l3>update_mode</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbohsm-property-initial-state\"><span class=\"std std-ref\">initial_state</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-property-update-mode\"><span class=\"std std-ref\">update_mode</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>update</b>(delta: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-method-update\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 621,
|
||
"tpl": "<1/> <b>update</b>(delta: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-method-update\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Calls <l1>LimboState._update</l> on itself and the active substate, with the call cascading down to the leaf state. This method is automatically triggered if <l2>update_mode</l> is not set to <l3>MANUAL</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-private-method-update\\\"><span class=\\\"std std-ref\\\">LimboState._update</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-property-update-mode\\\"><span class=\\\"std std-ref\\\">update_mode</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limbohsm-constant-manual\\\"><span class=\\\"std std-ref\\\">MANUAL</span></a>\"}": {
|
||
"uid": 622,
|
||
"tpl": "Calls <l1>LimboState._update</l> on itself and the active substate, with the call cascading down to the leaf state. This method is automatically triggered if <l2>update_mode</l> is not set to <l3>MANUAL</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-private-method-update\"><span class=\"std std-ref\">LimboState._update</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limbohsm-property-update-mode\"><span class=\"std std-ref\">update_mode</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-limbohsm-constant-manual\"><span class=\"std std-ref\">MANUAL</span></a>"
|
||
}
|
||
},
|
||
"BTState\u0000{}": {
|
||
"uid": 623,
|
||
"tpl": "BTState",
|
||
"markers": {}
|
||
},
|
||
"A state node for <l1>LimboHSM</l> that hosts a <l2>BehaviorTree</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbohsm#class-limbohsm\\\"><span class=\\\"std std-ref\\\">LimboHSM</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 624,
|
||
"tpl": "A state node for <l1>LimboHSM</l> that hosts a <l2>BehaviorTree</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbohsm#class-limbohsm\"><span class=\"std std-ref\">LimboHSM</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"BTState is a <l1>LimboState</l> node that manages a <l2>BehaviorTree</l> to provide behavior logic for the state. It instantiates and runs the <l3>BehaviorTree</l> resource, dispatching a state machine event upon <4/> or <5/>. Event names are customizable through <l6>success_event</l> and <l7>failure_event</l>. For further details on state machine events, see <l8>LimboState.dispatch</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate\\\"><span class=\\\"std std-ref\\\">LimboState</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-success-event\\\"><span class=\\\"std std-ref\\\">success_event</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-failure-event\\\"><span class=\\\"std std-ref\\\">failure_event</span></a>\", \"8\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-method-dispatch\\\"><span class=\\\"std std-ref\\\">LimboState.dispatch</span></a>\"}": {
|
||
"uid": 625,
|
||
"tpl": "BTState is a <l1>LimboState</l> node that manages a <l2>BehaviorTree</l> to provide behavior logic for the state. It instantiates and runs the <l3>BehaviorTree</l> resource, dispatching a state machine event upon <4/> or <5/>. Event names are customizable through <l6>success_event</l> and <l7>failure_event</l>. For further details on state machine events, see <l8>LimboState.dispatch</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate\"><span class=\"std std-ref\">LimboState</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-btstate-property-success-event\"><span class=\"std std-ref\">success_event</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#class-btstate-property-failure-event\"><span class=\"std std-ref\">failure_event</span></a>",
|
||
"8": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-method-dispatch\"><span class=\"std std-ref\">LimboState.dispatch</span></a>"
|
||
}
|
||
},
|
||
"<l1>behavior_tree</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-behavior-tree\\\"><span class=\\\"std std-ref\\\">behavior_tree</span></a>\"}": {
|
||
"uid": 626,
|
||
"tpl": "<l1>behavior_tree</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstate-property-behavior-tree\"><span class=\"std std-ref\">behavior_tree</span></a>"
|
||
}
|
||
},
|
||
"<l1>failure_event</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-failure-event\\\"><span class=\\\"std std-ref\\\">failure_event</span></a>\"}": {
|
||
"uid": 627,
|
||
"tpl": "<l1>failure_event</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstate-property-failure-event\"><span class=\"std std-ref\">failure_event</span></a>"
|
||
}
|
||
},
|
||
"<l1>monitor_performance</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-monitor-performance\\\"><span class=\\\"std std-ref\\\">monitor_performance</span></a>\"}": {
|
||
"uid": 628,
|
||
"tpl": "<l1>monitor_performance</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstate-property-monitor-performance\"><span class=\"std std-ref\">monitor_performance</span></a>"
|
||
}
|
||
},
|
||
"<l1>success_event</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-success-event\\\"><span class=\\\"std std-ref\\\">success_event</span></a>\"}": {
|
||
"uid": 629,
|
||
"tpl": "<l1>success_event</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstate-property-success-event\"><span class=\"std std-ref\">success_event</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_bt_instance</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-method-get-bt-instance\\\"><span class=\\\"std std-ref\\\">get_bt_instance</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 630,
|
||
"tpl": "<l1>get_bt_instance</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstate-method-get-bt-instance\"><span class=\"std std-ref\">get_bt_instance</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>set_scene_root_hint</l>(scene_root: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-method-set-scene-root-hint\\\"><span class=\\\"std std-ref\\\">set_scene_root_hint</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 631,
|
||
"tpl": "<l1>set_scene_root_hint</l>(scene_root: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstate-method-set-scene-root-hint\"><span class=\"std std-ref\">set_scene_root_hint</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l> <b>behavior_tree</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-behavior-tree\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 632,
|
||
"tpl": "<l1>BehaviorTree</l> <b>behavior_tree</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btstate-property-behavior-tree\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A <l1>BehaviorTree</l> resource that defines state behavior.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 633,
|
||
"tpl": "A <l1>BehaviorTree</l> resource that defines state behavior.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>failure_event</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"failure\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-failure-event\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 634,
|
||
"tpl": "<1/> <b>failure_event</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"failure\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstate-property-failure-event\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_failure_event</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 635,
|
||
"tpl": "<1/> <b>set_failure_event</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_failure_event</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 636,
|
||
"tpl": "<1/> <b>get_failure_event</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"HSM event that will be dispatched when the behavior tree results in <1/>. See <l2>LimboState.dispatch</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-method-dispatch\\\"><span class=\\\"std std-ref\\\">LimboState.dispatch</span></a>\"}": {
|
||
"uid": 637,
|
||
"tpl": "HSM event that will be dispatched when the behavior tree results in <1/>. See <l2>LimboState.dispatch</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-method-dispatch\"><span class=\"std std-ref\">LimboState.dispatch</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>monitor_performance</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-monitor-performance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 638,
|
||
"tpl": "<1/> <b>monitor_performance</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstate-property-monitor-performance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"If <1/>, adds a performance monitor to “Debugger->Monitors” for each instance of this <b>BTState</b> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 639,
|
||
"tpl": "If <1/>, adds a performance monitor to “Debugger->Monitors” for each instance of this <b>BTState</b> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>success_event</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"success\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-property-success-event\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 640,
|
||
"tpl": "<1/> <b>success_event</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"success\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstate-property-success-event\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_success_event</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 641,
|
||
"tpl": "<1/> <b>set_success_event</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_success_event</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 642,
|
||
"tpl": "<1/> <b>get_success_event</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"HSM event that will be dispatched when the behavior tree results in <1/>. See <l2>LimboState.dispatch</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limbostate#class-limbostate-method-dispatch\\\"><span class=\\\"std std-ref\\\">LimboState.dispatch</span></a>\"}": {
|
||
"uid": 643,
|
||
"tpl": "HSM event that will be dispatched when the behavior tree results in <1/>. See <l2>LimboState.dispatch</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limbostate#class-limbostate-method-dispatch\"><span class=\"std std-ref\">LimboState.dispatch</span></a>"
|
||
}
|
||
},
|
||
"<l1>BTInstance</l> <b>get_bt_instance</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-method-get-bt-instance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 644,
|
||
"tpl": "<l1>BTInstance</l> <b>get_bt_instance</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstate-method-get-bt-instance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_scene_root_hint</b>(scene_root: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstate-method-set-scene-root-hint\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 645,
|
||
"tpl": "<1/> <b>set_scene_root_hint</b>(scene_root: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstate-method-set-scene-root-hint\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the <1/> that will be used as the scene root for the newly instantiated behavior tree. Should be called before the state machine is initialized. This is typically useful when creating <b>BTState</b> nodes dynamically from code.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 646,
|
||
"tpl": "Sets the <1/> that will be used as the scene root for the newly instantiated behavior tree. Should be called before the state machine is initialized. This is typically useful when creating <b>BTState</b> nodes dynamically from code.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"Full class reference is available in the side bar.\u0000{}": {
|
||
"uid": 647,
|
||
"tpl": "Full class reference is available in the side bar.",
|
||
"markers": {}
|
||
},
|
||
"BBAabb\u0000{}": {
|
||
"uid": 648,
|
||
"tpl": "BBAabb",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BBParam</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 649,
|
||
"tpl": "<b>Inherits:</b> <l1>BBParam</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"AABB-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 650,
|
||
"tpl": "AABB-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBArray\u0000{}": {
|
||
"uid": 651,
|
||
"tpl": "BBArray",
|
||
"markers": {}
|
||
},
|
||
"Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 652,
|
||
"tpl": "Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBBasis\u0000{}": {
|
||
"uid": 653,
|
||
"tpl": "BBBasis",
|
||
"markers": {}
|
||
},
|
||
"Basis-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 654,
|
||
"tpl": "Basis-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBBool\u0000{}": {
|
||
"uid": 655,
|
||
"tpl": "BBBool",
|
||
"markers": {}
|
||
},
|
||
"Bool-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 656,
|
||
"tpl": "Bool-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBByteArray\u0000{}": {
|
||
"uid": 657,
|
||
"tpl": "BBByteArray",
|
||
"markers": {}
|
||
},
|
||
"ByteArray-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 658,
|
||
"tpl": "ByteArray-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBColor\u0000{}": {
|
||
"uid": 659,
|
||
"tpl": "BBColor",
|
||
"markers": {}
|
||
},
|
||
"Color-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 660,
|
||
"tpl": "Color-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBColorArray\u0000{}": {
|
||
"uid": 661,
|
||
"tpl": "BBColorArray",
|
||
"markers": {}
|
||
},
|
||
"ColorArray-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 662,
|
||
"tpl": "ColorArray-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBDictionary\u0000{}": {
|
||
"uid": 663,
|
||
"tpl": "BBDictionary",
|
||
"markers": {}
|
||
},
|
||
"Dictionary-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 664,
|
||
"tpl": "Dictionary-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBFloat\u0000{}": {
|
||
"uid": 665,
|
||
"tpl": "BBFloat",
|
||
"markers": {}
|
||
},
|
||
"Float-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 666,
|
||
"tpl": "Float-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBFloat32Array\u0000{}": {
|
||
"uid": 667,
|
||
"tpl": "BBFloat32Array",
|
||
"markers": {}
|
||
},
|
||
"PackedFloat32Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 668,
|
||
"tpl": "PackedFloat32Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBFloat64Array\u0000{}": {
|
||
"uid": 669,
|
||
"tpl": "BBFloat64Array",
|
||
"markers": {}
|
||
},
|
||
"PackedFloat64Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 670,
|
||
"tpl": "PackedFloat64Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBInt\u0000{}": {
|
||
"uid": 671,
|
||
"tpl": "BBInt",
|
||
"markers": {}
|
||
},
|
||
"Integer-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 672,
|
||
"tpl": "Integer-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBInt32Array\u0000{}": {
|
||
"uid": 673,
|
||
"tpl": "BBInt32Array",
|
||
"markers": {}
|
||
},
|
||
"PackedInt32Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 674,
|
||
"tpl": "PackedInt32Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBInt64Array\u0000{}": {
|
||
"uid": 675,
|
||
"tpl": "BBInt64Array",
|
||
"markers": {}
|
||
},
|
||
"PackedInt64Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 676,
|
||
"tpl": "PackedInt64Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBNode\u0000{}": {
|
||
"uid": 677,
|
||
"tpl": "BBNode",
|
||
"markers": {}
|
||
},
|
||
"Node-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 678,
|
||
"tpl": "Node-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"Node-type parameter intended for use with <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 679,
|
||
"tpl": "Node-type parameter intended for use with <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"If the source is a blackboard variable, it allows any type extended from <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\"}": {
|
||
"uid": 680,
|
||
"tpl": "If the source is a blackboard variable, it allows any type extended from <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>"
|
||
}
|
||
},
|
||
"BBPlane\u0000{}": {
|
||
"uid": 681,
|
||
"tpl": "BBPlane",
|
||
"markers": {}
|
||
},
|
||
"Plane-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 682,
|
||
"tpl": "Plane-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBProjection\u0000{}": {
|
||
"uid": 683,
|
||
"tpl": "BBProjection",
|
||
"markers": {}
|
||
},
|
||
"Projection-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 684,
|
||
"tpl": "Projection-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBQuaternion\u0000{}": {
|
||
"uid": 685,
|
||
"tpl": "BBQuaternion",
|
||
"markers": {}
|
||
},
|
||
"Quaternion-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 686,
|
||
"tpl": "Quaternion-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBRect2\u0000{}": {
|
||
"uid": 687,
|
||
"tpl": "BBRect2",
|
||
"markers": {}
|
||
},
|
||
"Rect2-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 688,
|
||
"tpl": "Rect2-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBRect2i\u0000{}": {
|
||
"uid": 689,
|
||
"tpl": "BBRect2i",
|
||
"markers": {}
|
||
},
|
||
"Rect2i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 690,
|
||
"tpl": "Rect2i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBString\u0000{}": {
|
||
"uid": 691,
|
||
"tpl": "BBString",
|
||
"markers": {}
|
||
},
|
||
"String-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 692,
|
||
"tpl": "String-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBStringArray\u0000{}": {
|
||
"uid": 693,
|
||
"tpl": "BBStringArray",
|
||
"markers": {}
|
||
},
|
||
"StringArray-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 694,
|
||
"tpl": "StringArray-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBStringName\u0000{}": {
|
||
"uid": 695,
|
||
"tpl": "BBStringName",
|
||
"markers": {}
|
||
},
|
||
"StringName-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 696,
|
||
"tpl": "StringName-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBTransform2D\u0000{}": {
|
||
"uid": 697,
|
||
"tpl": "BBTransform2D",
|
||
"markers": {}
|
||
},
|
||
"Transform2D-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 698,
|
||
"tpl": "Transform2D-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBTransform3D\u0000{}": {
|
||
"uid": 699,
|
||
"tpl": "BBTransform3D",
|
||
"markers": {}
|
||
},
|
||
"Transform3D-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 700,
|
||
"tpl": "Transform3D-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVariant\u0000{}": {
|
||
"uid": 701,
|
||
"tpl": "BBVariant",
|
||
"markers": {}
|
||
},
|
||
"Variant-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 702,
|
||
"tpl": "Variant-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"Variant-type parameter intended for use with <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 703,
|
||
"tpl": "Variant-type parameter intended for use with <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"The data type is specified by <l1>type</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbvariant-property-type\\\"><span class=\\\"std std-ref\\\">type</span></a>\"}": {
|
||
"uid": 704,
|
||
"tpl": "The data type is specified by <l1>type</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbvariant-property-type\"><span class=\"std std-ref\">type</span></a>"
|
||
}
|
||
},
|
||
"<l1>type</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbvariant-property-type\\\"><span class=\\\"std std-ref\\\">type</span></a>\"}": {
|
||
"uid": 705,
|
||
"tpl": "<l1>type</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bbvariant-property-type\"><span class=\"std std-ref\">type</span></a>"
|
||
}
|
||
},
|
||
"Variant.Type <b>type</b> = <1/> <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bbvariant-property-type\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 706,
|
||
"tpl": "Variant.Type <b>type</b> = <1/> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bbvariant-property-type\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_type</b>(value: Variant.Type)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\"}": {
|
||
"uid": 707,
|
||
"tpl": "<1/> <b>set_type</b>(value: Variant.Type)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>"
|
||
}
|
||
},
|
||
"Variant.Type <b>get_type</b>()\u0000{}": {
|
||
"uid": 708,
|
||
"tpl": "Variant.Type <b>get_type</b>()",
|
||
"markers": {}
|
||
},
|
||
"Specified Variant.Type for the parameter value.\u0000{}": {
|
||
"uid": 709,
|
||
"tpl": "Specified Variant.Type for the parameter value.",
|
||
"markers": {}
|
||
},
|
||
"BBVector2\u0000{}": {
|
||
"uid": 710,
|
||
"tpl": "BBVector2",
|
||
"markers": {}
|
||
},
|
||
"Vector2-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 711,
|
||
"tpl": "Vector2-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVector2Array\u0000{}": {
|
||
"uid": 712,
|
||
"tpl": "BBVector2Array",
|
||
"markers": {}
|
||
},
|
||
"Vector2Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 713,
|
||
"tpl": "Vector2Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVector2i\u0000{}": {
|
||
"uid": 714,
|
||
"tpl": "BBVector2i",
|
||
"markers": {}
|
||
},
|
||
"Vector2i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 715,
|
||
"tpl": "Vector2i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVector3\u0000{}": {
|
||
"uid": 716,
|
||
"tpl": "BBVector3",
|
||
"markers": {}
|
||
},
|
||
"Vector3-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 717,
|
||
"tpl": "Vector3-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVector3Array\u0000{}": {
|
||
"uid": 718,
|
||
"tpl": "BBVector3Array",
|
||
"markers": {}
|
||
},
|
||
"Vector3Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 719,
|
||
"tpl": "Vector3Array-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVector3i\u0000{}": {
|
||
"uid": 720,
|
||
"tpl": "BBVector3i",
|
||
"markers": {}
|
||
},
|
||
"Vector3i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 721,
|
||
"tpl": "Vector3i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVector4\u0000{}": {
|
||
"uid": 722,
|
||
"tpl": "BBVector4",
|
||
"markers": {}
|
||
},
|
||
"Vector4-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 723,
|
||
"tpl": "Vector4-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BBVector4i\u0000{}": {
|
||
"uid": 724,
|
||
"tpl": "BBVector4i",
|
||
"markers": {}
|
||
},
|
||
"Vector4i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbparam#class-bbparam\\\"><span class=\\\"std std-ref\\\">BBParam</span></a>\"}": {
|
||
"uid": 725,
|
||
"tpl": "Vector4i-type parameter for <l1>BehaviorTree</l> tasks. See <l2>BBParam</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbparam#class-bbparam\"><span class=\"std std-ref\">BBParam</span></a>"
|
||
}
|
||
},
|
||
"BehaviorTree\u0000{}": {
|
||
"uid": 726,
|
||
"tpl": "BehaviorTree",
|
||
"markers": {}
|
||
},
|
||
"Contains Behavior Tree data.\u0000{}": {
|
||
"uid": 727,
|
||
"tpl": "Contains Behavior Tree data.",
|
||
"markers": {}
|
||
},
|
||
"Behavior Trees are hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies, entities). They are designed to make it easier to create complex and highly modular behaviors for your games.\u0000{}": {
|
||
"uid": 728,
|
||
"tpl": "Behavior Trees are hierarchical structures used to model and control the behavior of agents in a game (e.g., characters, enemies, entities). They are designed to make it easier to create complex and highly modular behaviors for your games.",
|
||
"markers": {}
|
||
},
|
||
"Behavior Trees are composed of tasks that represent specific actions or decision-making rules. Tasks can be broadly categorized into two main types: control tasks and leaf tasks. Control tasks determine the execution flow within the tree. They include <l1>BTSequence</l>, <l2>BTSelector</l>, and <l3>BTInvert</l>. Leaf tasks represent specific actions to perform, like moving or attacking, or conditions that need to be checked. The <l4>BTTask</l> class provides the foundation for various building blocks of the Behavior Trees. BT tasks can share data with the help of <l5>Blackboard</l>. See <l6>BTTask.blackboard</l> and <l7>Blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">BTSelector</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinvert#class-btinvert\\\"><span class=\\\"std std-ref\\\">BTInvert</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask-property-blackboard\\\"><span class=\\\"std std-ref\\\">BTTask.blackboard</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 729,
|
||
"tpl": "Behavior Trees are composed of tasks that represent specific actions or decision-making rules. Tasks can be broadly categorized into two main types: control tasks and leaf tasks. Control tasks determine the execution flow within the tree. They include <l1>BTSequence</l>, <l2>BTSelector</l>, and <l3>BTInvert</l>. Leaf tasks represent specific actions to perform, like moving or attacking, or conditions that need to be checked. The <l4>BTTask</l> class provides the foundation for various building blocks of the Behavior Trees. BT tasks can share data with the help of <l5>Blackboard</l>. See <l6>BTTask.blackboard</l> and <l7>Blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">BTSelector</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btinvert#class-btinvert\"><span class=\"std std-ref\">BTInvert</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask-property-blackboard\"><span class=\"std std-ref\">BTTask.blackboard</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<b>Note:</b> To create your own actions, extend the <l1>BTAction</l> class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btaction#class-btaction\\\"><span class=\\\"std std-ref\\\">BTAction</span></a>\"}": {
|
||
"uid": 730,
|
||
"tpl": "<b>Note:</b> To create your own actions, extend the <l1>BTAction</l> class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btaction#class-btaction\"><span class=\"std std-ref\">BTAction</span></a>"
|
||
}
|
||
},
|
||
"The BehaviorTree is executed from the root task and follows the rules specified by the control tasks, all the way down to the leaf tasks, which represent the actual actions that the agent should perform or conditions that should be checked. Each task returns a status when it is executed. It can be <1/>, <2/>, or <3/>. These statuses determine how the tree progresses. They are defined in <l4>Status</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\"}": {
|
||
"uid": 731,
|
||
"tpl": "The BehaviorTree is executed from the root task and follows the rules specified by the control tasks, all the way down to the leaf tasks, which represent the actual actions that the agent should perform or conditions that should be checked. Each task returns a status when it is executed. It can be <1/>, <2/>, or <3/>. These statuses determine how the tree progresses. They are defined in <l4>Status</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>"
|
||
}
|
||
},
|
||
"Behavior Trees handle conditional logic using condition tasks. These tasks check for specific conditions and return either <1/> or <2/> based on the state of the agent or its environment (e.g., “IsLowOnHealth”, “IsTargetInSight”). Conditions can be used together with <l3>BTSequence</l> and <l4>BTSelector</l> to craft your decision-making logic.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">BTSelector</span></a>\"}": {
|
||
"uid": 732,
|
||
"tpl": "Behavior Trees handle conditional logic using condition tasks. These tasks check for specific conditions and return either <1/> or <2/> based on the state of the agent or its environment (e.g., “IsLowOnHealth”, “IsTargetInSight”). Conditions can be used together with <l3>BTSequence</l> and <l4>BTSelector</l> to craft your decision-making logic.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">BTSelector</span></a>"
|
||
}
|
||
},
|
||
"<b>Note</b>: To create your own conditions, extend the <l1>BTCondition</l> class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcondition#class-btcondition\\\"><span class=\\\"std std-ref\\\">BTCondition</span></a>\"}": {
|
||
"uid": 733,
|
||
"tpl": "<b>Note</b>: To create your own conditions, extend the <l1>BTCondition</l> class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btcondition#class-btcondition\"><span class=\"std std-ref\">BTCondition</span></a>"
|
||
}
|
||
},
|
||
"Check out the <l1>BTTask</l> class, which provides the foundation for various building blocks of Behavior Trees.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 734,
|
||
"tpl": "Check out the <l1>BTTask</l> class, which provides the foundation for various building blocks of Behavior Trees.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<l1>blackboard_plan</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">blackboard_plan</span></a>\"}": {
|
||
"uid": 735,
|
||
"tpl": "<l1>blackboard_plan</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-property-blackboard-plan\"><span class=\"std std-ref\">blackboard_plan</span></a>"
|
||
}
|
||
},
|
||
"<l1>description</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-property-description\\\"><span class=\\\"std std-ref\\\">description</span></a>\"}": {
|
||
"uid": 736,
|
||
"tpl": "<l1>description</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-property-description\"><span class=\"std std-ref\">description</span></a>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 737,
|
||
"tpl": "<l1>BehaviorTree</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>clone</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-clone\\\"><span class=\\\"std std-ref\\\">clone</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 738,
|
||
"tpl": "<l1>clone</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-method-clone\"><span class=\"std std-ref\">clone</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>copy_other</l>(other: <l2>BehaviorTree</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-copy-other\\\"><span class=\\\"std std-ref\\\">copy_other</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 739,
|
||
"tpl": "<l1>copy_other</l>(other: <l2>BehaviorTree</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-method-copy-other\"><span class=\"std std-ref\">copy_other</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>BTTask</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 740,
|
||
"tpl": "<l1>BTTask</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_root_task</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-get-root-task\\\"><span class=\\\"std std-ref\\\">get_root_task</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 741,
|
||
"tpl": "<l1>get_root_task</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-method-get-root-task\"><span class=\"std std-ref\">get_root_task</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>instantiate</l>(agent: <2/>, blackboard: <l3>Blackboard</l>, instance_owner: <4/>, custom_scene_root: <5/> = null) <6/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-instantiate\\\"><span class=\\\"std std-ref\\\">instantiate</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"6\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 742,
|
||
"tpl": "<l1>instantiate</l>(agent: <2/>, blackboard: <l3>Blackboard</l>, instance_owner: <4/>, custom_scene_root: <5/> = null) <6/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-method-instantiate\"><span class=\"std std-ref\">instantiate</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"6": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>set_root_task</l>(task: <l2>BTTask</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-set-root-task\\\"><span class=\\\"std std-ref\\\">set_root_task</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 743,
|
||
"tpl": "<l1>set_root_task</l>(task: <l2>BTTask</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-method-set-root-task\"><span class=\"std std-ref\">set_root_task</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<b>plan_changed</b>() <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-signal-plan-changed\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 744,
|
||
"tpl": "<b>plan_changed</b>() <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree-signal-plan-changed\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the <l1>BlackboardPlan</l> changes.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 745,
|
||
"tpl": "Emitted when the <l1>BlackboardPlan</l> changes.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 746,
|
||
"tpl": "<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-behaviortree-property-blackboard-plan\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>description</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-property-description\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 747,
|
||
"tpl": "<1/> <b>description</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortree-property-description\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_description</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 748,
|
||
"tpl": "<1/> <b>set_description</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_description</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 749,
|
||
"tpl": "<1/> <b>get_description</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"User-provided description of the <b>BehaviorTree</b>.\u0000{}": {
|
||
"uid": 750,
|
||
"tpl": "User-provided description of the <b>BehaviorTree</b>.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BehaviorTree</l> <b>clone</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-clone\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 751,
|
||
"tpl": "<l1>BehaviorTree</l> <b>clone</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortree-method-clone\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Makes a copy of the BehaviorTree resource.\u0000{}": {
|
||
"uid": 752,
|
||
"tpl": "Makes a copy of the BehaviorTree resource.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>copy_other</b>(other: <l2>BehaviorTree</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-copy-other\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 753,
|
||
"tpl": "<1/> <b>copy_other</b>(other: <l2>BehaviorTree</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortree-method-copy-other\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Become a copy of another behavior tree.\u0000{}": {
|
||
"uid": 754,
|
||
"tpl": "Become a copy of another behavior tree.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BTTask</l> <b>get_root_task</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-get-root-task\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 755,
|
||
"tpl": "<l1>BTTask</l> <b>get_root_task</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortree-method-get-root-task\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the root task of the BehaviorTree resource.\u0000{}": {
|
||
"uid": 756,
|
||
"tpl": "Returns the root task of the BehaviorTree resource.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BTInstance</l> <b>instantiate</b>(agent: <2/>, blackboard: <l3>Blackboard</l>, instance_owner: <4/>, custom_scene_root: <5/> = null) <6/> <l7>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"6\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-instantiate\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 757,
|
||
"tpl": "<l1>BTInstance</l> <b>instantiate</b>(agent: <2/>, blackboard: <l3>Blackboard</l>, instance_owner: <4/>, custom_scene_root: <5/> = null) <6/> <l7>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"6": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"7": "<a class=\"reference internal\" href=\"#class-behaviortree-method-instantiate\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Instantiates the behavior tree and returns <l1>BTInstance</l>. <2/> should be the scene node that will own the behavior tree instance. This is typically a <l3>BTPlayer</l>, <l4>BTState</l>, or a custom player node that controls the behavior tree execution. Make sure to pass a <l5>Blackboard</l> with values populated from <l6>blackboard_plan</l>. See also <l7>BlackboardPlan.populate_blackboard</l> & <l8>BlackboardPlan.create_blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">instance_owner</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer\\\"><span class=\\\"std std-ref\\\">BTPlayer</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstate#class-btstate\\\"><span class=\\\"std std-ref\\\">BTState</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">blackboard_plan</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan-method-populate-blackboard\\\"><span class=\\\"std std-ref\\\">BlackboardPlan.populate_blackboard</span></a>\", \"8\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan-method-create-blackboard\\\"><span class=\\\"std std-ref\\\">BlackboardPlan.create_blackboard</span></a>\"}": {
|
||
"uid": 758,
|
||
"tpl": "Instantiates the behavior tree and returns <l1>BTInstance</l>. <2/> should be the scene node that will own the behavior tree instance. This is typically a <l3>BTPlayer</l>, <l4>BTState</l>, or a custom player node that controls the behavior tree execution. Make sure to pass a <l5>Blackboard</l> with values populated from <l6>blackboard_plan</l>. See also <l7>BlackboardPlan.populate_blackboard</l> & <l8>BlackboardPlan.create_blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">instance_owner</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer\"><span class=\"std std-ref\">BTPlayer</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btstate#class-btstate\"><span class=\"std std-ref\">BTState</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-behaviortree-property-blackboard-plan\"><span class=\"std std-ref\">blackboard_plan</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan-method-populate-blackboard\"><span class=\"std std-ref\">BlackboardPlan.populate_blackboard</span></a>",
|
||
"8": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan-method-create-blackboard\"><span class=\"std std-ref\">BlackboardPlan.create_blackboard</span></a>"
|
||
}
|
||
},
|
||
"If <1/> is not <2/>, it will be used as the scene root for the newly instantiated behavior tree; otherwise, the scene root will be set to <3/>. Scene root is essential for <l4>BBNode</l> instances to work properly.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">custom_scene_root</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">null</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">instance_owner.owner</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\"}": {
|
||
"uid": 759,
|
||
"tpl": "If <1/> is not <2/>, it will be used as the scene root for the newly instantiated behavior tree; otherwise, the scene root will be set to <3/>. Scene root is essential for <l4>BBNode</l> instances to work properly.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">custom_scene_root</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">null</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">instance_owner.owner</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_root_task</b>(task: <l2>BTTask</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortree-method-set-root-task\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 760,
|
||
"tpl": "<1/> <b>set_root_task</b>(task: <l2>BTTask</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortree-method-set-root-task\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Assigns a new root task to the <b>BehaviorTree</b> resource.\u0000{}": {
|
||
"uid": 761,
|
||
"tpl": "Assigns a new root task to the <b>BehaviorTree</b> resource.",
|
||
"markers": {}
|
||
},
|
||
"BehaviorTreeData\u0000{}": {
|
||
"uid": 762,
|
||
"tpl": "BehaviorTreeData",
|
||
"markers": {}
|
||
},
|
||
"Represents current state of a <l1>BehaviorTree</l> instance.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 763,
|
||
"tpl": "Represents current state of a <l1>BehaviorTree</l> instance.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"This class is used by the LimboAI debugger for the serialization and deserialization of <l1>BehaviorTree</l> instance data.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 764,
|
||
"tpl": "This class is used by the LimboAI debugger for the serialization and deserialization of <l1>BehaviorTree</l> instance data.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Additionally, it can be used with <l1>BehaviorTreeView</l> to visualize the current state of a <l2>BehaviorTree</l> instance. It is meant to be utilized in custom in-game tools.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortreeview#class-behaviortreeview\\\"><span class=\\\"std std-ref\\\">BehaviorTreeView</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 765,
|
||
"tpl": "Additionally, it can be used with <l1>BehaviorTreeView</l> to visualize the current state of a <l2>BehaviorTree</l> instance. It is meant to be utilized in custom in-game tools.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortreeview#class-behaviortreeview\"><span class=\"std std-ref\">BehaviorTreeView</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTreeData</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreedata\\\"><span class=\\\"std std-ref\\\">BehaviorTreeData</span></a>\"}": {
|
||
"uid": 766,
|
||
"tpl": "<l1>BehaviorTreeData</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortreedata\"><span class=\"std std-ref\">BehaviorTreeData</span></a>"
|
||
}
|
||
},
|
||
"<l1>create_from_bt_instance</l>(bt_instance: <l2>BTInstance</l>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreedata-method-create-from-bt-instance\\\"><span class=\\\"std std-ref\\\">create_from_bt_instance</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"3\": \"<abbr title=\\\"This method doesn't need an instance to be called, so it can be called directly using the class name.\\\">static</abbr>\"}": {
|
||
"uid": 767,
|
||
"tpl": "<l1>create_from_bt_instance</l>(bt_instance: <l2>BTInstance</l>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortreedata-method-create-from-bt-instance\"><span class=\"std std-ref\">create_from_bt_instance</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"3": "<abbr title=\"This method doesn't need an instance to be called, so it can be called directly using the class name.\">static</abbr>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTreeData</l> <b>create_from_bt_instance</b>(bt_instance: <l2>BTInstance</l>) <3/> <l4>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreedata\\\"><span class=\\\"std std-ref\\\">BehaviorTreeData</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinstance#class-btinstance\\\"><span class=\\\"std std-ref\\\">BTInstance</span></a>\", \"3\": \"<abbr title=\\\"This method doesn't need an instance to be called, so it can be called directly using the class name.\\\">static</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreedata-method-create-from-bt-instance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 768,
|
||
"tpl": "<l1>BehaviorTreeData</l> <b>create_from_bt_instance</b>(bt_instance: <l2>BTInstance</l>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortreedata\"><span class=\"std std-ref\">BehaviorTreeData</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btinstance#class-btinstance\"><span class=\"std std-ref\">BTInstance</span></a>",
|
||
"3": "<abbr title=\"This method doesn't need an instance to be called, so it can be called directly using the class name.\">static</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-behaviortreedata-method-create-from-bt-instance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns current state of the <1/> encoded as a <b>BehaviorTreeData</b>, suitable for use with <l2>BehaviorTreeView</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bt_instance</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortreeview#class-behaviortreeview\\\"><span class=\\\"std std-ref\\\">BehaviorTreeView</span></a>\"}": {
|
||
"uid": 769,
|
||
"tpl": "Returns current state of the <1/> encoded as a <b>BehaviorTreeData</b>, suitable for use with <l2>BehaviorTreeView</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bt_instance</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortreeview#class-behaviortreeview\"><span class=\"std std-ref\">BehaviorTreeView</span></a>"
|
||
}
|
||
},
|
||
"Behavior tree instance can be acquired with <l1>BTPlayer.get_bt_instance</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayer#class-btplayer-method-get-bt-instance\\\"><span class=\\\"std std-ref\\\">BTPlayer.get_bt_instance</span></a>\"}": {
|
||
"uid": 770,
|
||
"tpl": "Behavior tree instance can be acquired with <l1>BTPlayer.get_bt_instance</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btplayer#class-btplayer-method-get-bt-instance\"><span class=\"std std-ref\">BTPlayer.get_bt_instance</span></a>"
|
||
}
|
||
},
|
||
"BehaviorTreeView\u0000{}": {
|
||
"uid": 771,
|
||
"tpl": "BehaviorTreeView",
|
||
"markers": {}
|
||
},
|
||
"Visualizes the current state of a <l1>BehaviorTree</l> instance.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 772,
|
||
"tpl": "Visualizes the current state of a <l1>BehaviorTree</l> instance.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Visualizes the current state of a <l1>BehaviorTree</l> instance. See also <l2>BehaviorTreeData</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortreedata#class-behaviortreedata\\\"><span class=\\\"std std-ref\\\">BehaviorTreeData</span></a>\"}": {
|
||
"uid": 773,
|
||
"tpl": "Visualizes the current state of a <l1>BehaviorTree</l> instance. See also <l2>BehaviorTreeData</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortreedata#class-behaviortreedata\"><span class=\"std std-ref\">BehaviorTreeData</span></a>"
|
||
}
|
||
},
|
||
"<l1>update_interval_msec</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreeview-property-update-interval-msec\\\"><span class=\\\"std std-ref\\\">update_interval_msec</span></a>\"}": {
|
||
"uid": 774,
|
||
"tpl": "<l1>update_interval_msec</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortreeview-property-update-interval-msec\"><span class=\"std std-ref\">update_interval_msec</span></a>"
|
||
}
|
||
},
|
||
"<l1>clear</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreeview-method-clear\\\"><span class=\\\"std std-ref\\\">clear</span></a>\"}": {
|
||
"uid": 775,
|
||
"tpl": "<l1>clear</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortreeview-method-clear\"><span class=\"std std-ref\">clear</span></a>"
|
||
}
|
||
},
|
||
"<l1>update_tree</l>(behavior_tree_data: <l2>BehaviorTreeData</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreeview-method-update-tree\\\"><span class=\\\"std std-ref\\\">update_tree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortreedata#class-behaviortreedata\\\"><span class=\\\"std std-ref\\\">BehaviorTreeData</span></a>\"}": {
|
||
"uid": 776,
|
||
"tpl": "<l1>update_tree</l>(behavior_tree_data: <l2>BehaviorTreeData</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-behaviortreeview-method-update-tree\"><span class=\"std std-ref\">update_tree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortreedata#class-behaviortreedata\"><span class=\"std std-ref\">BehaviorTreeData</span></a>"
|
||
}
|
||
},
|
||
"<b>task_selected</b>(type_name: <1/>, script_path: <2/>) <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreeview-signal-task-selected\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 777,
|
||
"tpl": "<b>task_selected</b>(type_name: <1/>, script_path: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortreeview-signal-task-selected\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when a task item is selected in <b>BehaviorTreeView</b>.\u0000{}": {
|
||
"uid": 778,
|
||
"tpl": "Emitted when a task item is selected in <b>BehaviorTreeView</b>.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>update_interval_msec</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreeview-property-update-interval-msec\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 779,
|
||
"tpl": "<1/> <b>update_interval_msec</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortreeview-property-update-interval-msec\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_update_interval_msec</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 780,
|
||
"tpl": "<1/> <b>set_update_interval_msec</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_update_interval_msec</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 781,
|
||
"tpl": "<1/> <b>get_update_interval_msec</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"Minimum delay between two updates (in milliseconds). Set to higher values for a lower CPU load.\u0000{}": {
|
||
"uid": 782,
|
||
"tpl": "Minimum delay between two updates (in milliseconds). Set to higher values for a lower CPU load.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>clear</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreeview-method-clear\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 783,
|
||
"tpl": "<1/> <b>clear</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-behaviortreeview-method-clear\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Clears the tree view.\u0000{}": {
|
||
"uid": 784,
|
||
"tpl": "Clears the tree view.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>update_tree</b>(behavior_tree_data: <l2>BehaviorTreeData</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortreedata#class-behaviortreedata\\\"><span class=\\\"std std-ref\\\">BehaviorTreeData</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-behaviortreeview-method-update-tree\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 785,
|
||
"tpl": "<1/> <b>update_tree</b>(behavior_tree_data: <l2>BehaviorTreeData</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortreedata#class-behaviortreedata\"><span class=\"std std-ref\">BehaviorTreeData</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-behaviortreeview-method-update-tree\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Updates the representation of a <l1>BehaviorTree</l> instance. See also <l2>BehaviorTreeData</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortreedata#class-behaviortreedata\\\"><span class=\\\"std std-ref\\\">BehaviorTreeData</span></a>\"}": {
|
||
"uid": 786,
|
||
"tpl": "Updates the representation of a <l1>BehaviorTree</l> instance. See also <l2>BehaviorTreeData</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortreedata#class-behaviortreedata\"><span class=\"std std-ref\">BehaviorTreeData</span></a>"
|
||
}
|
||
},
|
||
"BlackboardPlan\u0000{}": {
|
||
"uid": 787,
|
||
"tpl": "BlackboardPlan",
|
||
"markers": {}
|
||
},
|
||
"<l1>prefetch_nodepath_vars</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-property-prefetch-nodepath-vars\\\"><span class=\\\"std std-ref\\\">prefetch_nodepath_vars</span></a>\"}": {
|
||
"uid": 788,
|
||
"tpl": "<l1>prefetch_nodepath_vars</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-property-prefetch-nodepath-vars\"><span class=\"std std-ref\">prefetch_nodepath_vars</span></a>"
|
||
}
|
||
},
|
||
"<l1>create_blackboard</l>(prefetch_root: <2/>, parent_scope: <l3>Blackboard</l> = null, prefetch_root_for_base_plan: <4/> = null)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-create-blackboard\\\"><span class=\\\"std std-ref\\\">create_blackboard</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 789,
|
||
"tpl": "<l1>create_blackboard</l>(prefetch_root: <2/>, parent_scope: <l3>Blackboard</l> = null, prefetch_root_for_base_plan: <4/> = null)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-create-blackboard\"><span class=\"std std-ref\">create_blackboard</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"<l1>BlackboardPlan</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 790,
|
||
"tpl": "<l1>BlackboardPlan</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_base_plan</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-get-base-plan\\\"><span class=\\\"std std-ref\\\">get_base_plan</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 791,
|
||
"tpl": "<l1>get_base_plan</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-get-base-plan\"><span class=\"std std-ref\">get_base_plan</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_parent_scope_plan_provider</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-get-parent-scope-plan-provider\\\"><span class=\\\"std std-ref\\\">get_parent_scope_plan_provider</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 792,
|
||
"tpl": "<l1>get_parent_scope_plan_provider</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-get-parent-scope-plan-provider\"><span class=\"std std-ref\">get_parent_scope_plan_provider</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>is_derived</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-is-derived\\\"><span class=\\\"std std-ref\\\">is_derived</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 793,
|
||
"tpl": "<l1>is_derived</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-is-derived\"><span class=\"std std-ref\">is_derived</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>populate_blackboard</l>(blackboard: <l2>Blackboard</l>, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-populate-blackboard\\\"><span class=\\\"std std-ref\\\">populate_blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 794,
|
||
"tpl": "<l1>populate_blackboard</l>(blackboard: <l2>Blackboard</l>, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-populate-blackboard\"><span class=\"std std-ref\">populate_blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"<l1>set_base_plan</l>(blackboard_plan: <l2>BlackboardPlan</l>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-set-base-plan\\\"><span class=\\\"std std-ref\\\">set_base_plan</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\"}": {
|
||
"uid": 795,
|
||
"tpl": "<l1>set_base_plan</l>(blackboard_plan: <l2>BlackboardPlan</l>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-set-base-plan\"><span class=\"std std-ref\">set_base_plan</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>"
|
||
}
|
||
},
|
||
"<l1>set_parent_scope_plan_provider</l>(callable: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-set-parent-scope-plan-provider\\\"><span class=\\\"std std-ref\\\">set_parent_scope_plan_provider</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\"}": {
|
||
"uid": 796,
|
||
"tpl": "<l1>set_parent_scope_plan_provider</l>(callable: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-set-parent-scope-plan-provider\"><span class=\"std std-ref\">set_parent_scope_plan_provider</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>"
|
||
}
|
||
},
|
||
"<l1>sync_with_base_plan</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-sync-with-base-plan\\\"><span class=\\\"std std-ref\\\">sync_with_base_plan</span></a>\"}": {
|
||
"uid": 797,
|
||
"tpl": "<l1>sync_with_base_plan</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-sync-with-base-plan\"><span class=\"std std-ref\">sync_with_base_plan</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>prefetch_nodepath_vars</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-property-prefetch-nodepath-vars\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 798,
|
||
"tpl": "<1/> <b>prefetch_nodepath_vars</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboardplan-property-prefetch-nodepath-vars\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_prefetch_nodepath_vars</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 799,
|
||
"tpl": "<1/> <b>set_prefetch_nodepath_vars</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>is_prefetching_nodepath_vars</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 800,
|
||
"tpl": "<1/> <b>is_prefetching_nodepath_vars</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"Enables or disables <1/> variable prefetching. If <2/>, <3/> values will be replaced with node instances when the <l4>Blackboard</l> is created.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 801,
|
||
"tpl": "Enables or disables <1/> variable prefetching. If <2/>, <3/> values will be replaced with node instances when the <l4>Blackboard</l> is created.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<l1>Blackboard</l> <b>create_blackboard</b>(prefetch_root: <2/>, parent_scope: <l3>Blackboard</l> = null, prefetch_root_for_base_plan: <4/> = null) <l5>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-create-blackboard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 802,
|
||
"tpl": "<l1>Blackboard</l> <b>create_blackboard</b>(prefetch_root: <2/>, parent_scope: <l3>Blackboard</l> = null, prefetch_root_for_base_plan: <4/> = null) <l5>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-create-blackboard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Constructs a new instance of a <l1>Blackboard</l> using this plan. If <2/> prefetching is enabled, <3/> will be used to retrieve node instances for <4/> variables and substitute their values.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">prefetch_root</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\"}": {
|
||
"uid": 803,
|
||
"tpl": "Constructs a new instance of a <l1>Blackboard</l> using this plan. If <2/> prefetching is enabled, <3/> will be used to retrieve node instances for <4/> variables and substitute their values.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">prefetch_root</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>"
|
||
}
|
||
},
|
||
"<l1>BlackboardPlan</l> <b>get_base_plan</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-get-base-plan\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 804,
|
||
"tpl": "<l1>BlackboardPlan</l> <b>get_base_plan</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-get-base-plan\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the base plan. See <l1>is_derived</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-is-derived\\\"><span class=\\\"std std-ref\\\">is_derived</span></a>\"}": {
|
||
"uid": 805,
|
||
"tpl": "Returns the base plan. See <l1>is_derived</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-is-derived\"><span class=\"std std-ref\">is_derived</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_parent_scope_plan_provider</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-get-parent-scope-plan-provider\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 806,
|
||
"tpl": "<1/> <b>get_parent_scope_plan_provider</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-get-parent-scope-plan-provider\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the parent scope plan provider - a callable that returns a <b>BlackboardPlan</b>.\u0000{}": {
|
||
"uid": 807,
|
||
"tpl": "Returns the parent scope plan provider - a callable that returns a <b>BlackboardPlan</b>.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>is_derived</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-is-derived\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 808,
|
||
"tpl": "<1/> <b>is_derived</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-is-derived\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if this plan is derived from another, i.e., the base plan is not <2/>. A derived plan can only contain variables that are present in the base plan, and only variable values can be different.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">null</span></code>\"}": {
|
||
"uid": 809,
|
||
"tpl": "Returns <1/> if this plan is derived from another, i.e., the base plan is not <2/>. A derived plan can only contain variables that are present in the base plan, and only variable values can be different.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">null</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>populate_blackboard</b>(blackboard: <l2>Blackboard</l>, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null) <l6>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-populate-blackboard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 810,
|
||
"tpl": "<1/> <b>populate_blackboard</b>(blackboard: <l2>Blackboard</l>, overwrite: <3/>, prefetch_root: <4/>, prefetch_root_for_base_plan: <5/> = null) <l6>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-populate-blackboard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Populates <1/> with the variables from this plan. If <2/> is <3/>, existing variables with the same names will be overwritten. If <4/> prefetching is enabled, <5/> will be used to retrieve node instances for <6/> variables and substitute their values.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">blackboard</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">overwrite</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">prefetch_root</span></code>\", \"6\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">NodePath</span></code>\"}": {
|
||
"uid": 811,
|
||
"tpl": "Populates <1/> with the variables from this plan. If <2/> is <3/>, existing variables with the same names will be overwritten. If <4/> prefetching is enabled, <5/> will be used to retrieve node instances for <6/> variables and substitute their values.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">blackboard</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">overwrite</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">prefetch_root</span></code>",
|
||
"6": "<code class=\"docutils literal notranslate\"><span class=\"pre\">NodePath</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>set_base_plan</b>(blackboard_plan: <l2>BlackboardPlan</l>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-set-base-plan\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 812,
|
||
"tpl": "<1/> <b>set_base_plan</b>(blackboard_plan: <l2>BlackboardPlan</l>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-set-base-plan\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the base plan. If assigned, this plan will be derived from the base plan.\u0000{}": {
|
||
"uid": 813,
|
||
"tpl": "Sets the base plan. If assigned, this plan will be derived from the base plan.",
|
||
"markers": {}
|
||
},
|
||
"Use with caution, as it will remove variables not present in the base plan. Only use this for custom tooling.\u0000{}": {
|
||
"uid": 814,
|
||
"tpl": "Use with caution, as it will remove variables not present in the base plan. Only use this for custom tooling.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>set_parent_scope_plan_provider</b>(callable: <2/>) <l3>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Callable</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-set-parent-scope-plan-provider\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 815,
|
||
"tpl": "<1/> <b>set_parent_scope_plan_provider</b>(callable: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Callable</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-set-parent-scope-plan-provider\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the parent scope plan provider - a callable that returns a <b>BlackboardPlan</b>. Used to provide hints in the inspector. When set, mapping feature becomes available.\u0000{}": {
|
||
"uid": 816,
|
||
"tpl": "Sets the parent scope plan provider - a callable that returns a <b>BlackboardPlan</b>. Used to provide hints in the inspector. When set, mapping feature becomes available.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>sync_with_base_plan</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-blackboardplan-method-sync-with-base-plan\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 817,
|
||
"tpl": "<1/> <b>sync_with_base_plan</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-blackboardplan-method-sync-with-base-plan\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Synchronizes this plan with the base plan: removes variables not present in the base plan, and updates type information. Only use this for custom tooling.\u0000{}": {
|
||
"uid": 818,
|
||
"tpl": "Synchronizes this plan with the base plan: removes variables not present in the base plan, and updates type information. Only use this for custom tooling.",
|
||
"markers": {}
|
||
},
|
||
"BT\u0000{}": {
|
||
"uid": 819,
|
||
"tpl": "BT",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTTask</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 820,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTTask</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"Base of <l1>BTTask</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 821,
|
||
"tpl": "Base of <l1>BTTask</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"enum <b>Status</b>: <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bt-status\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 822,
|
||
"tpl": "enum <b>Status</b>: <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bt-status\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>Status</l> <b>FRESH</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\"}": {
|
||
"uid": 823,
|
||
"tpl": "<l1>Status</l> <b>FRESH</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>"
|
||
}
|
||
},
|
||
"Task wasn’t executed yet or it was aborted and reset.\u0000{}": {
|
||
"uid": 824,
|
||
"tpl": "Task wasn’t executed yet or it was aborted and reset.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>RUNNING</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\"}": {
|
||
"uid": 825,
|
||
"tpl": "<l1>Status</l> <b>RUNNING</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>"
|
||
}
|
||
},
|
||
"Task is being performed and hasn’t finished yet.\u0000{}": {
|
||
"uid": 826,
|
||
"tpl": "Task is being performed and hasn’t finished yet.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>FAILURE</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">2</span></code>\"}": {
|
||
"uid": 827,
|
||
"tpl": "<l1>Status</l> <b>FAILURE</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">2</span></code>"
|
||
}
|
||
},
|
||
"Task has finished with failure.\u0000{}": {
|
||
"uid": 828,
|
||
"tpl": "Task has finished with failure.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>SUCCESS</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">3</span></code>\"}": {
|
||
"uid": 829,
|
||
"tpl": "<l1>Status</l> <b>SUCCESS</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">3</span></code>"
|
||
}
|
||
},
|
||
"Task has finished with success.\u0000{}": {
|
||
"uid": 830,
|
||
"tpl": "Task has finished with success.",
|
||
"markers": {}
|
||
},
|
||
"BTAction\u0000{}": {
|
||
"uid": 831,
|
||
"tpl": "BTAction",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BTTask</l> <b><</b> <l2>BT</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#class-bt\\\"><span class=\\\"std std-ref\\\">BT</span></a>\"}": {
|
||
"uid": 832,
|
||
"tpl": "<b>Inherits:</b> <l1>BTTask</l> <b><</b> <l2>BT</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bt#class-bt\"><span class=\"std std-ref\">BT</span></a>"
|
||
}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTAwaitAnimation</l>, <l2>BTCallMethod</l>, <l3>BTConsolePrint</l>, <l4>BTEvaluateExpression</l>, <l5>BTFail</l>, <l6>BTPauseAnimation</l>, <l7>BTPlayAnimation</l>, <l8>BTRandomWait</l>, <l9>BTSetAgentProperty</l>, <l10>BTSetVar</l>, <l11>BTStopAnimation</l>, <l12>BTWait</l>, <l13>BTWaitTicks</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btawaitanimation#class-btawaitanimation\\\"><span class=\\\"std std-ref\\\">BTAwaitAnimation</span></a>\", \"10\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsetvar#class-btsetvar\\\"><span class=\\\"std std-ref\\\">BTSetVar</span></a>\", \"11\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btstopanimation#class-btstopanimation\\\"><span class=\\\"std std-ref\\\">BTStopAnimation</span></a>\", \"12\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btwait#class-btwait\\\"><span class=\\\"std std-ref\\\">BTWait</span></a>\", \"13\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btwaitticks#class-btwaitticks\\\"><span class=\\\"std std-ref\\\">BTWaitTicks</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcallmethod#class-btcallmethod\\\"><span class=\\\"std std-ref\\\">BTCallMethod</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btconsoleprint#class-btconsoleprint\\\"><span class=\\\"std std-ref\\\">BTConsolePrint</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btevaluateexpression#class-btevaluateexpression\\\"><span class=\\\"std std-ref\\\">BTEvaluateExpression</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btfail#class-btfail\\\"><span class=\\\"std std-ref\\\">BTFail</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btpauseanimation#class-btpauseanimation\\\"><span class=\\\"std std-ref\\\">BTPauseAnimation</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btplayanimation#class-btplayanimation\\\"><span class=\\\"std std-ref\\\">BTPlayAnimation</span></a>\", \"8\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrandomwait#class-btrandomwait\\\"><span class=\\\"std std-ref\\\">BTRandomWait</span></a>\", \"9\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsetagentproperty#class-btsetagentproperty\\\"><span class=\\\"std std-ref\\\">BTSetAgentProperty</span></a>\"}": {
|
||
"uid": 833,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTAwaitAnimation</l>, <l2>BTCallMethod</l>, <l3>BTConsolePrint</l>, <l4>BTEvaluateExpression</l>, <l5>BTFail</l>, <l6>BTPauseAnimation</l>, <l7>BTPlayAnimation</l>, <l8>BTRandomWait</l>, <l9>BTSetAgentProperty</l>, <l10>BTSetVar</l>, <l11>BTStopAnimation</l>, <l12>BTWait</l>, <l13>BTWaitTicks</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btawaitanimation#class-btawaitanimation\"><span class=\"std std-ref\">BTAwaitAnimation</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btcallmethod#class-btcallmethod\"><span class=\"std std-ref\">BTCallMethod</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btconsoleprint#class-btconsoleprint\"><span class=\"std std-ref\">BTConsolePrint</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btevaluateexpression#class-btevaluateexpression\"><span class=\"std std-ref\">BTEvaluateExpression</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btfail#class-btfail\"><span class=\"std std-ref\">BTFail</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_btpauseanimation#class-btpauseanimation\"><span class=\"std std-ref\">BTPauseAnimation</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_btplayanimation#class-btplayanimation\"><span class=\"std std-ref\">BTPlayAnimation</span></a>",
|
||
"8": "<a class=\"reference internal\" href=\"#document-classes/class_btrandomwait#class-btrandomwait\"><span class=\"std std-ref\">BTRandomWait</span></a>",
|
||
"9": "<a class=\"reference internal\" href=\"#document-classes/class_btsetagentproperty#class-btsetagentproperty\"><span class=\"std std-ref\">BTSetAgentProperty</span></a>",
|
||
"10": "<a class=\"reference internal\" href=\"#document-classes/class_btsetvar#class-btsetvar\"><span class=\"std std-ref\">BTSetVar</span></a>",
|
||
"11": "<a class=\"reference internal\" href=\"#document-classes/class_btstopanimation#class-btstopanimation\"><span class=\"std std-ref\">BTStopAnimation</span></a>",
|
||
"12": "<a class=\"reference internal\" href=\"#document-classes/class_btwait#class-btwait\"><span class=\"std std-ref\">BTWait</span></a>",
|
||
"13": "<a class=\"reference internal\" href=\"#document-classes/class_btwaitticks#class-btwaitticks\"><span class=\"std std-ref\">BTWaitTicks</span></a>"
|
||
}
|
||
},
|
||
"Base class for all <l1>BehaviorTree</l> actions.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 834,
|
||
"tpl": "Base class for all <l1>BehaviorTree</l> actions.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Base class for all actions within a <l1>BehaviorTree</l>. You can create your own actions by extending the <b>BTAction</b> class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 835,
|
||
"tpl": "Base class for all actions within a <l1>BehaviorTree</l>. You can create your own actions by extending the <b>BTAction</b> class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Represents a specific behavior or action in a <l1>BehaviorTree</l> that an agent should execute. Actions are the lowest level of the <l2>BehaviorTree</l> hierarchy and are responsible for performing the actual work required to achieve a goal. Actions do not have child tasks.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 836,
|
||
"tpl": "Represents a specific behavior or action in a <l1>BehaviorTree</l> that an agent should execute. Actions are the lowest level of the <l2>BehaviorTree</l> hierarchy and are responsible for performing the actual work required to achieve a goal. Actions do not have child tasks.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"A single action can perform a task within one or multiple ticks. If it takes more than one tick to complete the task, the action should return <1/> status. When the task is finished, the action returns either <2/> or <3/> to indicate the outcome.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 837,
|
||
"tpl": "A single action can perform a task within one or multiple ticks. If it takes more than one tick to complete the task, the action should return <1/> status. When the task is finished, the action returns either <2/> or <3/> to indicate the outcome.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTAlwaysFail\u0000{}": {
|
||
"uid": 838,
|
||
"tpl": "BTAlwaysFail",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BTDecorator</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdecorator#class-btdecorator\\\"><span class=\\\"std std-ref\\\">BTDecorator</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#class-bt\\\"><span class=\\\"std std-ref\\\">BT</span></a>\"}": {
|
||
"uid": 839,
|
||
"tpl": "<b>Inherits:</b> <l1>BTDecorator</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btdecorator#class-btdecorator\"><span class=\"std std-ref\">BTDecorator</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bt#class-bt\"><span class=\"std std-ref\">BT</span></a>"
|
||
}
|
||
},
|
||
"BT decorator that converts <1/> into <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 840,
|
||
"tpl": "BT decorator that converts <1/> into <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTAlwaysSucceed\u0000{}": {
|
||
"uid": 841,
|
||
"tpl": "BTAlwaysSucceed",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that converts <1/> into <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 842,
|
||
"tpl": "BT decorator that converts <1/> into <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTAwaitAnimation\u0000{}": {
|
||
"uid": 843,
|
||
"tpl": "BTAwaitAnimation",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BTAction</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btaction#class-btaction\\\"><span class=\\\"std std-ref\\\">BTAction</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#class-bt\\\"><span class=\\\"std std-ref\\\">BT</span></a>\"}": {
|
||
"uid": 844,
|
||
"tpl": "<b>Inherits:</b> <l1>BTAction</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btaction#class-btaction\"><span class=\"std std-ref\">BTAction</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bt#class-bt\"><span class=\"std std-ref\">BT</span></a>"
|
||
}
|
||
},
|
||
"BT action that waits for an animation to finish playing.\u0000{}": {
|
||
"uid": 845,
|
||
"tpl": "BT action that waits for an animation to finish playing.",
|
||
"markers": {}
|
||
},
|
||
"BTAwaitAnimation action waits for an animation on the specified <1/> node to finish playing and returns <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 846,
|
||
"tpl": "BTAwaitAnimation action waits for an animation on the specified <1/> node to finish playing and returns <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the specified animation has finished playing or if the specified animation is not currently playing.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 847,
|
||
"tpl": "Returns <1/> if the specified animation has finished playing or if the specified animation is not currently playing.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the specified animation doesn’t exist or if the action fails to get the <2/> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 848,
|
||
"tpl": "Returns <1/> if the specified animation doesn’t exist or if the action fails to get the <2/> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"<l1>animation_name</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btawaitanimation-property-animation-name\\\"><span class=\\\"std std-ref\\\">animation_name</span></a>\"}": {
|
||
"uid": 849,
|
||
"tpl": "<l1>animation_name</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btawaitanimation-property-animation-name\"><span class=\"std std-ref\">animation_name</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\"}": {
|
||
"uid": 850,
|
||
"tpl": "<l1>BBNode</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>"
|
||
}
|
||
},
|
||
"<l1>animation_player</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btawaitanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">animation_player</span></a>\"}": {
|
||
"uid": 851,
|
||
"tpl": "<l1>animation_player</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btawaitanimation-property-animation-player\"><span class=\"std std-ref\">animation_player</span></a>"
|
||
}
|
||
},
|
||
"<l1>max_time</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btawaitanimation-property-max-time\\\"><span class=\\\"std std-ref\\\">max_time</span></a>\"}": {
|
||
"uid": 852,
|
||
"tpl": "<l1>max_time</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btawaitanimation-property-max-time\"><span class=\"std std-ref\">max_time</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>animation_name</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btawaitanimation-property-animation-name\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 853,
|
||
"tpl": "<1/> <b>animation_name</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btawaitanimation-property-animation-name\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_animation_name</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 854,
|
||
"tpl": "<1/> <b>set_animation_name</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_animation_name</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 855,
|
||
"tpl": "<1/> <b>get_animation_name</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"Animation’s key within the <1/> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 856,
|
||
"tpl": "Animation’s key within the <1/> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btawaitanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 857,
|
||
"tpl": "<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btawaitanimation-property-animation-player\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_animation_player</b>(value: <l2>BBNode</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\"}": {
|
||
"uid": 858,
|
||
"tpl": "<1/> <b>set_animation_player</b>(value: <l2>BBNode</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l> <b>get_animation_player</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\"}": {
|
||
"uid": 859,
|
||
"tpl": "<l1>BBNode</l> <b>get_animation_player</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>"
|
||
}
|
||
},
|
||
"Parameter that specifies the <1/> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 860,
|
||
"tpl": "Parameter that specifies the <1/> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>max_time</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btawaitanimation-property-max-time\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 861,
|
||
"tpl": "<1/> <b>max_time</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btawaitanimation-property-max-time\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_max_time</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 862,
|
||
"tpl": "<1/> <b>set_max_time</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_max_time</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 863,
|
||
"tpl": "<1/> <b>get_max_time</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"The maximum duration to wait for the animation to complete (in seconds). If the animation doesn’t finish within this time, BTAwaitAnimation will stop waiting and return <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 864,
|
||
"tpl": "The maximum duration to wait for the animation to complete (in seconds). If the animation doesn’t finish within this time, BTAwaitAnimation will stop waiting and return <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTCallMethod\u0000{}": {
|
||
"uid": 865,
|
||
"tpl": "BTCallMethod",
|
||
"markers": {}
|
||
},
|
||
"BT action that calls a method on a specified <1/> or <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\"}": {
|
||
"uid": 866,
|
||
"tpl": "BT action that calls a method on a specified <1/> or <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>"
|
||
}
|
||
},
|
||
"BTCallMethod action calls a <l1>method</l> on the specified <2/> or <3/> instance and returns <4/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-method\\\"><span class=\\\"std std-ref\\\">method</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 867,
|
||
"tpl": "BTCallMethod action calls a <l1>method</l> on the specified <2/> or <3/> instance and returns <4/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-method\"><span class=\"std std-ref\">method</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the action encounters an issue during the method execution.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 868,
|
||
"tpl": "Returns <1/> if the action encounters an issue during the method execution.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Array[<l1>BBVariant</l>]\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 869,
|
||
"tpl": "Array[<l1>BBVariant</l>]",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"<l1>args</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-args\\\"><span class=\\\"std std-ref\\\">args</span></a>\"}": {
|
||
"uid": 870,
|
||
"tpl": "<l1>args</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-args\"><span class=\"std std-ref\">args</span></a>"
|
||
}
|
||
},
|
||
"<l1>args_include_delta</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-args-include-delta\\\"><span class=\\\"std std-ref\\\">args_include_delta</span></a>\"}": {
|
||
"uid": 871,
|
||
"tpl": "<l1>args_include_delta</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-args-include-delta\"><span class=\"std std-ref\">args_include_delta</span></a>"
|
||
}
|
||
},
|
||
"<l1>method</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-method\\\"><span class=\\\"std std-ref\\\">method</span></a>\"}": {
|
||
"uid": 872,
|
||
"tpl": "<l1>method</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-method\"><span class=\"std std-ref\">method</span></a>"
|
||
}
|
||
},
|
||
"<l1>node</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-node\\\"><span class=\\\"std std-ref\\\">node</span></a>\"}": {
|
||
"uid": 873,
|
||
"tpl": "<l1>node</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-node\"><span class=\"std std-ref\">node</span></a>"
|
||
}
|
||
},
|
||
"<l1>result_var</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-result-var\\\"><span class=\\\"std std-ref\\\">result_var</span></a>\"}": {
|
||
"uid": 874,
|
||
"tpl": "<l1>result_var</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-result-var\"><span class=\"std std-ref\">result_var</span></a>"
|
||
}
|
||
},
|
||
"Array[<l1>BBVariant</l>] <b>args</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">[]</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-args\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 875,
|
||
"tpl": "Array[<l1>BBVariant</l>] <b>args</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">[]</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-args\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_args</b>(value: Array[<l2>BBVariant</l>])\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 876,
|
||
"tpl": "<1/> <b>set_args</b>(value: Array[<l2>BBVariant</l>])",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"Array[<l1>BBVariant</l>] <b>get_args</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 877,
|
||
"tpl": "Array[<l1>BBVariant</l>] <b>get_args</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"The arguments to be passed when calling the method.\u0000{}": {
|
||
"uid": 878,
|
||
"tpl": "The arguments to be passed when calling the method.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>args_include_delta</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-args-include-delta\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 879,
|
||
"tpl": "<1/> <b>args_include_delta</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-args-include-delta\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_include_delta</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 880,
|
||
"tpl": "<1/> <b>set_include_delta</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>is_delta_included</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 881,
|
||
"tpl": "<1/> <b>is_delta_included</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"Include delta as a first parameter and shift the position of the rest of the arguments if any.\u0000{}": {
|
||
"uid": 882,
|
||
"tpl": "Include delta as a first parameter and shift the position of the rest of the arguments if any.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>method</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-method\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 883,
|
||
"tpl": "<1/> <b>method</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-method\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_method</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 884,
|
||
"tpl": "<1/> <b>set_method</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_method</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 885,
|
||
"tpl": "<1/> <b>get_method</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"The name of the method to be called.\u0000{}": {
|
||
"uid": 886,
|
||
"tpl": "The name of the method to be called.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BBNode</l> <b>node</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-node\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 887,
|
||
"tpl": "<l1>BBNode</l> <b>node</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-node\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_node_param</b>(value: <l2>BBNode</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\"}": {
|
||
"uid": 888,
|
||
"tpl": "<1/> <b>set_node_param</b>(value: <l2>BBNode</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l> <b>get_node_param</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\"}": {
|
||
"uid": 889,
|
||
"tpl": "<l1>BBNode</l> <b>get_node_param</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>"
|
||
}
|
||
},
|
||
"Specifies the <1/> or <2/> instance containing the method to be called.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\"}": {
|
||
"uid": 890,
|
||
"tpl": "Specifies the <1/> or <2/> instance containing the method to be called.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>result_var</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcallmethod-property-result-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 891,
|
||
"tpl": "<1/> <b>result_var</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcallmethod-property-result-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_result_var</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 892,
|
||
"tpl": "<1/> <b>set_result_var</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_result_var</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 893,
|
||
"tpl": "<1/> <b>get_result_var</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"if non-empty, assign the result of the method call to the blackboard variable specified by this property.\u0000{}": {
|
||
"uid": 894,
|
||
"tpl": "if non-empty, assign the result of the method call to the blackboard variable specified by this property.",
|
||
"markers": {}
|
||
},
|
||
"BTCheckAgentProperty\u0000{}": {
|
||
"uid": 895,
|
||
"tpl": "BTCheckAgentProperty",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BTCondition</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcondition#class-btcondition\\\"><span class=\\\"std std-ref\\\">BTCondition</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#class-bt\\\"><span class=\\\"std std-ref\\\">BT</span></a>\"}": {
|
||
"uid": 896,
|
||
"tpl": "<b>Inherits:</b> <l1>BTCondition</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btcondition#class-btcondition\"><span class=\"std std-ref\">BTCondition</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bt#class-bt\"><span class=\"std std-ref\">BT</span></a>"
|
||
}
|
||
},
|
||
"BT condition that checks agent’s property value.\u0000{}": {
|
||
"uid": 897,
|
||
"tpl": "BT condition that checks agent’s property value.",
|
||
"markers": {}
|
||
},
|
||
"BTCheckAgentProperty examines the agent’s property value and compares it to <l1>value</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\"}": {
|
||
"uid": 898,
|
||
"tpl": "BTCheckAgentProperty examines the agent’s property value and compares it to <l1>value</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-value\"><span class=\"std std-ref\">value</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> or <2/> based on the <l3>check_type</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-check-type\\\"><span class=\\\"std std-ref\\\">check_type</span></a>\"}": {
|
||
"uid": 899,
|
||
"tpl": "Returns <1/> or <2/> based on the <l3>check_type</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-check-type\"><span class=\"std std-ref\">check_type</span></a>"
|
||
}
|
||
},
|
||
"<l1>CheckType</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\"}": {
|
||
"uid": 900,
|
||
"tpl": "<l1>CheckType</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>"
|
||
}
|
||
},
|
||
"<l1>check_type</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-check-type\\\"><span class=\\\"std std-ref\\\">check_type</span></a>\"}": {
|
||
"uid": 901,
|
||
"tpl": "<l1>check_type</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-check-type\"><span class=\"std std-ref\">check_type</span></a>"
|
||
}
|
||
},
|
||
"<l1>property</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-property\\\"><span class=\\\"std std-ref\\\">property</span></a>\"}": {
|
||
"uid": 902,
|
||
"tpl": "<l1>property</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-property\"><span class=\"std std-ref\">property</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBVariant</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 903,
|
||
"tpl": "<l1>BBVariant</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"<l1>value</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\"}": {
|
||
"uid": 904,
|
||
"tpl": "<l1>value</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-value\"><span class=\"std std-ref\">value</span></a>"
|
||
}
|
||
},
|
||
"<l1>CheckType</l> <b>check_type</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-check-type\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 905,
|
||
"tpl": "<l1>CheckType</l> <b>check_type</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-check-type\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_check_type</b>(value: <l2>CheckType</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\"}": {
|
||
"uid": 906,
|
||
"tpl": "<1/> <b>set_check_type</b>(value: <l2>CheckType</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>"
|
||
}
|
||
},
|
||
"<l1>CheckType</l> <b>get_check_type</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\"}": {
|
||
"uid": 907,
|
||
"tpl": "<l1>CheckType</l> <b>get_check_type</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>"
|
||
}
|
||
},
|
||
"The type of check to be performed.\u0000{}": {
|
||
"uid": 908,
|
||
"tpl": "The type of check to be performed.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>property</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-property\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 909,
|
||
"tpl": "<1/> <b>property</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-property\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_property</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 910,
|
||
"tpl": "<1/> <b>set_property</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_property</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 911,
|
||
"tpl": "<1/> <b>get_property</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"Parameter that specifies the agent’s property to be compared.\u0000{}": {
|
||
"uid": 912,
|
||
"tpl": "Parameter that specifies the agent’s property to be compared.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BBVariant</l> <b>value</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckagentproperty-property-value\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 913,
|
||
"tpl": "<l1>BBVariant</l> <b>value</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btcheckagentproperty-property-value\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_value</b>(value: <l2>BBVariant</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 914,
|
||
"tpl": "<1/> <b>set_value</b>(value: <l2>BBVariant</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBVariant</l> <b>get_value</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 915,
|
||
"tpl": "<l1>BBVariant</l> <b>get_value</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"Parameter that specifies the value against which an agent’s property will be compared.\u0000{}": {
|
||
"uid": 916,
|
||
"tpl": "Parameter that specifies the value against which an agent’s property will be compared.",
|
||
"markers": {}
|
||
},
|
||
"BTCheckTrigger\u0000{}": {
|
||
"uid": 917,
|
||
"tpl": "BTCheckTrigger",
|
||
"markers": {}
|
||
},
|
||
"BT condition that checks a trigger (a boolean variable).\u0000{}": {
|
||
"uid": 918,
|
||
"tpl": "BT condition that checks a trigger (a boolean variable).",
|
||
"markers": {}
|
||
},
|
||
"<b>BTCheckTrigger</b> verifies whether the <l1>variable</l> is set to <2/>. If it is, the task switches it to <3/> and returns <4/>. Otherwise, it returns <5/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btchecktrigger-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 919,
|
||
"tpl": "<b>BTCheckTrigger</b> verifies whether the <l1>variable</l> is set to <2/>. If it is, the task switches it to <3/> and returns <4/>. Otherwise, it returns <5/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btchecktrigger-property-variable\"><span class=\"std std-ref\">variable</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<b>BTCheckTrigger</b> can function as a “gate” within a <l1>BTSequence</l>: when the trigger variable is set to <2/>, it permits the execution of subsequent tasks and then changes the variable to <3/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\"}": {
|
||
"uid": 920,
|
||
"tpl": "<b>BTCheckTrigger</b> can function as a “gate” within a <l1>BTSequence</l>: when the trigger variable is set to <2/>, it permits the execution of subsequent tasks and then changes the variable to <3/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>"
|
||
}
|
||
},
|
||
"<l1>variable</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btchecktrigger-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\"}": {
|
||
"uid": 921,
|
||
"tpl": "<l1>variable</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btchecktrigger-property-variable\"><span class=\"std std-ref\">variable</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>variable</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btchecktrigger-property-variable\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 922,
|
||
"tpl": "<1/> <b>variable</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btchecktrigger-property-variable\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A boolean variable on the blackboard used as a trigger. See also <l1>BTTask.blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask-property-blackboard\\\"><span class=\\\"std std-ref\\\">BTTask.blackboard</span></a>\"}": {
|
||
"uid": 923,
|
||
"tpl": "A boolean variable on the blackboard used as a trigger. See also <l1>BTTask.blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask-property-blackboard\"><span class=\"std std-ref\">BTTask.blackboard</span></a>"
|
||
}
|
||
},
|
||
"If variable’s value is <1/>, <b>BTCheckTrigger</b> will switch it to <2/> and return <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 924,
|
||
"tpl": "If variable’s value is <1/>, <b>BTCheckTrigger</b> will switch it to <2/> and return <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"If variable’s value is <1/>, <b>BTCheckTrigger</b> will return <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 925,
|
||
"tpl": "If variable’s value is <1/>, <b>BTCheckTrigger</b> will return <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTCheckVar\u0000{}": {
|
||
"uid": 926,
|
||
"tpl": "BTCheckVar",
|
||
"markers": {}
|
||
},
|
||
"BT condition that checks a variable on the blackboard.\u0000{}": {
|
||
"uid": 927,
|
||
"tpl": "BT condition that checks a variable on the blackboard.",
|
||
"markers": {}
|
||
},
|
||
"BTCheckVar evaluates the <l1>variable</l> against <l2>value</l> and returns <3/> or <4/> based on the <l5>check_type</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-check-type\\\"><span class=\\\"std std-ref\\\">check_type</span></a>\"}": {
|
||
"uid": 928,
|
||
"tpl": "BTCheckVar evaluates the <l1>variable</l> against <l2>value</l> and returns <3/> or <4/> based on the <l5>check_type</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-variable\"><span class=\"std std-ref\">variable</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-value\"><span class=\"std std-ref\">value</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-check-type\"><span class=\"std std-ref\">check_type</span></a>"
|
||
}
|
||
},
|
||
"<l1>check_type</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-check-type\\\"><span class=\\\"std std-ref\\\">check_type</span></a>\"}": {
|
||
"uid": 929,
|
||
"tpl": "<l1>check_type</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-check-type\"><span class=\"std std-ref\">check_type</span></a>"
|
||
}
|
||
},
|
||
"<l1>value</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\"}": {
|
||
"uid": 930,
|
||
"tpl": "<l1>value</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-value\"><span class=\"std std-ref\">value</span></a>"
|
||
}
|
||
},
|
||
"<l1>variable</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\"}": {
|
||
"uid": 931,
|
||
"tpl": "<l1>variable</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-variable\"><span class=\"std std-ref\">variable</span></a>"
|
||
}
|
||
},
|
||
"<l1>CheckType</l> <b>check_type</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-check-type\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 932,
|
||
"tpl": "<l1>CheckType</l> <b>check_type</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-check-type\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBVariant</l> <b>value</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-value\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 933,
|
||
"tpl": "<l1>BBVariant</l> <b>value</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-value\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"A parameter that specifies the value against which the <l1>variable</l> will be compared.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\"}": {
|
||
"uid": 934,
|
||
"tpl": "A parameter that specifies the value against which the <l1>variable</l> will be compared.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-variable\"><span class=\"std std-ref\">variable</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>variable</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcheckvar-property-variable\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 935,
|
||
"tpl": "<1/> <b>variable</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcheckvar-property-variable\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"The name of the variable to check its value.\u0000{}": {
|
||
"uid": 936,
|
||
"tpl": "The name of the variable to check its value.",
|
||
"markers": {}
|
||
},
|
||
"BTComment\u0000{}": {
|
||
"uid": 937,
|
||
"tpl": "BTComment",
|
||
"markers": {}
|
||
},
|
||
"BTComment adds annotations or explanatory notes to a <l1>BehaviorTree</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 938,
|
||
"tpl": "BTComment adds annotations or explanatory notes to a <l1>BehaviorTree</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"BTComment is used to add annotations or explanatory notes to a <l1>BehaviorTree</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 939,
|
||
"tpl": "BTComment is used to add annotations or explanatory notes to a <l1>BehaviorTree</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Comments are not executed as part of the tree and are removed from runtime instances of the <l1>BehaviorTree</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 940,
|
||
"tpl": "Comments are not executed as part of the tree and are removed from runtime instances of the <l1>BehaviorTree</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"BTComposite\u0000{}": {
|
||
"uid": 941,
|
||
"tpl": "BTComposite",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTDynamicSelector</l>, <l2>BTDynamicSequence</l>, <l3>BTParallel</l>, <l4>BTProbabilitySelector</l>, <l5>BTRandomSelector</l>, <l6>BTRandomSequence</l>, <l7>BTSelector</l>, <l8>BTSequence</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdynamicselector#class-btdynamicselector\\\"><span class=\\\"std std-ref\\\">BTDynamicSelector</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdynamicsequence#class-btdynamicsequence\\\"><span class=\\\"std std-ref\\\">BTDynamicSequence</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btparallel#class-btparallel\\\"><span class=\\\"std std-ref\\\">BTParallel</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btprobabilityselector#class-btprobabilityselector\\\"><span class=\\\"std std-ref\\\">BTProbabilitySelector</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrandomselector#class-btrandomselector\\\"><span class=\\\"std std-ref\\\">BTRandomSelector</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrandomsequence#class-btrandomsequence\\\"><span class=\\\"std std-ref\\\">BTRandomSequence</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">BTSelector</span></a>\", \"8\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\"}": {
|
||
"uid": 942,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTDynamicSelector</l>, <l2>BTDynamicSequence</l>, <l3>BTParallel</l>, <l4>BTProbabilitySelector</l>, <l5>BTRandomSelector</l>, <l6>BTRandomSequence</l>, <l7>BTSelector</l>, <l8>BTSequence</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btdynamicselector#class-btdynamicselector\"><span class=\"std std-ref\">BTDynamicSelector</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btdynamicsequence#class-btdynamicsequence\"><span class=\"std std-ref\">BTDynamicSequence</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btparallel#class-btparallel\"><span class=\"std std-ref\">BTParallel</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btprobabilityselector#class-btprobabilityselector\"><span class=\"std std-ref\">BTProbabilitySelector</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btrandomselector#class-btrandomselector\"><span class=\"std std-ref\">BTRandomSelector</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_btrandomsequence#class-btrandomsequence\"><span class=\"std std-ref\">BTRandomSequence</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">BTSelector</span></a>",
|
||
"8": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>"
|
||
}
|
||
},
|
||
"Base class for BT composite tasks.\u0000{}": {
|
||
"uid": 943,
|
||
"tpl": "Base class for BT composite tasks.",
|
||
"markers": {}
|
||
},
|
||
"Base class for all <l1>BehaviorTree</l> composite tasks. You can create your own composite tasks by extending the BTComposite class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 944,
|
||
"tpl": "Base class for all <l1>BehaviorTree</l> composite tasks. You can create your own composite tasks by extending the BTComposite class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Composite is a control task within a <l1>BehaviorTree</l> that contains one or more child tasks. It defines the structure and flow of the <l2>BehaviorTree</l> by specifying how child tasks are executed. Composites can be used to group related tasks into a single unit, making it easier to manage and maintain the <l3>BehaviorTree</l>. Examples of <l4>BehaviorTree</l> composites include <l5>BTSelector</l>, <l6>BTSequence</l>, and <l7>BTParallel</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">BTSelector</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btparallel#class-btparallel\\\"><span class=\\\"std std-ref\\\">BTParallel</span></a>\"}": {
|
||
"uid": 945,
|
||
"tpl": "Composite is a control task within a <l1>BehaviorTree</l> that contains one or more child tasks. It defines the structure and flow of the <l2>BehaviorTree</l> by specifying how child tasks are executed. Composites can be used to group related tasks into a single unit, making it easier to manage and maintain the <l3>BehaviorTree</l>. Examples of <l4>BehaviorTree</l> composites include <l5>BTSelector</l>, <l6>BTSequence</l>, and <l7>BTParallel</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">BTSelector</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_btparallel#class-btparallel\"><span class=\"std std-ref\">BTParallel</span></a>"
|
||
}
|
||
},
|
||
"BTCondition\u0000{}": {
|
||
"uid": 946,
|
||
"tpl": "BTCondition",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTCheckAgentProperty</l>, <l2>BTCheckTrigger</l>, <l3>BTCheckVar</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcheckagentproperty#class-btcheckagentproperty\\\"><span class=\\\"std std-ref\\\">BTCheckAgentProperty</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btchecktrigger#class-btchecktrigger\\\"><span class=\\\"std std-ref\\\">BTCheckTrigger</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcheckvar#class-btcheckvar\\\"><span class=\\\"std std-ref\\\">BTCheckVar</span></a>\"}": {
|
||
"uid": 947,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTCheckAgentProperty</l>, <l2>BTCheckTrigger</l>, <l3>BTCheckVar</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btcheckagentproperty#class-btcheckagentproperty\"><span class=\"std std-ref\">BTCheckAgentProperty</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btchecktrigger#class-btchecktrigger\"><span class=\"std std-ref\">BTCheckTrigger</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btcheckvar#class-btcheckvar\"><span class=\"std std-ref\">BTCheckVar</span></a>"
|
||
}
|
||
},
|
||
"Base class for BT conditions.\u0000{}": {
|
||
"uid": 948,
|
||
"tpl": "Base class for BT conditions.",
|
||
"markers": {}
|
||
},
|
||
"Base class for all <l1>BehaviorTree</l> conditions. You can create your own conditions by extending the <b>BTCondition</b> class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 949,
|
||
"tpl": "Base class for all <l1>BehaviorTree</l> conditions. You can create your own conditions by extending the <b>BTCondition</b> class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Condition is a task within a <l1>BehaviorTree</l> that checks for a specific condition before executing subsequent tasks. It is often used inside composite tasks to control the execution flow. Conditions are used to verify the state of the environment, check for the presence of an enemy, or evaluate the health status of the agent. The use of condition tasks in a <l2>BehaviorTree</l> can improve system efficiency and prevent unnecessary actions. However, they may not be suitable for complex decision-making processes, and too many condition tasks can make the <l3>BehaviorTree</l> difficult to read.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 950,
|
||
"tpl": "Condition is a task within a <l1>BehaviorTree</l> that checks for a specific condition before executing subsequent tasks. It is often used inside composite tasks to control the execution flow. Conditions are used to verify the state of the environment, check for the presence of an enemy, or evaluate the health status of the agent. The use of condition tasks in a <l2>BehaviorTree</l> can improve system efficiency and prevent unnecessary actions. However, they may not be suitable for complex decision-making processes, and too many condition tasks can make the <l3>BehaviorTree</l> difficult to read.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Conditions typically don’t take multiple ticks to finish and return either <1/> or <2/> immediately.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 951,
|
||
"tpl": "Conditions typically don’t take multiple ticks to finish and return either <1/> or <2/> immediately.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTConsolePrint\u0000{}": {
|
||
"uid": 952,
|
||
"tpl": "BTConsolePrint",
|
||
"markers": {}
|
||
},
|
||
"BT action task that outputs text to the console.\u0000{}": {
|
||
"uid": 953,
|
||
"tpl": "BT action task that outputs text to the console.",
|
||
"markers": {}
|
||
},
|
||
"BTConsolePrint action outputs text to the console and returns <1/>. It can include placeholders for format arguments similar to GDScript’s % operator.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 954,
|
||
"tpl": "BTConsolePrint action outputs text to the console and returns <1/>. It can include placeholders for format arguments similar to GDScript’s % operator.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"<l1>bb_format_parameters</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btconsoleprint-property-bb-format-parameters\\\"><span class=\\\"std std-ref\\\">bb_format_parameters</span></a>\"}": {
|
||
"uid": 955,
|
||
"tpl": "<l1>bb_format_parameters</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btconsoleprint-property-bb-format-parameters\"><span class=\"std std-ref\">bb_format_parameters</span></a>"
|
||
}
|
||
},
|
||
"<l1>text</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btconsoleprint-property-text\\\"><span class=\\\"std std-ref\\\">text</span></a>\"}": {
|
||
"uid": 956,
|
||
"tpl": "<l1>text</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btconsoleprint-property-text\"><span class=\"std std-ref\">text</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>bb_format_parameters</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray()</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btconsoleprint-property-bb-format-parameters\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 957,
|
||
"tpl": "<1/> <b>bb_format_parameters</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray()</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btconsoleprint-property-bb-format-parameters\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_bb_format_parameters</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\"}": {
|
||
"uid": 958,
|
||
"tpl": "<1/> <b>set_bb_format_parameters</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_bb_format_parameters</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\"}": {
|
||
"uid": 959,
|
||
"tpl": "<1/> <b>get_bb_format_parameters</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>"
|
||
}
|
||
},
|
||
"The values of format parameters are used as format arguments for the text that will be printed.\u0000{}": {
|
||
"uid": 960,
|
||
"tpl": "The values of format parameters are used as format arguments for the text that will be printed.",
|
||
"markers": {}
|
||
},
|
||
"<b>Note:</b> The returned array is <i>copied</i> and any changes to it will not update the original property value. See <1/> for more details.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\"}": {
|
||
"uid": 961,
|
||
"tpl": "<b>Note:</b> The returned array is <i>copied</i> and any changes to it will not update the original property value. See <1/> for more details.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>text</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btconsoleprint-property-text\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 962,
|
||
"tpl": "<1/> <b>text</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btconsoleprint-property-text\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_text</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 963,
|
||
"tpl": "<1/> <b>set_text</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_text</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 964,
|
||
"tpl": "<1/> <b>get_text</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"The text to be printed, which can include multiple placeholders to be substituted with format arguments. These placeholders follow the same format as GDScript’s % operator and typically start with ‘%’ followed by a format specifier. For instance: %s for string, %d for integer, %f for real.\u0000{}": {
|
||
"uid": 965,
|
||
"tpl": "The text to be printed, which can include multiple placeholders to be substituted with format arguments. These placeholders follow the same format as GDScript’s % operator and typically start with ‘%’ followed by a format specifier. For instance: %s for string, %d for integer, %f for real.",
|
||
"markers": {}
|
||
},
|
||
"BTCooldown\u0000{}": {
|
||
"uid": 966,
|
||
"tpl": "BTCooldown",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that executes its child task only if <l1>duration</l> time has passed since the previous execution.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-duration\\\"><span class=\\\"std std-ref\\\">duration</span></a>\"}": {
|
||
"uid": 967,
|
||
"tpl": "BT decorator that executes its child task only if <l1>duration</l> time has passed since the previous execution.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcooldown-property-duration\"><span class=\"std std-ref\">duration</span></a>"
|
||
}
|
||
},
|
||
"BTCooldown runs its child task only if <l1>duration</l> time has passed since the last successful child task execution. It will only consider successful executions unless <l2>trigger_on_failure</l> is set to <3/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-duration\\\"><span class=\\\"std std-ref\\\">duration</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-trigger-on-failure\\\"><span class=\\\"std std-ref\\\">trigger_on_failure</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 968,
|
||
"tpl": "BTCooldown runs its child task only if <l1>duration</l> time has passed since the last successful child task execution. It will only consider successful executions unless <l2>trigger_on_failure</l> is set to <3/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcooldown-property-duration\"><span class=\"std std-ref\">duration</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btcooldown-property-trigger-on-failure\"><span class=\"std std-ref\">trigger_on_failure</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/>, if the child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 969,
|
||
"tpl": "Returns <1/>, if the child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/>, if the child task results in <2/>, and triggers the cooldown timer.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 970,
|
||
"tpl": "Returns <1/>, if the child task results in <2/>, and triggers the cooldown timer.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/>, if the child task results in <2/> or if <l3>duration</l> time didn’t pass since the previous execution.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-duration\\\"><span class=\\\"std std-ref\\\">duration</span></a>\"}": {
|
||
"uid": 971,
|
||
"tpl": "Returns <1/>, if the child task results in <2/> or if <l3>duration</l> time didn’t pass since the previous execution.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcooldown-property-duration\"><span class=\"std std-ref\">duration</span></a>"
|
||
}
|
||
},
|
||
"<l1>cooldown_state_var</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-cooldown-state-var\\\"><span class=\\\"std std-ref\\\">cooldown_state_var</span></a>\"}": {
|
||
"uid": 972,
|
||
"tpl": "<l1>cooldown_state_var</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcooldown-property-cooldown-state-var\"><span class=\"std std-ref\">cooldown_state_var</span></a>"
|
||
}
|
||
},
|
||
"<l1>duration</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-duration\\\"><span class=\\\"std std-ref\\\">duration</span></a>\"}": {
|
||
"uid": 973,
|
||
"tpl": "<l1>duration</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcooldown-property-duration\"><span class=\"std std-ref\">duration</span></a>"
|
||
}
|
||
},
|
||
"<l1>process_pause</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-process-pause\\\"><span class=\\\"std std-ref\\\">process_pause</span></a>\"}": {
|
||
"uid": 974,
|
||
"tpl": "<l1>process_pause</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcooldown-property-process-pause\"><span class=\"std std-ref\">process_pause</span></a>"
|
||
}
|
||
},
|
||
"<l1>start_cooled</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-start-cooled\\\"><span class=\\\"std std-ref\\\">start_cooled</span></a>\"}": {
|
||
"uid": 975,
|
||
"tpl": "<l1>start_cooled</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcooldown-property-start-cooled\"><span class=\"std std-ref\">start_cooled</span></a>"
|
||
}
|
||
},
|
||
"<l1>trigger_on_failure</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-trigger-on-failure\\\"><span class=\\\"std std-ref\\\">trigger_on_failure</span></a>\"}": {
|
||
"uid": 976,
|
||
"tpl": "<l1>trigger_on_failure</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btcooldown-property-trigger-on-failure\"><span class=\"std std-ref\">trigger_on_failure</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>cooldown_state_var</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-cooldown-state-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 977,
|
||
"tpl": "<1/> <b>cooldown_state_var</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcooldown-property-cooldown-state-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_cooldown_state_var</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 978,
|
||
"tpl": "<1/> <b>set_cooldown_state_var</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_cooldown_state_var</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 979,
|
||
"tpl": "<1/> <b>get_cooldown_state_var</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"A boolean variable used to store the cooldown state in the <l1>Blackboard</l>. If left empty, the variable will be automatically generated and assigned.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 980,
|
||
"tpl": "A boolean variable used to store the cooldown state in the <l1>Blackboard</l>. If left empty, the variable will be automatically generated and assigned.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"If the variable’s value is set to <1/>, it indicates that the cooldown is activated. This feature is useful for checking the cooldown state from other parts of the tree or sharing it among different sections of the <l2>BehaviorTree</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 981,
|
||
"tpl": "If the variable’s value is set to <1/>, it indicates that the cooldown is activated. This feature is useful for checking the cooldown state from other parts of the tree or sharing it among different sections of the <l2>BehaviorTree</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>duration</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">10.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-duration\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 982,
|
||
"tpl": "<1/> <b>duration</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">10.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcooldown-property-duration\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_duration</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 983,
|
||
"tpl": "<1/> <b>set_duration</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_duration</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 984,
|
||
"tpl": "<1/> <b>get_duration</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Time to wait before permitting another child’s execution.\u0000{}": {
|
||
"uid": 985,
|
||
"tpl": "Time to wait before permitting another child’s execution.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>process_pause</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-process-pause\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 986,
|
||
"tpl": "<1/> <b>process_pause</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcooldown-property-process-pause\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_process_pause</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 987,
|
||
"tpl": "<1/> <b>set_process_pause</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_process_pause</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 988,
|
||
"tpl": "<1/> <b>get_process_pause</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, process cooldown when the <2/> is paused.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SceneTree</span></code>\"}": {
|
||
"uid": 989,
|
||
"tpl": "If <1/>, process cooldown when the <2/> is paused.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SceneTree</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>start_cooled</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-start-cooled\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 990,
|
||
"tpl": "<1/> <b>start_cooled</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcooldown-property-start-cooled\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_start_cooled</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 991,
|
||
"tpl": "<1/> <b>set_start_cooled</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_start_cooled</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 992,
|
||
"tpl": "<1/> <b>get_start_cooled</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, initiate a cooldown as if the child had been executed before the first BT tick.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 993,
|
||
"tpl": "If <1/>, initiate a cooldown as if the child had been executed before the first BT tick.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>trigger_on_failure</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btcooldown-property-trigger-on-failure\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 994,
|
||
"tpl": "<1/> <b>trigger_on_failure</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btcooldown-property-trigger-on-failure\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_trigger_on_failure</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 995,
|
||
"tpl": "<1/> <b>set_trigger_on_failure</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_trigger_on_failure</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 996,
|
||
"tpl": "<1/> <b>get_trigger_on_failure</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, the cooldown will be activated if the child task also returns <2/>. Otherwise, the cooldown will only be triggered when the child task returns <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 997,
|
||
"tpl": "If <1/>, the cooldown will be activated if the child task also returns <2/>. Otherwise, the cooldown will only be triggered when the child task returns <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTDecorator\u0000{}": {
|
||
"uid": 998,
|
||
"tpl": "BTDecorator",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTAlwaysFail</l>, <l2>BTAlwaysSucceed</l>, <l3>BTCooldown</l>, <l4>BTDelay</l>, <l5>BTForEach</l>, <l6>BTInvert</l>, <l7>BTNewScope</l>, <l8>BTProbability</l>, <l9>BTRepeat</l>, <l10>BTRepeatUntilFailure</l>, <l11>BTRepeatUntilSuccess</l>, <l12>BTRunLimit</l>, <l13>BTTimeLimit</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btalwaysfail#class-btalwaysfail\\\"><span class=\\\"std std-ref\\\">BTAlwaysFail</span></a>\", \"10\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrepeatuntilfailure#class-btrepeatuntilfailure\\\"><span class=\\\"std std-ref\\\">BTRepeatUntilFailure</span></a>\", \"11\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrepeatuntilsuccess#class-btrepeatuntilsuccess\\\"><span class=\\\"std std-ref\\\">BTRepeatUntilSuccess</span></a>\", \"12\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrunlimit#class-btrunlimit\\\"><span class=\\\"std std-ref\\\">BTRunLimit</span></a>\", \"13\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttimelimit#class-bttimelimit\\\"><span class=\\\"std std-ref\\\">BTTimeLimit</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btalwayssucceed#class-btalwayssucceed\\\"><span class=\\\"std std-ref\\\">BTAlwaysSucceed</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcooldown#class-btcooldown\\\"><span class=\\\"std std-ref\\\">BTCooldown</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdelay#class-btdelay\\\"><span class=\\\"std std-ref\\\">BTDelay</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btforeach#class-btforeach\\\"><span class=\\\"std std-ref\\\">BTForEach</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinvert#class-btinvert\\\"><span class=\\\"std std-ref\\\">BTInvert</span></a>\", \"7\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btnewscope#class-btnewscope\\\"><span class=\\\"std std-ref\\\">BTNewScope</span></a>\", \"8\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btprobability#class-btprobability\\\"><span class=\\\"std std-ref\\\">BTProbability</span></a>\", \"9\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrepeat#class-btrepeat\\\"><span class=\\\"std std-ref\\\">BTRepeat</span></a>\"}": {
|
||
"uid": 999,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTAlwaysFail</l>, <l2>BTAlwaysSucceed</l>, <l3>BTCooldown</l>, <l4>BTDelay</l>, <l5>BTForEach</l>, <l6>BTInvert</l>, <l7>BTNewScope</l>, <l8>BTProbability</l>, <l9>BTRepeat</l>, <l10>BTRepeatUntilFailure</l>, <l11>BTRepeatUntilSuccess</l>, <l12>BTRunLimit</l>, <l13>BTTimeLimit</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btalwaysfail#class-btalwaysfail\"><span class=\"std std-ref\">BTAlwaysFail</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btalwayssucceed#class-btalwayssucceed\"><span class=\"std std-ref\">BTAlwaysSucceed</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btcooldown#class-btcooldown\"><span class=\"std std-ref\">BTCooldown</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btdelay#class-btdelay\"><span class=\"std std-ref\">BTDelay</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btforeach#class-btforeach\"><span class=\"std std-ref\">BTForEach</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_btinvert#class-btinvert\"><span class=\"std std-ref\">BTInvert</span></a>",
|
||
"7": "<a class=\"reference internal\" href=\"#document-classes/class_btnewscope#class-btnewscope\"><span class=\"std std-ref\">BTNewScope</span></a>",
|
||
"8": "<a class=\"reference internal\" href=\"#document-classes/class_btprobability#class-btprobability\"><span class=\"std std-ref\">BTProbability</span></a>",
|
||
"9": "<a class=\"reference internal\" href=\"#document-classes/class_btrepeat#class-btrepeat\"><span class=\"std std-ref\">BTRepeat</span></a>",
|
||
"10": "<a class=\"reference internal\" href=\"#document-classes/class_btrepeatuntilfailure#class-btrepeatuntilfailure\"><span class=\"std std-ref\">BTRepeatUntilFailure</span></a>",
|
||
"11": "<a class=\"reference internal\" href=\"#document-classes/class_btrepeatuntilsuccess#class-btrepeatuntilsuccess\"><span class=\"std std-ref\">BTRepeatUntilSuccess</span></a>",
|
||
"12": "<a class=\"reference internal\" href=\"#document-classes/class_btrunlimit#class-btrunlimit\"><span class=\"std std-ref\">BTRunLimit</span></a>",
|
||
"13": "<a class=\"reference internal\" href=\"#document-classes/class_bttimelimit#class-bttimelimit\"><span class=\"std std-ref\">BTTimeLimit</span></a>"
|
||
}
|
||
},
|
||
"Base class for BT decorators.\u0000{}": {
|
||
"uid": 1000,
|
||
"tpl": "Base class for BT decorators.",
|
||
"markers": {}
|
||
},
|
||
"Base class for all <l1>BehaviorTree</l> decorators. You can create your own decorators by extending the BTDecorator class.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1001,
|
||
"tpl": "Base class for all <l1>BehaviorTree</l> decorators. You can create your own decorators by extending the BTDecorator class.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"A decorator is a task within a <l1>BehaviorTree</l> that alters the behavior of its child task. Decorators can have only one child task.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1002,
|
||
"tpl": "A decorator is a task within a <l1>BehaviorTree</l> that alters the behavior of its child task. Decorators can have only one child task.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Decorators can be used to add conditions, limits, or other constraints to the execution of a task. Examples of <l1>BehaviorTree</l> decorators include <l2>BTInvert</l>, <l3>BTRepeat</l>, and <l4>BTCooldown</l>. The use of <l5>BehaviorTree</l> decorators can simplify the design and implementation of complex behaviors by adding additional logic to existing tasks.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btinvert#class-btinvert\\\"><span class=\\\"std std-ref\\\">BTInvert</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btrepeat#class-btrepeat\\\"><span class=\\\"std std-ref\\\">BTRepeat</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcooldown#class-btcooldown\\\"><span class=\\\"std std-ref\\\">BTCooldown</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1003,
|
||
"tpl": "Decorators can be used to add conditions, limits, or other constraints to the execution of a task. Examples of <l1>BehaviorTree</l> decorators include <l2>BTInvert</l>, <l3>BTRepeat</l>, and <l4>BTCooldown</l>. The use of <l5>BehaviorTree</l> decorators can simplify the design and implementation of complex behaviors by adding additional logic to existing tasks.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btinvert#class-btinvert\"><span class=\"std std-ref\">BTInvert</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btrepeat#class-btrepeat\"><span class=\"std std-ref\">BTRepeat</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btcooldown#class-btcooldown\"><span class=\"std std-ref\">BTCooldown</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"BTDelay\u0000{}": {
|
||
"uid": 1004,
|
||
"tpl": "BTDelay",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that introduces a delay before executing its child task.\u0000{}": {
|
||
"uid": 1005,
|
||
"tpl": "BT decorator that introduces a delay before executing its child task.",
|
||
"markers": {}
|
||
},
|
||
"BTDelay introduces a delay of <l1>seconds</l> before executing its child task. Returns <2/> during the delay period.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btdelay-property-seconds\\\"><span class=\\\"std std-ref\\\">seconds</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1006,
|
||
"tpl": "BTDelay introduces a delay of <l1>seconds</l> before executing its child task. Returns <2/> during the delay period.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btdelay-property-seconds\"><span class=\"std std-ref\">seconds</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"<l1>seconds</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btdelay-property-seconds\\\"><span class=\\\"std std-ref\\\">seconds</span></a>\"}": {
|
||
"uid": 1007,
|
||
"tpl": "<l1>seconds</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btdelay-property-seconds\"><span class=\"std std-ref\">seconds</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>seconds</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btdelay-property-seconds\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1008,
|
||
"tpl": "<1/> <b>seconds</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btdelay-property-seconds\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_seconds</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1009,
|
||
"tpl": "<1/> <b>set_seconds</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_seconds</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1010,
|
||
"tpl": "<1/> <b>get_seconds</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Delay duration in seconds.\u0000{}": {
|
||
"uid": 1011,
|
||
"tpl": "Delay duration in seconds.",
|
||
"markers": {}
|
||
},
|
||
"BTDynamicSelector\u0000{}": {
|
||
"uid": 1012,
|
||
"tpl": "BTDynamicSelector",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BTComposite</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcomposite#class-btcomposite\\\"><span class=\\\"std std-ref\\\">BTComposite</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#class-bt\\\"><span class=\\\"std std-ref\\\">BT</span></a>\"}": {
|
||
"uid": 1013,
|
||
"tpl": "<b>Inherits:</b> <l1>BTComposite</l> <b><</b> <l2>BTTask</l> <b><</b> <l3>BT</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btcomposite#class-btcomposite\"><span class=\"std std-ref\">BTComposite</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bt#class-bt\"><span class=\"std std-ref\">BT</span></a>"
|
||
}
|
||
},
|
||
"BT composite that executes tasks from scratch every tick until first <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1014,
|
||
"tpl": "BT composite that executes tasks from scratch every tick until first <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTDynamicSelector executes its child tasks sequentially, from first to last, until any child returns <1/>. Unlike <l2>BTSelector</l>, it will execute tasks from the beginning every tick, reevaluating their statuses. It is quite useful when you want to retry higher-priority behaviors in every tick.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">BTSelector</span></a>\"}": {
|
||
"uid": 1015,
|
||
"tpl": "BTDynamicSelector executes its child tasks sequentially, from first to last, until any child returns <1/>. Unlike <l2>BTSelector</l>, it will execute tasks from the beginning every tick, reevaluating their statuses. It is quite useful when you want to retry higher-priority behaviors in every tick.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">BTSelector</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if a child task results in <2/>. BTDynamicSelector will remember the last <3/> child, but, unlike <l4>BTSequence</l>, on the next execution tick, it will reexecute preceding tasks and reevaluate their return statuses. If any of the preceding tasks doesn’t result in <5/>, it will abort the remembered <6/> task.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"6\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1016,
|
||
"tpl": "Returns <1/> if a child task results in <2/>. BTDynamicSelector will remember the last <3/> child, but, unlike <l4>BTSequence</l>, on the next execution tick, it will reexecute preceding tasks and reevaluate their return statuses. If any of the preceding tasks doesn’t result in <5/>, it will abort the remembered <6/> task.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"6": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if all child tasks result in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1017,
|
||
"tpl": "Returns <1/> if all child tasks result in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if a child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1018,
|
||
"tpl": "Returns <1/> if a child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTDynamicSequence\u0000{}": {
|
||
"uid": 1019,
|
||
"tpl": "BTDynamicSequence",
|
||
"markers": {}
|
||
},
|
||
"BT composite that executes tasks from scratch every tick as long as they return <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1020,
|
||
"tpl": "BT composite that executes tasks from scratch every tick as long as they return <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTDynamicSequence executes its child tasks sequentially, from first to last, for as long as they return <1/>. Unlike <l2>BTSequence</l>, it will execute tasks from the beginning every tick, reevaluating their statuses. It is quite useful when you want to recheck conditions preceding a long-running action during each tick and abort the <3/> action when any condition results in <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1021,
|
||
"tpl": "BTDynamicSequence executes its child tasks sequentially, from first to last, for as long as they return <1/>. Unlike <l2>BTSequence</l>, it will execute tasks from the beginning every tick, reevaluating their statuses. It is quite useful when you want to recheck conditions preceding a long-running action during each tick and abort the <3/> action when any condition results in <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if a child task results in <2/>. BTDynamicSequence will remember the last <3/> child, but, unlike <l4>BTSequence</l>, on the next execution tick, it will reexecute preceding tasks and reevaluate their return statuses. If any of the preceding tasks doesn’t result in <5/>, it will abort the remembered <6/> task.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"6\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1022,
|
||
"tpl": "Returns <1/> if a child task results in <2/>. BTDynamicSequence will remember the last <3/> child, but, unlike <l4>BTSequence</l>, on the next execution tick, it will reexecute preceding tasks and reevaluate their return statuses. If any of the preceding tasks doesn’t result in <5/>, it will abort the remembered <6/> task.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"6": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if a child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1023,
|
||
"tpl": "Returns <1/> if a child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if all child tasks result in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1024,
|
||
"tpl": "Returns <1/> if all child tasks result in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTEvaluateExpression\u0000{}": {
|
||
"uid": 1025,
|
||
"tpl": "BTEvaluateExpression",
|
||
"markers": {}
|
||
},
|
||
"BT action that evaluates an <1/> against a specified <2/> or <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Expression</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\"}": {
|
||
"uid": 1026,
|
||
"tpl": "BT action that evaluates an <1/> against a specified <2/> or <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Expression</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>"
|
||
}
|
||
},
|
||
"BTEvaluateExpression action evaluates an <l1>expression_string</l> on the specified <2/> or <3/> instance and returns <4/> when the <5/> executes successfully.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-expression-string\\\"><span class=\\\"std std-ref\\\">expression_string</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Object</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Expression</span></code>\"}": {
|
||
"uid": 1027,
|
||
"tpl": "BTEvaluateExpression action evaluates an <l1>expression_string</l> on the specified <2/> or <3/> instance and returns <4/> when the <5/> executes successfully.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-expression-string\"><span class=\"std std-ref\">expression_string</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Object</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Expression</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the action encounters an issue during the <2/> parsing or execution.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Expression</span></code>\"}": {
|
||
"uid": 1028,
|
||
"tpl": "Returns <1/> if the action encounters an issue during the <2/> parsing or execution.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Expression</span></code>"
|
||
}
|
||
},
|
||
"<l1>expression_string</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-expression-string\\\"><span class=\\\"std std-ref\\\">expression_string</span></a>\"}": {
|
||
"uid": 1029,
|
||
"tpl": "<l1>expression_string</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-expression-string\"><span class=\"std std-ref\">expression_string</span></a>"
|
||
}
|
||
},
|
||
"<l1>input_include_delta</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-include-delta\\\"><span class=\\\"std std-ref\\\">input_include_delta</span></a>\"}": {
|
||
"uid": 1030,
|
||
"tpl": "<l1>input_include_delta</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-include-delta\"><span class=\"std std-ref\">input_include_delta</span></a>"
|
||
}
|
||
},
|
||
"<l1>input_names</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-names\\\"><span class=\\\"std std-ref\\\">input_names</span></a>\"}": {
|
||
"uid": 1031,
|
||
"tpl": "<l1>input_names</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-names\"><span class=\"std std-ref\">input_names</span></a>"
|
||
}
|
||
},
|
||
"<l1>input_values</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-values\\\"><span class=\\\"std std-ref\\\">input_values</span></a>\"}": {
|
||
"uid": 1032,
|
||
"tpl": "<l1>input_values</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-values\"><span class=\"std std-ref\">input_values</span></a>"
|
||
}
|
||
},
|
||
"<l1>node</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-node\\\"><span class=\\\"std std-ref\\\">node</span></a>\"}": {
|
||
"uid": 1033,
|
||
"tpl": "<l1>node</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-node\"><span class=\"std std-ref\">node</span></a>"
|
||
}
|
||
},
|
||
"<l1>result_var</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-result-var\\\"><span class=\\\"std std-ref\\\">result_var</span></a>\"}": {
|
||
"uid": 1034,
|
||
"tpl": "<l1>result_var</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-result-var\"><span class=\"std std-ref\">result_var</span></a>"
|
||
}
|
||
},
|
||
"Error\u0000{}": {
|
||
"uid": 1035,
|
||
"tpl": "Error",
|
||
"markers": {}
|
||
},
|
||
"<l1>parse</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-method-parse\\\"><span class=\\\"std std-ref\\\">parse</span></a>\"}": {
|
||
"uid": 1036,
|
||
"tpl": "<l1>parse</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-method-parse\"><span class=\"std std-ref\">parse</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>expression_string</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-expression-string\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1037,
|
||
"tpl": "<1/> <b>expression_string</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-expression-string\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_expression_string</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 1038,
|
||
"tpl": "<1/> <b>set_expression_string</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_expression_string</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\"}": {
|
||
"uid": 1039,
|
||
"tpl": "<1/> <b>get_expression_string</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>"
|
||
}
|
||
},
|
||
"The expression string to be parsed and executed.\u0000{}": {
|
||
"uid": 1040,
|
||
"tpl": "The expression string to be parsed and executed.",
|
||
"markers": {}
|
||
},
|
||
"<b>Warning:</b> Call <l1>parse</l> after updating <l2>expression_string</l> to update the internal <3/> as it won’t be updated automatically.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-method-parse\\\"><span class=\\\"std std-ref\\\">parse</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-expression-string\\\"><span class=\\\"std std-ref\\\">expression_string</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Expression</span></code>\"}": {
|
||
"uid": 1041,
|
||
"tpl": "<b>Warning:</b> Call <l1>parse</l> after updating <l2>expression_string</l> to update the internal <3/> as it won’t be updated automatically.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-method-parse\"><span class=\"std std-ref\">parse</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-expression-string\"><span class=\"std std-ref\">expression_string</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Expression</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>input_include_delta</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-include-delta\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1042,
|
||
"tpl": "<1/> <b>input_include_delta</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-include-delta\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_input_include_delta</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1043,
|
||
"tpl": "<1/> <b>set_input_include_delta</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>is_input_delta_included</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1044,
|
||
"tpl": "<1/> <b>is_input_delta_included</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If enabled, the input variable <1/> will be added to <l2>input_names</l> and <l3>input_values</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">delta</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-names\\\"><span class=\\\"std std-ref\\\">input_names</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-values\\\"><span class=\\\"std std-ref\\\">input_values</span></a>\"}": {
|
||
"uid": 1045,
|
||
"tpl": "If enabled, the input variable <1/> will be added to <l2>input_names</l> and <l3>input_values</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">delta</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-names\"><span class=\"std std-ref\">input_names</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-values\"><span class=\"std std-ref\">input_values</span></a>"
|
||
}
|
||
},
|
||
"<b>Warning:</b> Call <l1>parse</l> after toggling <l2>input_include_delta</l> to update the internal <3/> as it won’t be updated automatically.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-method-parse\\\"><span class=\\\"std std-ref\\\">parse</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-include-delta\\\"><span class=\\\"std std-ref\\\">input_include_delta</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Expression</span></code>\"}": {
|
||
"uid": 1046,
|
||
"tpl": "<b>Warning:</b> Call <l1>parse</l> after toggling <l2>input_include_delta</l> to update the internal <3/> as it won’t be updated automatically.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-method-parse\"><span class=\"std std-ref\">parse</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-include-delta\"><span class=\"std std-ref\">input_include_delta</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Expression</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>input_names</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray()</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-names\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1047,
|
||
"tpl": "<1/> <b>input_names</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray()</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-names\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_input_names</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\"}": {
|
||
"uid": 1048,
|
||
"tpl": "<1/> <b>set_input_names</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_input_names</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">PackedStringArray</span></code>\"}": {
|
||
"uid": 1049,
|
||
"tpl": "<1/> <b>get_input_names</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">PackedStringArray</span></code>"
|
||
}
|
||
},
|
||
"List of variable names within <l1>expression_string</l> for which the user will provide values for through <l2>input_values</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-expression-string\\\"><span class=\\\"std std-ref\\\">expression_string</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-values\\\"><span class=\\\"std std-ref\\\">input_values</span></a>\"}": {
|
||
"uid": 1050,
|
||
"tpl": "List of variable names within <l1>expression_string</l> for which the user will provide values for through <l2>input_values</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-expression-string\"><span class=\"std std-ref\">expression_string</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-values\"><span class=\"std std-ref\">input_values</span></a>"
|
||
}
|
||
},
|
||
"<b>Warning:</b> Call <l1>parse</l> after updating <l2>input_names</l> to update the internal <3/> as it won’t be updated automatically.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-method-parse\\\"><span class=\\\"std std-ref\\\">parse</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-names\\\"><span class=\\\"std std-ref\\\">input_names</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Expression</span></code>\"}": {
|
||
"uid": 1051,
|
||
"tpl": "<b>Warning:</b> Call <l1>parse</l> after updating <l2>input_names</l> to update the internal <3/> as it won’t be updated automatically.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-method-parse\"><span class=\"std std-ref\">parse</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-names\"><span class=\"std std-ref\">input_names</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Expression</span></code>"
|
||
}
|
||
},
|
||
"Array[<l1>BBVariant</l>] <b>input_values</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">[]</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-values\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1052,
|
||
"tpl": "Array[<l1>BBVariant</l>] <b>input_values</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">[]</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-values\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_input_values</b>(value: Array[<l2>BBVariant</l>])\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 1053,
|
||
"tpl": "<1/> <b>set_input_values</b>(value: Array[<l2>BBVariant</l>])",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"Array[<l1>BBVariant</l>] <b>get_input_values</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\"}": {
|
||
"uid": 1054,
|
||
"tpl": "Array[<l1>BBVariant</l>] <b>get_input_values</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>"
|
||
}
|
||
},
|
||
"List of values for variables specified in <l1>input_names</l>. The values are mapped to the variables by their array index.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-names\\\"><span class=\\\"std std-ref\\\">input_names</span></a>\"}": {
|
||
"uid": 1055,
|
||
"tpl": "List of values for variables specified in <l1>input_names</l>. The values are mapped to the variables by their array index.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-names\"><span class=\"std std-ref\">input_names</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l> <b>node</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-node\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1056,
|
||
"tpl": "<l1>BBNode</l> <b>node</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-node\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>result_var</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-result-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1057,
|
||
"tpl": "<1/> <b>result_var</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-result-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Error <b>parse</b>() <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-method-parse\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1058,
|
||
"tpl": "Error <b>parse</b>() <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-method-parse\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Calls Expression.parse considering <l1>input_include_delta</l> and <l2>input_names</l> and returns its error code.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-include-delta\\\"><span class=\\\"std std-ref\\\">input_include_delta</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btevaluateexpression-property-input-names\\\"><span class=\\\"std std-ref\\\">input_names</span></a>\"}": {
|
||
"uid": 1059,
|
||
"tpl": "Calls Expression.parse considering <l1>input_include_delta</l> and <l2>input_names</l> and returns its error code.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-include-delta\"><span class=\"std std-ref\">input_include_delta</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btevaluateexpression-property-input-names\"><span class=\"std std-ref\">input_names</span></a>"
|
||
}
|
||
},
|
||
"BTFail\u0000{}": {
|
||
"uid": 1060,
|
||
"tpl": "BTFail",
|
||
"markers": {}
|
||
},
|
||
"BT action that always returns <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1061,
|
||
"tpl": "BT action that always returns <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTForEach\u0000{}": {
|
||
"uid": 1062,
|
||
"tpl": "BTForEach",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that executes its child task for each element of an <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Array</span></code>\"}": {
|
||
"uid": 1063,
|
||
"tpl": "BT decorator that executes its child task for each element of an <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Array</span></code>"
|
||
}
|
||
},
|
||
"BTForEach executes its child task for each element of an <1/>. During each iteration, the next element is stored in the specified <l2>Blackboard</l> variable.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Array</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 1064,
|
||
"tpl": "BTForEach executes its child task for each element of an <1/>. During each iteration, the next element is stored in the specified <l2>Blackboard</l> variable.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Array</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/> or if the child task results in <3/> on a non-last iteration.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1065,
|
||
"tpl": "Returns <1/> if the child task results in <2/> or if the child task results in <3/> on a non-last iteration.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1066,
|
||
"tpl": "Returns <1/> if the child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/> on the last iteration.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1067,
|
||
"tpl": "Returns <1/> if the child task results in <2/> on the last iteration.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"<l1>array_var</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btforeach-property-array-var\\\"><span class=\\\"std std-ref\\\">array_var</span></a>\"}": {
|
||
"uid": 1068,
|
||
"tpl": "<l1>array_var</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btforeach-property-array-var\"><span class=\"std std-ref\">array_var</span></a>"
|
||
}
|
||
},
|
||
"<l1>save_var</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btforeach-property-save-var\\\"><span class=\\\"std std-ref\\\">save_var</span></a>\"}": {
|
||
"uid": 1069,
|
||
"tpl": "<l1>save_var</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btforeach-property-save-var\"><span class=\"std std-ref\">save_var</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>array_var</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btforeach-property-array-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1070,
|
||
"tpl": "<1/> <b>array_var</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btforeach-property-array-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_array_var</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 1071,
|
||
"tpl": "<1/> <b>set_array_var</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_array_var</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 1072,
|
||
"tpl": "<1/> <b>get_array_var</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"A variable within the <l1>Blackboard</l> that holds an <2/>, which is used for the iteration process.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Array</span></code>\"}": {
|
||
"uid": 1073,
|
||
"tpl": "A variable within the <l1>Blackboard</l> that holds an <2/>, which is used for the iteration process.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Array</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>save_var</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btforeach-property-save-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1074,
|
||
"tpl": "<1/> <b>save_var</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btforeach-property-save-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_save_var</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 1075,
|
||
"tpl": "<1/> <b>set_save_var</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_save_var</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\"}": {
|
||
"uid": 1076,
|
||
"tpl": "<1/> <b>get_save_var</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>"
|
||
}
|
||
},
|
||
"A <l1>Blackboard</l> variable used to store an element of the array referenced by <l2>array_var</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btforeach-property-array-var\\\"><span class=\\\"std std-ref\\\">array_var</span></a>\"}": {
|
||
"uid": 1077,
|
||
"tpl": "A <l1>Blackboard</l> variable used to store an element of the array referenced by <l2>array_var</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btforeach-property-array-var\"><span class=\"std std-ref\">array_var</span></a>"
|
||
}
|
||
},
|
||
"BTInstance\u0000{}": {
|
||
"uid": 1078,
|
||
"tpl": "BTInstance",
|
||
"markers": {}
|
||
},
|
||
"Represents a runtime instance of a <l1>BehaviorTree</l> resource.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1079,
|
||
"tpl": "Represents a runtime instance of a <l1>BehaviorTree</l> resource.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"Can be created using the <l1>BehaviorTree.instantiate</l> method.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree-method-instantiate\\\"><span class=\\\"std std-ref\\\">BehaviorTree.instantiate</span></a>\"}": {
|
||
"uid": 1080,
|
||
"tpl": "Can be created using the <l1>BehaviorTree.instantiate</l> method.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree-method-instantiate\"><span class=\"std std-ref\">BehaviorTree.instantiate</span></a>"
|
||
}
|
||
},
|
||
"<l1>monitor_performance</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-property-monitor-performance\\\"><span class=\\\"std std-ref\\\">monitor_performance</span></a>\"}": {
|
||
"uid": 1081,
|
||
"tpl": "<l1>monitor_performance</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-property-monitor-performance\"><span class=\"std std-ref\">monitor_performance</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_agent</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-agent\\\"><span class=\\\"std std-ref\\\">get_agent</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1082,
|
||
"tpl": "<l1>get_agent</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-agent\"><span class=\"std std-ref\">get_agent</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_blackboard</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-blackboard\\\"><span class=\\\"std std-ref\\\">get_blackboard</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1083,
|
||
"tpl": "<l1>get_blackboard</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-blackboard\"><span class=\"std std-ref\">get_blackboard</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_last_status</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-last-status\\\"><span class=\\\"std std-ref\\\">get_last_status</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1084,
|
||
"tpl": "<l1>get_last_status</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-last-status\"><span class=\"std std-ref\">get_last_status</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_owner_node</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-owner-node\\\"><span class=\\\"std std-ref\\\">get_owner_node</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1085,
|
||
"tpl": "<l1>get_owner_node</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-owner-node\"><span class=\"std std-ref\">get_owner_node</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_root_task</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-root-task\\\"><span class=\\\"std std-ref\\\">get_root_task</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1086,
|
||
"tpl": "<l1>get_root_task</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-root-task\"><span class=\"std std-ref\">get_root_task</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_source_bt_path</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-source-bt-path\\\"><span class=\\\"std std-ref\\\">get_source_bt_path</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1087,
|
||
"tpl": "<l1>get_source_bt_path</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-source-bt-path\"><span class=\"std std-ref\">get_source_bt_path</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>is_instance_valid</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-is-instance-valid\\\"><span class=\\\"std std-ref\\\">is_instance_valid</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1088,
|
||
"tpl": "<l1>is_instance_valid</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-is-instance-valid\"><span class=\"std std-ref\">is_instance_valid</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>register_with_debugger</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-register-with-debugger\\\"><span class=\\\"std std-ref\\\">register_with_debugger</span></a>\"}": {
|
||
"uid": 1089,
|
||
"tpl": "<l1>register_with_debugger</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-register-with-debugger\"><span class=\"std std-ref\">register_with_debugger</span></a>"
|
||
}
|
||
},
|
||
"<l1>unregister_with_debugger</l>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-unregister-with-debugger\\\"><span class=\\\"std std-ref\\\">unregister_with_debugger</span></a>\"}": {
|
||
"uid": 1090,
|
||
"tpl": "<l1>unregister_with_debugger</l>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-unregister-with-debugger\"><span class=\"std std-ref\">unregister_with_debugger</span></a>"
|
||
}
|
||
},
|
||
"<l1>update</l>(delta: <2/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-update\\\"><span class=\\\"std std-ref\\\">update</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1091,
|
||
"tpl": "<l1>update</l>(delta: <2/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-method-update\"><span class=\"std std-ref\">update</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<b>freed</b>() <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-signal-freed\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1092,
|
||
"tpl": "<b>freed</b>() <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btinstance-signal-freed\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the behavior tree instance is freed. Used by debugger to unregister.\u0000{}": {
|
||
"uid": 1093,
|
||
"tpl": "Emitted when the behavior tree instance is freed. Used by debugger to unregister.",
|
||
"markers": {}
|
||
},
|
||
"<b>updated</b>(status: <1/>) <l2>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-signal-updated\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1094,
|
||
"tpl": "<b>updated</b>(status: <1/>) <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btinstance-signal-updated\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Emitted when the behavior tree instance has finished updating.\u0000{}": {
|
||
"uid": 1095,
|
||
"tpl": "Emitted when the behavior tree instance has finished updating.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>monitor_performance</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-property-monitor-performance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1096,
|
||
"tpl": "<1/> <b>monitor_performance</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-property-monitor-performance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"If <1/>, adds a performance monitor for this instance to “Debugger->Monitors” in the editor.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 1097,
|
||
"tpl": "If <1/>, adds a performance monitor for this instance to “Debugger->Monitors” in the editor.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_agent</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-agent\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1098,
|
||
"tpl": "<1/> <b>get_agent</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-agent\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the agent of the behavior tree instance.\u0000{}": {
|
||
"uid": 1099,
|
||
"tpl": "Returns the agent of the behavior tree instance.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Blackboard</l> <b>get_blackboard</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-blackboard\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1100,
|
||
"tpl": "<l1>Blackboard</l> <b>get_blackboard</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-blackboard\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the blackboard of the behavior tree instance.\u0000{}": {
|
||
"uid": 1101,
|
||
"tpl": "Returns the blackboard of the behavior tree instance.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>get_last_status</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-last-status\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1102,
|
||
"tpl": "<l1>Status</l> <b>get_last_status</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-last-status\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the execution status of the last update.\u0000{}": {
|
||
"uid": 1103,
|
||
"tpl": "Returns the execution status of the last update.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_owner_node</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-owner-node\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1104,
|
||
"tpl": "<1/> <b>get_owner_node</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-owner-node\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the scene <1/> that owns this behavior tree instance.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Node</span></code>\"}": {
|
||
"uid": 1105,
|
||
"tpl": "Returns the scene <1/> that owns this behavior tree instance.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Node</span></code>"
|
||
}
|
||
},
|
||
"<l1>BTTask</l> <b>get_root_task</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-root-task\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1106,
|
||
"tpl": "<l1>BTTask</l> <b>get_root_task</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-root-task\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the root task of the behavior tree instance.\u0000{}": {
|
||
"uid": 1107,
|
||
"tpl": "Returns the root task of the behavior tree instance.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_source_bt_path</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-get-source-bt-path\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1108,
|
||
"tpl": "<1/> <b>get_source_bt_path</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-get-source-bt-path\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the file path to the behavior tree resource that was used to create this instance.\u0000{}": {
|
||
"uid": 1109,
|
||
"tpl": "Returns the file path to the behavior tree resource that was used to create this instance.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>is_instance_valid</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-is-instance-valid\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1110,
|
||
"tpl": "<1/> <b>is_instance_valid</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-is-instance-valid\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if the behavior tree instance is properly initialized and can be used.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 1111,
|
||
"tpl": "Returns <1/> if the behavior tree instance is properly initialized and can be used.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>register_with_debugger</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-register-with-debugger\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1112,
|
||
"tpl": "<1/> <b>register_with_debugger</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btinstance-method-register-with-debugger\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Registers the behavior tree instance with the debugger.\u0000{}": {
|
||
"uid": 1113,
|
||
"tpl": "Registers the behavior tree instance with the debugger.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>unregister_with_debugger</b>() <l2>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-unregister-with-debugger\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1114,
|
||
"tpl": "<1/> <b>unregister_with_debugger</b>() <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btinstance-method-unregister-with-debugger\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Unregisters the behavior tree instance from the debugger. This is typically not necessary, as the debugger will automatically unregister the instance when it is freed.\u0000{}": {
|
||
"uid": 1115,
|
||
"tpl": "Unregisters the behavior tree instance from the debugger. This is typically not necessary, as the debugger will automatically unregister the instance when it is freed.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Status</l> <b>update</b>(delta: <2/>) <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#enum-bt-status\\\"><span class=\\\"std std-ref\\\">Status</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btinstance-method-update\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1116,
|
||
"tpl": "<l1>Status</l> <b>update</b>(delta: <2/>) <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bt#enum-bt-status\"><span class=\"std std-ref\">Status</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btinstance-method-update\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Ticks the behavior tree instance and returns its status.\u0000{}": {
|
||
"uid": 1117,
|
||
"tpl": "Ticks the behavior tree instance and returns its status.",
|
||
"markers": {}
|
||
},
|
||
"BTInvert\u0000{}": {
|
||
"uid": 1118,
|
||
"tpl": "BTInvert",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that transforms <1/> into <2/> and <3/> into <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1119,
|
||
"tpl": "BT decorator that transforms <1/> into <2/> and <3/> into <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTInvert transforms <1/> into <2/> and <3/> into <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1120,
|
||
"tpl": "BTInvert transforms <1/> into <2/> and <3/> into <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTNewScope\u0000{}": {
|
||
"uid": 1121,
|
||
"tpl": "BTNewScope",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherited By:</b> <l1>BTSubtree</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsubtree#class-btsubtree\\\"><span class=\\\"std std-ref\\\">BTSubtree</span></a>\"}": {
|
||
"uid": 1122,
|
||
"tpl": "<b>Inherited By:</b> <l1>BTSubtree</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btsubtree#class-btsubtree\"><span class=\"std std-ref\">BTSubtree</span></a>"
|
||
}
|
||
},
|
||
"BT decorator that creates a new <l1>Blackboard</l> scope.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 1123,
|
||
"tpl": "BT decorator that creates a new <l1>Blackboard</l> scope.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"BTNewScope creates a new <l1>Blackboard</l> scope during initialization and populates it with data. See <l2>Blackboard</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 1124,
|
||
"tpl": "BTNewScope creates a new <l1>Blackboard</l> scope during initialization and populates it with data. See <l2>Blackboard</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Returns the status of the child task execution.\u0000{}": {
|
||
"uid": 1125,
|
||
"tpl": "Returns the status of the child task execution.",
|
||
"markers": {}
|
||
},
|
||
"<l1>blackboard_plan</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btnewscope-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">blackboard_plan</span></a>\"}": {
|
||
"uid": 1126,
|
||
"tpl": "<l1>blackboard_plan</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btnewscope-property-blackboard-plan\"><span class=\"std std-ref\">blackboard_plan</span></a>"
|
||
}
|
||
},
|
||
"<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboardplan#class-blackboardplan\\\"><span class=\\\"std std-ref\\\">BlackboardPlan</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btnewscope-property-blackboard-plan\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1127,
|
||
"tpl": "<l1>BlackboardPlan</l> <b>blackboard_plan</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboardplan#class-blackboardplan\"><span class=\"std std-ref\">BlackboardPlan</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btnewscope-property-blackboard-plan\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"BTParallel\u0000{}": {
|
||
"uid": 1128,
|
||
"tpl": "BTParallel",
|
||
"markers": {}
|
||
},
|
||
"BT composite that executes all of its child tasks simultaneously.\u0000{}": {
|
||
"uid": 1129,
|
||
"tpl": "BT composite that executes all of its child tasks simultaneously.",
|
||
"markers": {}
|
||
},
|
||
"BTParallel executes all of its child tasks simultaneously. Note that BTParallel doesn’t involve multithreading. It processes each task sequentially, from first to last, in the same tick before returning a result. If one of the abort criterea is met, any tasks currently <1/> will be terminated, and the result will be either <2/> or <3/>. The <l4>num_failures_required</l> determines when BTParallel fails and <l5>num_successes_required</l> when it succeeds. When both are fullfilled, it gives priority to <l6>num_failures_required</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-num-failures-required\\\"><span class=\\\"std std-ref\\\">num_failures_required</span></a>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-num-successes-required\\\"><span class=\\\"std std-ref\\\">num_successes_required</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-num-failures-required\\\"><span class=\\\"std std-ref\\\">num_failures_required</span></a>\"}": {
|
||
"uid": 1130,
|
||
"tpl": "BTParallel executes all of its child tasks simultaneously. Note that BTParallel doesn’t involve multithreading. It processes each task sequentially, from first to last, in the same tick before returning a result. If one of the abort criterea is met, any tasks currently <1/> will be terminated, and the result will be either <2/> or <3/>. The <l4>num_failures_required</l> determines when BTParallel fails and <l5>num_successes_required</l> when it succeeds. When both are fullfilled, it gives priority to <l6>num_failures_required</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btparallel-property-num-failures-required\"><span class=\"std std-ref\">num_failures_required</span></a>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-btparallel-property-num-successes-required\"><span class=\"std std-ref\">num_successes_required</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#class-btparallel-property-num-failures-required\"><span class=\"std std-ref\">num_failures_required</span></a>"
|
||
}
|
||
},
|
||
"If set to <l1>repeat</l>, all child tasks will be re-executed each tick, regardless of whether they previously resulted in <2/> or <3/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-repeat\\\"><span class=\\\"std std-ref\\\">repeat</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1131,
|
||
"tpl": "If set to <l1>repeat</l>, all child tasks will be re-executed each tick, regardless of whether they previously resulted in <2/> or <3/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btparallel-property-repeat\"><span class=\"std std-ref\">repeat</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> when the required number of child tasks result in <2/>. When <l3>repeat</l> is set to <4/>, if none of the criteria were met and all child tasks resulted in either <5/> or <6/>, BTParallel will return <7/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-repeat\\\"><span class=\\\"std std-ref\\\">repeat</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"6\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"7\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1132,
|
||
"tpl": "Returns <1/> when the required number of child tasks result in <2/>. When <l3>repeat</l> is set to <4/>, if none of the criteria were met and all child tasks resulted in either <5/> or <6/>, BTParallel will return <7/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btparallel-property-repeat\"><span class=\"std std-ref\">repeat</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"6": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"7": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> when the required number of child tasks result in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1133,
|
||
"tpl": "Returns <1/> when the required number of child tasks result in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if none of the criterea were fulfilled, and either <l2>repeat</l> is set to <3/> or a child task resulted in <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-repeat\\\"><span class=\\\"std std-ref\\\">repeat</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1134,
|
||
"tpl": "Returns <1/> if none of the criterea were fulfilled, and either <l2>repeat</l> is set to <3/> or a child task resulted in <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btparallel-property-repeat\"><span class=\"std std-ref\">repeat</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"<l1>num_failures_required</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-num-failures-required\\\"><span class=\\\"std std-ref\\\">num_failures_required</span></a>\"}": {
|
||
"uid": 1135,
|
||
"tpl": "<l1>num_failures_required</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btparallel-property-num-failures-required\"><span class=\"std std-ref\">num_failures_required</span></a>"
|
||
}
|
||
},
|
||
"<l1>num_successes_required</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-num-successes-required\\\"><span class=\\\"std std-ref\\\">num_successes_required</span></a>\"}": {
|
||
"uid": 1136,
|
||
"tpl": "<l1>num_successes_required</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btparallel-property-num-successes-required\"><span class=\"std std-ref\">num_successes_required</span></a>"
|
||
}
|
||
},
|
||
"<l1>repeat</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-repeat\\\"><span class=\\\"std std-ref\\\">repeat</span></a>\"}": {
|
||
"uid": 1137,
|
||
"tpl": "<l1>repeat</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btparallel-property-repeat\"><span class=\"std std-ref\">repeat</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>num_failures_required</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-num-failures-required\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1138,
|
||
"tpl": "<1/> <b>num_failures_required</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btparallel-property-num-failures-required\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_num_failures_required</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1139,
|
||
"tpl": "<1/> <b>set_num_failures_required</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_num_failures_required</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1140,
|
||
"tpl": "<1/> <b>get_num_failures_required</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"If the specified number of child tasks return <1/>, BTParallel will also return <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1141,
|
||
"tpl": "If the specified number of child tasks return <1/>, BTParallel will also return <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>num_successes_required</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-num-successes-required\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1142,
|
||
"tpl": "<1/> <b>num_successes_required</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btparallel-property-num-successes-required\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_num_successes_required</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1143,
|
||
"tpl": "<1/> <b>set_num_successes_required</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_num_successes_required</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1144,
|
||
"tpl": "<1/> <b>get_num_successes_required</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"If the specified number of child tasks return <1/>, BTParallel will also return <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1145,
|
||
"tpl": "If the specified number of child tasks return <1/>, BTParallel will also return <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>repeat</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btparallel-property-repeat\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1146,
|
||
"tpl": "<1/> <b>repeat</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btparallel-property-repeat\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_repeat</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1147,
|
||
"tpl": "<1/> <b>set_repeat</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_repeat</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1148,
|
||
"tpl": "<1/> <b>get_repeat</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"When <1/>, the child tasks will be executed again, regardless of whether they previously resulted in a <2/> or <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1149,
|
||
"tpl": "When <1/>, the child tasks will be executed again, regardless of whether they previously resulted in a <2/> or <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"When <1/>, if none of the criteria were met, and all child tasks resulted in a <2/> or <3/>, BTParallel will return <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1150,
|
||
"tpl": "When <1/>, if none of the criteria were met, and all child tasks resulted in a <2/> or <3/>, BTParallel will return <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTPauseAnimation\u0000{}": {
|
||
"uid": 1151,
|
||
"tpl": "BTPauseAnimation",
|
||
"markers": {}
|
||
},
|
||
"BT action that pauses the playback of an animation on the specified <1/> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 1152,
|
||
"tpl": "BT action that pauses the playback of an animation on the specified <1/> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"BTPauseAnimation action pauses the playback of an animation on the specified <1/> node and returns <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1153,
|
||
"tpl": "BTPauseAnimation action pauses the playback of an animation on the specified <1/> node and returns <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the action fails to get the <2/> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 1154,
|
||
"tpl": "Returns <1/> if the action fails to get the <2/> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"<l1>animation_player</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btpauseanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">animation_player</span></a>\"}": {
|
||
"uid": 1155,
|
||
"tpl": "<l1>animation_player</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btpauseanimation-property-animation-player\"><span class=\"std std-ref\">animation_player</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btpauseanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1156,
|
||
"tpl": "<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btpauseanimation-property-animation-player\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"BTPlayAnimation\u0000{}": {
|
||
"uid": 1157,
|
||
"tpl": "BTPlayAnimation",
|
||
"markers": {}
|
||
},
|
||
"BT action that plays an animation on the specified <1/> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 1158,
|
||
"tpl": "BT action that plays an animation on the specified <1/> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"BTPlayAnimation action plays an animation on the specified <1/> node. If the <l2>await_completion</l> is greater than <3/>, the action will wait for the animation to complete, with the maximum waiting time equal to <l4>await_completion</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-await-completion\\\"><span class=\\\"std std-ref\\\">await_completion</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-await-completion\\\"><span class=\\\"std std-ref\\\">await_completion</span></a>\"}": {
|
||
"uid": 1159,
|
||
"tpl": "BTPlayAnimation action plays an animation on the specified <1/> node. If the <l2>await_completion</l> is greater than <3/>, the action will wait for the animation to complete, with the maximum waiting time equal to <l4>await_completion</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-await-completion\"><span class=\"std std-ref\">await_completion</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-await-completion\"><span class=\"std std-ref\">await_completion</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if the animation finishes playing or if the elapsed time exceeds <l2>await_completion</l>. When <l3>await_completion</l> is set to <4/>, BTPlayAnimation doesn’t wait for the animation to finish and immediately returns <5/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-await-completion\\\"><span class=\\\"std std-ref\\\">await_completion</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-await-completion\\\"><span class=\\\"std std-ref\\\">await_completion</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1160,
|
||
"tpl": "Returns <1/> if the animation finishes playing or if the elapsed time exceeds <l2>await_completion</l>. When <l3>await_completion</l> is set to <4/>, BTPlayAnimation doesn’t wait for the animation to finish and immediately returns <5/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-await-completion\"><span class=\"std std-ref\">await_completion</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-await-completion\"><span class=\"std std-ref\">await_completion</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the animation is still playing and the elapsed time is less than <l2>await_completion</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-await-completion\\\"><span class=\\\"std std-ref\\\">await_completion</span></a>\"}": {
|
||
"uid": 1161,
|
||
"tpl": "Returns <1/> if the animation is still playing and the elapsed time is less than <l2>await_completion</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-await-completion\"><span class=\"std std-ref\">await_completion</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if the action fails to play the requested animation.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1162,
|
||
"tpl": "Returns <1/> if the action fails to play the requested animation.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<l1>animation_name</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-animation-name\\\"><span class=\\\"std std-ref\\\">animation_name</span></a>\"}": {
|
||
"uid": 1163,
|
||
"tpl": "<l1>animation_name</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-animation-name\"><span class=\"std std-ref\">animation_name</span></a>"
|
||
}
|
||
},
|
||
"<l1>animation_player</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">animation_player</span></a>\"}": {
|
||
"uid": 1164,
|
||
"tpl": "<l1>animation_player</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-animation-player\"><span class=\"std std-ref\">animation_player</span></a>"
|
||
}
|
||
},
|
||
"<l1>await_completion</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-await-completion\\\"><span class=\\\"std std-ref\\\">await_completion</span></a>\"}": {
|
||
"uid": 1165,
|
||
"tpl": "<l1>await_completion</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-await-completion\"><span class=\"std std-ref\">await_completion</span></a>"
|
||
}
|
||
},
|
||
"<l1>blend</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-blend\\\"><span class=\\\"std std-ref\\\">blend</span></a>\"}": {
|
||
"uid": 1166,
|
||
"tpl": "<l1>blend</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-blend\"><span class=\"std std-ref\">blend</span></a>"
|
||
}
|
||
},
|
||
"<l1>from_end</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-from-end\\\"><span class=\\\"std std-ref\\\">from_end</span></a>\"}": {
|
||
"uid": 1167,
|
||
"tpl": "<l1>from_end</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-from-end\"><span class=\"std std-ref\">from_end</span></a>"
|
||
}
|
||
},
|
||
"<l1>speed</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-speed\\\"><span class=\\\"std std-ref\\\">speed</span></a>\"}": {
|
||
"uid": 1168,
|
||
"tpl": "<l1>speed</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-speed\"><span class=\"std std-ref\">speed</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>animation_name</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-animation-name\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1169,
|
||
"tpl": "<1/> <b>animation_name</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-animation-name\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Animation’s key within the <1/> node. If empty, BTPlayAnimation will resume the last played animation if the <2/> was previously paused.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 1170,
|
||
"tpl": "Animation’s key within the <1/> node. If empty, BTPlayAnimation will resume the last played animation if the <2/> was previously paused.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1171,
|
||
"tpl": "<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-animation-player\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>await_completion</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-await-completion\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1172,
|
||
"tpl": "<1/> <b>await_completion</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-await-completion\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_await_completion</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1173,
|
||
"tpl": "<1/> <b>set_await_completion</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_await_completion</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1174,
|
||
"tpl": "<1/> <b>get_await_completion</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"The maximum duration to wait for the animation to complete (in seconds). If the animation doesn’t finish within this time, BTPlayAnimation will stop waiting and return <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1175,
|
||
"tpl": "The maximum duration to wait for the animation to complete (in seconds). If the animation doesn’t finish within this time, BTPlayAnimation will stop waiting and return <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>blend</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">-1.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-blend\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1176,
|
||
"tpl": "<1/> <b>blend</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">-1.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-blend\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_blend</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1177,
|
||
"tpl": "<1/> <b>set_blend</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_blend</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1178,
|
||
"tpl": "<1/> <b>get_blend</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Custom blend time (in seconds). See AnimationPlayer.play.\u0000{}": {
|
||
"uid": 1179,
|
||
"tpl": "Custom blend time (in seconds). See AnimationPlayer.play.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>from_end</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-from-end\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1180,
|
||
"tpl": "<1/> <b>from_end</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-from-end\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_from_end</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1181,
|
||
"tpl": "<1/> <b>set_from_end</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_from_end</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1182,
|
||
"tpl": "<1/> <b>get_from_end</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"Play animation from the end. Used in combination with negative <l1>speed</l> to play animation in reverse. See AnimationPlayer.play.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-speed\\\"><span class=\\\"std std-ref\\\">speed</span></a>\"}": {
|
||
"uid": 1183,
|
||
"tpl": "Play animation from the end. Used in combination with negative <l1>speed</l> to play animation in reverse. See AnimationPlayer.play.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-speed\"><span class=\"std std-ref\">speed</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>speed</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btplayanimation-property-speed\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1184,
|
||
"tpl": "<1/> <b>speed</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btplayanimation-property-speed\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_speed</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1185,
|
||
"tpl": "<1/> <b>set_speed</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_speed</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1186,
|
||
"tpl": "<1/> <b>get_speed</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Custom playback speed scaling ratio. See AnimationPlayer.play.\u0000{}": {
|
||
"uid": 1187,
|
||
"tpl": "Custom playback speed scaling ratio. See AnimationPlayer.play.",
|
||
"markers": {}
|
||
},
|
||
"BTProbability\u0000{}": {
|
||
"uid": 1188,
|
||
"tpl": "BTProbability",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that executes its child task with a given probability.\u0000{}": {
|
||
"uid": 1189,
|
||
"tpl": "BT decorator that executes its child task with a given probability.",
|
||
"markers": {}
|
||
},
|
||
"BTProbability executes its child task with a given probability defined by <l1>run_chance</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobability-property-run-chance\\\"><span class=\\\"std std-ref\\\">run_chance</span></a>\"}": {
|
||
"uid": 1190,
|
||
"tpl": "BTProbability executes its child task with a given probability defined by <l1>run_chance</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobability-property-run-chance\"><span class=\"std std-ref\">run_chance</span></a>"
|
||
}
|
||
},
|
||
"Returns the result of the child task if it was executed; otherwise, it returns <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1191,
|
||
"tpl": "Returns the result of the child task if it was executed; otherwise, it returns <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<l1>run_chance</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobability-property-run-chance\\\"><span class=\\\"std std-ref\\\">run_chance</span></a>\"}": {
|
||
"uid": 1192,
|
||
"tpl": "<l1>run_chance</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobability-property-run-chance\"><span class=\"std std-ref\">run_chance</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>run_chance</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0.5</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobability-property-run-chance\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1193,
|
||
"tpl": "<1/> <b>run_chance</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0.5</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btprobability-property-run-chance\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_run_chance</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1194,
|
||
"tpl": "<1/> <b>set_run_chance</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_run_chance</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1195,
|
||
"tpl": "<1/> <b>get_run_chance</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Probability that defines how likely the child task will be executed.\u0000{}": {
|
||
"uid": 1196,
|
||
"tpl": "Probability that defines how likely the child task will be executed.",
|
||
"markers": {}
|
||
},
|
||
"BTProbabilitySelector\u0000{}": {
|
||
"uid": 1197,
|
||
"tpl": "BTProbabilitySelector",
|
||
"markers": {}
|
||
},
|
||
"BT composite that chooses a child task to execute based on attached probabilities.\u0000{}": {
|
||
"uid": 1198,
|
||
"tpl": "BT composite that chooses a child task to execute based on attached probabilities.",
|
||
"markers": {}
|
||
},
|
||
"BTProbabilitySelector chooses a child task to execute based on attached probabilities. It is typically used for decision-making purposes. Probability distribution is calculated based on weights assigned to each child task.\u0000{}": {
|
||
"uid": 1199,
|
||
"tpl": "BTProbabilitySelector chooses a child task to execute based on attached probabilities. It is typically used for decision-making purposes. Probability distribution is calculated based on weights assigned to each child task.",
|
||
"markers": {}
|
||
},
|
||
"Returns <1/> when a child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1200,
|
||
"tpl": "Returns <1/> when a child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> when a child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1201,
|
||
"tpl": "Returns <1/> when a child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"The behavior of BTProbabilitySelector when a child task results in <1/> depends on the <l2>abort_on_failure</l> value:\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">abort_on_failure</span></a>\"}": {
|
||
"uid": 1202,
|
||
"tpl": "The behavior of BTProbabilitySelector when a child task results in <1/> depends on the <l2>abort_on_failure</l> value:",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-property-abort-on-failure\"><span class=\"std std-ref\">abort_on_failure</span></a>"
|
||
}
|
||
},
|
||
"If <l1>abort_on_failure</l> is <2/>, when a child task results in <3/>, BTProbabilitySelector will normalize the probability distribution over the remaining children and choose a new child task to be executed. If all child tasks fail, the composite will return <4/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">abort_on_failure</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1203,
|
||
"tpl": "If <l1>abort_on_failure</l> is <2/>, when a child task results in <3/>, BTProbabilitySelector will normalize the probability distribution over the remaining children and choose a new child task to be executed. If all child tasks fail, the composite will return <4/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-property-abort-on-failure\"><span class=\"std std-ref\">abort_on_failure</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"If <l1>abort_on_failure</l> is <2/>, when a child task results in <3/>, BTProbabilitySelector will not choose another child task to be executed and will immediately return <4/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">abort_on_failure</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1204,
|
||
"tpl": "If <l1>abort_on_failure</l> is <2/>, when a child task results in <3/>, BTProbabilitySelector will not choose another child task to be executed and will immediately return <4/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-property-abort-on-failure\"><span class=\"std std-ref\">abort_on_failure</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<l1>abort_on_failure</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">abort_on_failure</span></a>\"}": {
|
||
"uid": 1205,
|
||
"tpl": "<l1>abort_on_failure</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-property-abort-on-failure\"><span class=\"std std-ref\">abort_on_failure</span></a>"
|
||
}
|
||
},
|
||
"<l1>get_probability</l>(child_idx: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-get-probability\\\"><span class=\\\"std std-ref\\\">get_probability</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1206,
|
||
"tpl": "<l1>get_probability</l>(child_idx: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-get-probability\"><span class=\"std std-ref\">get_probability</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_total_weight</l>() <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-get-total-weight\\\"><span class=\\\"std std-ref\\\">get_total_weight</span></a>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1207,
|
||
"tpl": "<l1>get_total_weight</l>() <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-get-total-weight\"><span class=\"std std-ref\">get_total_weight</span></a>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_weight</l>(child_idx: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-get-weight\\\"><span class=\\\"std std-ref\\\">get_weight</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1208,
|
||
"tpl": "<l1>get_weight</l>(child_idx: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-get-weight\"><span class=\"std std-ref\">get_weight</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>has_probability</l>(child_idx: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-has-probability\\\"><span class=\\\"std std-ref\\\">has_probability</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1209,
|
||
"tpl": "<l1>has_probability</l>(child_idx: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-has-probability\"><span class=\"std std-ref\">has_probability</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>set_probability</l>(child_idx: <2/>, probability: <3/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-set-probability\\\"><span class=\\\"std std-ref\\\">set_probability</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1210,
|
||
"tpl": "<l1>set_probability</l>(child_idx: <2/>, probability: <3/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-set-probability\"><span class=\"std std-ref\">set_probability</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<l1>set_weight</l>(child_idx: <2/>, weight: <3/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-set-weight\\\"><span class=\\\"std std-ref\\\">set_weight</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1211,
|
||
"tpl": "<l1>set_weight</l>(child_idx: <2/>, weight: <3/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-set-weight\"><span class=\"std std-ref\">set_weight</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>abort_on_failure</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1212,
|
||
"tpl": "<1/> <b>abort_on_failure</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-property-abort-on-failure\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_abort_on_failure</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1213,
|
||
"tpl": "<1/> <b>set_abort_on_failure</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_abort_on_failure</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1214,
|
||
"tpl": "<1/> <b>get_abort_on_failure</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, BTProbabilitySelector will not choose another child to execute and will return <2/> when a child task results in <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1215,
|
||
"tpl": "If <1/>, BTProbabilitySelector will not choose another child to execute and will return <2/> when a child task results in <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_probability</b>(child_idx: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-get-probability\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1216,
|
||
"tpl": "<1/> <b>get_probability</b>(child_idx: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-get-probability\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the child task’s selection probability.\u0000{}": {
|
||
"uid": 1217,
|
||
"tpl": "Returns the child task’s selection probability.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_total_weight</b>() <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-get-total-weight\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1218,
|
||
"tpl": "<1/> <b>get_total_weight</b>() <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-get-total-weight\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the total weight of all child tasks.\u0000{}": {
|
||
"uid": 1219,
|
||
"tpl": "Returns the total weight of all child tasks.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>get_weight</b>(child_idx: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-get-weight\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1220,
|
||
"tpl": "<1/> <b>get_weight</b>(child_idx: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-get-weight\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the child task’s weight within the weighted probability selection algorithm.\u0000{}": {
|
||
"uid": 1221,
|
||
"tpl": "Returns the child task’s weight within the weighted probability selection algorithm.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>has_probability</b>(child_idx: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-has-probability\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1222,
|
||
"tpl": "<1/> <b>has_probability</b>(child_idx: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-has-probability\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns whether the child task at index <1/> participates within the weighted probability selection algorithm and has a probability assigned to it. Returns <2/> for <l3>BTComment</l> tasks.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">child_idx</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btcomment#class-btcomment\\\"><span class=\\\"std std-ref\\\">BTComment</span></a>\"}": {
|
||
"uid": 1223,
|
||
"tpl": "Returns whether the child task at index <1/> participates within the weighted probability selection algorithm and has a probability assigned to it. Returns <2/> for <l3>BTComment</l> tasks.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">child_idx</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_btcomment#class-btcomment\"><span class=\"std std-ref\">BTComment</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_probability</b>(child_idx: <2/>, probability: <3/>) <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-set-probability\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1224,
|
||
"tpl": "<1/> <b>set_probability</b>(child_idx: <2/>, probability: <3/>) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-set-probability\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the child task’s weight calculated based on the desired probability.\u0000{}": {
|
||
"uid": 1225,
|
||
"tpl": "Sets the child task’s weight calculated based on the desired probability.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>set_weight</b>(child_idx: <2/>, weight: <3/>) <l4>🔗</l>\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btprobabilityselector-method-set-weight\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1226,
|
||
"tpl": "<1/> <b>set_weight</b>(child_idx: <2/>, weight: <3/>) <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btprobabilityselector-method-set-weight\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Sets the child task’s weight for the weighted probability selection algorithm.\u0000{}": {
|
||
"uid": 1227,
|
||
"tpl": "Sets the child task’s weight for the weighted probability selection algorithm.",
|
||
"markers": {}
|
||
},
|
||
"BTRandomSelector\u0000{}": {
|
||
"uid": 1228,
|
||
"tpl": "BTRandomSelector",
|
||
"markers": {}
|
||
},
|
||
"BT composite that executes tasks in random order until first <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1229,
|
||
"tpl": "BT composite that executes tasks in random order until first <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTRandomSelector executes its child tasks in a random order until any child returns <1/>. If a child task results in <2/>, BTRandomSelector will immediately execute another child task until one of them returns <3/> or all of them result in <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1230,
|
||
"tpl": "BTRandomSelector executes its child tasks in a random order until any child returns <1/>. If a child task results in <2/>, BTRandomSelector will immediately execute another child task until one of them returns <3/> or all of them result in <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if a child task results in <2/>. BTRandomSelector will remember the execution order and the last child task that returned <3/>, ensuring it resumes from that point in the next tick.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1231,
|
||
"tpl": "Returns <1/> if a child task results in <2/>. BTRandomSelector will remember the execution order and the last child task that returned <3/>, ensuring it resumes from that point in the next tick.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"BTRandomSequence\u0000{}": {
|
||
"uid": 1232,
|
||
"tpl": "BTRandomSequence",
|
||
"markers": {}
|
||
},
|
||
"BT composite that executes tasks in random order as long as they return <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1233,
|
||
"tpl": "BT composite that executes tasks in random order as long as they return <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTRandomSequence executes its child tasks in a random order as long as they return <1/>. If a child task results in <2/>, BTRandomSequence will immediately execute the next child task until one of them returns <3/> or all of them result in <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1234,
|
||
"tpl": "BTRandomSequence executes its child tasks in a random order as long as they return <1/>. If a child task results in <2/>, BTRandomSequence will immediately execute the next child task until one of them returns <3/> or all of them result in <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if a child task results in <2/>. BTRandomSequence will remember the execution order and the last child task that returned <3/>, ensuring it resumes from that point in the next tick.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1235,
|
||
"tpl": "Returns <1/> if a child task results in <2/>. BTRandomSequence will remember the execution order and the last child task that returned <3/>, ensuring it resumes from that point in the next tick.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"BTRandomWait\u0000{}": {
|
||
"uid": 1236,
|
||
"tpl": "BTRandomWait",
|
||
"markers": {}
|
||
},
|
||
"BT action that waits for a randomized duration to elapse and then returns <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1237,
|
||
"tpl": "BT action that waits for a randomized duration to elapse and then returns <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTRandomWait action waits for a randomized duration to elapse and then returns <1/>. The duration is randomized within the specified range, defined by <l2>min_duration</l> and <l3>max_duration</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrandomwait-property-min-duration\\\"><span class=\\\"std std-ref\\\">min_duration</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrandomwait-property-max-duration\\\"><span class=\\\"std std-ref\\\">max_duration</span></a>\"}": {
|
||
"uid": 1238,
|
||
"tpl": "BTRandomWait action waits for a randomized duration to elapse and then returns <1/>. The duration is randomized within the specified range, defined by <l2>min_duration</l> and <l3>max_duration</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btrandomwait-property-min-duration\"><span class=\"std std-ref\">min_duration</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrandomwait-property-max-duration\"><span class=\"std std-ref\">max_duration</span></a>"
|
||
}
|
||
},
|
||
"<l1>max_duration</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrandomwait-property-max-duration\\\"><span class=\\\"std std-ref\\\">max_duration</span></a>\"}": {
|
||
"uid": 1239,
|
||
"tpl": "<l1>max_duration</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrandomwait-property-max-duration\"><span class=\"std std-ref\">max_duration</span></a>"
|
||
}
|
||
},
|
||
"<l1>min_duration</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrandomwait-property-min-duration\\\"><span class=\\\"std std-ref\\\">min_duration</span></a>\"}": {
|
||
"uid": 1240,
|
||
"tpl": "<l1>min_duration</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrandomwait-property-min-duration\"><span class=\"std std-ref\">min_duration</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>max_duration</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">2.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrandomwait-property-max-duration\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1241,
|
||
"tpl": "<1/> <b>max_duration</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">2.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrandomwait-property-max-duration\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_max_duration</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1242,
|
||
"tpl": "<1/> <b>set_max_duration</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_max_duration</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1243,
|
||
"tpl": "<1/> <b>get_max_duration</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Maximum duration for the wait.\u0000{}": {
|
||
"uid": 1244,
|
||
"tpl": "Maximum duration for the wait.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>min_duration</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrandomwait-property-min-duration\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1245,
|
||
"tpl": "<1/> <b>min_duration</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrandomwait-property-min-duration\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_min_duration</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1246,
|
||
"tpl": "<1/> <b>set_min_duration</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_min_duration</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1247,
|
||
"tpl": "<1/> <b>get_min_duration</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Minimum duration for the wait.\u0000{}": {
|
||
"uid": 1248,
|
||
"tpl": "Minimum duration for the wait.",
|
||
"markers": {}
|
||
},
|
||
"BTRepeat\u0000{}": {
|
||
"uid": 1249,
|
||
"tpl": "BTRepeat",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that repeats its child a specified number of <l1>times</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-times\\\"><span class=\\\"std std-ref\\\">times</span></a>\"}": {
|
||
"uid": 1250,
|
||
"tpl": "BT decorator that repeats its child a specified number of <l1>times</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrepeat-property-times\"><span class=\"std std-ref\">times</span></a>"
|
||
}
|
||
},
|
||
"BTRepeat iterates its child task a specified number of times, as defined by <l1>times</l>. If <l2>forever</l> is <3/>, the child’s execution will be repeated indefinitely.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-times\\\"><span class=\\\"std std-ref\\\">times</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-forever\\\"><span class=\\\"std std-ref\\\">forever</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 1251,
|
||
"tpl": "BTRepeat iterates its child task a specified number of times, as defined by <l1>times</l>. If <l2>forever</l> is <3/>, the child’s execution will be repeated indefinitely.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrepeat-property-times\"><span class=\"std std-ref\">times</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btrepeat-property-forever\"><span class=\"std std-ref\">forever</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/>. If <l3>forever</l> is <4/>, BTRepeat will always return <5/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-forever\\\"><span class=\\\"std std-ref\\\">forever</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"5\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1252,
|
||
"tpl": "Returns <1/> if the child task results in <2/>. If <l3>forever</l> is <4/>, BTRepeat will always return <5/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrepeat-property-forever\"><span class=\"std std-ref\">forever</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"5": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the specified number of successful executions is reached. If <l2>abort_on_failure</l> is <3/>, a <4/> status returned by the child is also considered a successful execution.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">abort_on_failure</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1253,
|
||
"tpl": "Returns <1/> if the specified number of successful executions is reached. If <l2>abort_on_failure</l> is <3/>, a <4/> status returned by the child is also considered a successful execution.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btrepeat-property-abort-on-failure\"><span class=\"std std-ref\">abort_on_failure</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/> when <l3>abort_on_failure</l> is <4/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">abort_on_failure</span></a>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 1254,
|
||
"tpl": "Returns <1/> if the child task results in <2/> when <l3>abort_on_failure</l> is <4/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrepeat-property-abort-on-failure\"><span class=\"std std-ref\">abort_on_failure</span></a>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<l1>abort_on_failure</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">abort_on_failure</span></a>\"}": {
|
||
"uid": 1255,
|
||
"tpl": "<l1>abort_on_failure</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrepeat-property-abort-on-failure\"><span class=\"std std-ref\">abort_on_failure</span></a>"
|
||
}
|
||
},
|
||
"<l1>forever</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-forever\\\"><span class=\\\"std std-ref\\\">forever</span></a>\"}": {
|
||
"uid": 1256,
|
||
"tpl": "<l1>forever</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrepeat-property-forever\"><span class=\"std std-ref\">forever</span></a>"
|
||
}
|
||
},
|
||
"<l1>times</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-times\\\"><span class=\\\"std std-ref\\\">times</span></a>\"}": {
|
||
"uid": 1257,
|
||
"tpl": "<l1>times</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrepeat-property-times\"><span class=\"std std-ref\">times</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>abort_on_failure</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-abort-on-failure\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1258,
|
||
"tpl": "<1/> <b>abort_on_failure</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrepeat-property-abort-on-failure\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"If <1/>, <2/> status returned by the child task is also considered as a successful execution.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1259,
|
||
"tpl": "If <1/>, <2/> status returned by the child task is also considered as a successful execution.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>forever</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-forever\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1260,
|
||
"tpl": "<1/> <b>forever</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrepeat-property-forever\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_forever</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1261,
|
||
"tpl": "<1/> <b>set_forever</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_forever</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1262,
|
||
"tpl": "<1/> <b>get_forever</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, the child’s execution will be repeated indefinitely, always returning <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1263,
|
||
"tpl": "If <1/>, the child’s execution will be repeated indefinitely, always returning <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>times</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrepeat-property-times\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1264,
|
||
"tpl": "<1/> <b>times</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrepeat-property-times\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_times</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1265,
|
||
"tpl": "<1/> <b>set_times</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_times</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1266,
|
||
"tpl": "<1/> <b>get_times</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"The number of times to repeat execution of the child task.\u0000{}": {
|
||
"uid": 1267,
|
||
"tpl": "The number of times to repeat execution of the child task.",
|
||
"markers": {}
|
||
},
|
||
"BTRepeatUntilFailure\u0000{}": {
|
||
"uid": 1268,
|
||
"tpl": "BTRepeatUntilFailure",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that repeats its child task until <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1269,
|
||
"tpl": "BT decorator that repeats its child task until <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTRepeatUntilFailure repeats its child task until it results in <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1270,
|
||
"tpl": "BTRepeatUntilFailure repeats its child task until it results in <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/> or <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1271,
|
||
"tpl": "Returns <1/> if the child task results in <2/> or <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1272,
|
||
"tpl": "Returns <1/> if the child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"BTRepeatUntilSuccess\u0000{}": {
|
||
"uid": 1273,
|
||
"tpl": "BTRepeatUntilSuccess",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that repeats its child task until <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1274,
|
||
"tpl": "BT decorator that repeats its child task until <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTRepeatUntilSuccess repeats its child task until it results in <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1275,
|
||
"tpl": "BTRepeatUntilSuccess repeats its child task until it results in <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/> or <3/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1276,
|
||
"tpl": "Returns <1/> if the child task results in <2/> or <3/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"Returns <1/> if the child task results in <2/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1277,
|
||
"tpl": "Returns <1/> if the child task results in <2/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTRunLimit\u0000{}": {
|
||
"uid": 1278,
|
||
"tpl": "BTRunLimit",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that restricts the execution of its child a limited number of times.\u0000{}": {
|
||
"uid": 1279,
|
||
"tpl": "BT decorator that restricts the execution of its child a limited number of times.",
|
||
"markers": {}
|
||
},
|
||
"BTRunLimit restricts the execution of the child task to a maximum number of times, defined by <l1>run_limit</l>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrunlimit-property-run-limit\\\"><span class=\\\"std std-ref\\\">run_limit</span></a>\"}": {
|
||
"uid": 1280,
|
||
"tpl": "BTRunLimit restricts the execution of the child task to a maximum number of times, defined by <l1>run_limit</l>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrunlimit-property-run-limit\"><span class=\"std std-ref\">run_limit</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if the limit on executions is exceeded; otherwise, it returns the status of the child task.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1281,
|
||
"tpl": "Returns <1/> if the limit on executions is exceeded; otherwise, it returns the status of the child task.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<l1>CountPolicy</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">CountPolicy</span></a>\"}": {
|
||
"uid": 1282,
|
||
"tpl": "<l1>CountPolicy</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">CountPolicy</span></a>"
|
||
}
|
||
},
|
||
"<l1>count_policy</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrunlimit-property-count-policy\\\"><span class=\\\"std std-ref\\\">count_policy</span></a>\"}": {
|
||
"uid": 1283,
|
||
"tpl": "<l1>count_policy</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrunlimit-property-count-policy\"><span class=\"std std-ref\">count_policy</span></a>"
|
||
}
|
||
},
|
||
"<l1>run_limit</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrunlimit-property-run-limit\\\"><span class=\\\"std std-ref\\\">run_limit</span></a>\"}": {
|
||
"uid": 1284,
|
||
"tpl": "<l1>run_limit</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btrunlimit-property-run-limit\"><span class=\"std std-ref\">run_limit</span></a>"
|
||
}
|
||
},
|
||
"enum <b>CountPolicy</b>: <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1285,
|
||
"tpl": "enum <b>CountPolicy</b>: <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>CountPolicy</l> <b>COUNT_SUCCESSFUL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">CountPolicy</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\"}": {
|
||
"uid": 1286,
|
||
"tpl": "<l1>CountPolicy</l> <b>COUNT_SUCCESSFUL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">CountPolicy</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>"
|
||
}
|
||
},
|
||
"Count only successful runs towards the limit.\u0000{}": {
|
||
"uid": 1287,
|
||
"tpl": "Count only successful runs towards the limit.",
|
||
"markers": {}
|
||
},
|
||
"<l1>CountPolicy</l> <b>COUNT_FAILED</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">CountPolicy</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\"}": {
|
||
"uid": 1288,
|
||
"tpl": "<l1>CountPolicy</l> <b>COUNT_FAILED</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">CountPolicy</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>"
|
||
}
|
||
},
|
||
"Count only failed runs towards the limit.\u0000{}": {
|
||
"uid": 1289,
|
||
"tpl": "Count only failed runs towards the limit.",
|
||
"markers": {}
|
||
},
|
||
"<l1>CountPolicy</l> <b>COUNT_ALL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">CountPolicy</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">2</span></code>\"}": {
|
||
"uid": 1290,
|
||
"tpl": "<l1>CountPolicy</l> <b>COUNT_ALL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">CountPolicy</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">2</span></code>"
|
||
}
|
||
},
|
||
"Count successful and failed runs towards the limit.\u0000{}": {
|
||
"uid": 1291,
|
||
"tpl": "Count successful and failed runs towards the limit.",
|
||
"markers": {}
|
||
},
|
||
"<l1>CountPolicy</l> <b>count_policy</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">CountPolicy</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrunlimit-property-count-policy\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1292,
|
||
"tpl": "<l1>CountPolicy</l> <b>count_policy</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">CountPolicy</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrunlimit-property-count-policy\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_count_policy</b>(value: <l2>CountPolicy</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">CountPolicy</span></a>\"}": {
|
||
"uid": 1293,
|
||
"tpl": "<1/> <b>set_count_policy</b>(value: <l2>CountPolicy</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">CountPolicy</span></a>"
|
||
}
|
||
},
|
||
"<l1>CountPolicy</l> <b>get_count_policy</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-btrunlimit-countpolicy\\\"><span class=\\\"std std-ref\\\">CountPolicy</span></a>\"}": {
|
||
"uid": 1294,
|
||
"tpl": "<l1>CountPolicy</l> <b>get_count_policy</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-btrunlimit-countpolicy\"><span class=\"std std-ref\">CountPolicy</span></a>"
|
||
}
|
||
},
|
||
"Which runs should be counted towards the limit: successful, failed, or all?\u0000{}": {
|
||
"uid": 1295,
|
||
"tpl": "Which runs should be counted towards the limit: successful, failed, or all?",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>run_limit</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btrunlimit-property-run-limit\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1296,
|
||
"tpl": "<1/> <b>run_limit</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btrunlimit-property-run-limit\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_run_limit</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1297,
|
||
"tpl": "<1/> <b>set_run_limit</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_run_limit</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1298,
|
||
"tpl": "<1/> <b>get_run_limit</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"The maximum number of times the child is permitted to be executed.\u0000{}": {
|
||
"uid": 1299,
|
||
"tpl": "The maximum number of times the child is permitted to be executed.",
|
||
"markers": {}
|
||
},
|
||
"BTSelector\u0000{}": {
|
||
"uid": 1300,
|
||
"tpl": "BTSelector",
|
||
"markers": {}
|
||
},
|
||
"BT composite that sequentially executes tasks until first <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1301,
|
||
"tpl": "BT composite that sequentially executes tasks until first <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTSelector executes its child tasks sequentially, from first to last, until any child returns <1/>. If a child task results in <2/>, BTSelector will immediately execute the next child task until one of them returns <3/> or all of them result in <4/>. BTSelector and <l5>BTSequence</l> are two of the most common building blocks of behavior trees. Essentially, while <l6>BTSequence</l> is similar to a boolean AND operation, BTSelector is similar to a boolean OR operation. Selectors enable the behavior tree to respond to changes in the environment and trigger transitions between various fallback behaviors.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btsequence#class-btsequence\\\"><span class=\\\"std std-ref\\\">BTSequence</span></a>\"}": {
|
||
"uid": 1302,
|
||
"tpl": "BTSelector executes its child tasks sequentially, from first to last, until any child returns <1/>. If a child task results in <2/>, BTSelector will immediately execute the next child task until one of them returns <3/> or all of them result in <4/>. BTSelector and <l5>BTSequence</l> are two of the most common building blocks of behavior trees. Essentially, while <l6>BTSequence</l> is similar to a boolean AND operation, BTSelector is similar to a boolean OR operation. Selectors enable the behavior tree to respond to changes in the environment and trigger transitions between various fallback behaviors.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_btsequence#class-btsequence\"><span class=\"std std-ref\">BTSequence</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if a child task results in <2/>. BTSelector will remember the last child task that returned <3/>, ensuring it resumes from that point in the next execution tick.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1303,
|
||
"tpl": "Returns <1/> if a child task results in <2/>. BTSelector will remember the last child task that returned <3/>, ensuring it resumes from that point in the next execution tick.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"BTSequence\u0000{}": {
|
||
"uid": 1304,
|
||
"tpl": "BTSequence",
|
||
"markers": {}
|
||
},
|
||
"BT composite that sequentially executes tasks as long as they return <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1305,
|
||
"tpl": "BT composite that sequentially executes tasks as long as they return <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTSequence executes its child tasks sequentially, from first to last, as long as they return <1/>. If a child task results in <2/>, BTSequence will immediately execute the next child task until one of them returns <3/> or all of them result in <4/>. BTSequence and <l5>BTSelector</l> are two of the most common building blocks of behavior trees. Essentially, while <l6>BTSelector</l> is similar to a boolean OR operation, BTSequence is similar to a boolean AND operation. Sequences enable the behavior tree to compose complex behaviors from a chain of simpler tasks.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">BTSelector</span></a>\", \"6\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btselector#class-btselector\\\"><span class=\\\"std std-ref\\\">BTSelector</span></a>\"}": {
|
||
"uid": 1306,
|
||
"tpl": "BTSequence executes its child tasks sequentially, from first to last, as long as they return <1/>. If a child task results in <2/>, BTSequence will immediately execute the next child task until one of them returns <3/> or all of them result in <4/>. BTSequence and <l5>BTSelector</l> are two of the most common building blocks of behavior trees. Essentially, while <l6>BTSelector</l> is similar to a boolean OR operation, BTSequence is similar to a boolean AND operation. Sequences enable the behavior tree to compose complex behaviors from a chain of simpler tasks.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">BTSelector</span></a>",
|
||
"6": "<a class=\"reference internal\" href=\"#document-classes/class_btselector#class-btselector\"><span class=\"std std-ref\">BTSelector</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if any child task results in <2/>. BTSequence will remember the last child task that returned <3/>, ensuring it resumes from that point in the next execution tick.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">RUNNING</span></code>\"}": {
|
||
"uid": 1307,
|
||
"tpl": "Returns <1/> if any child task results in <2/>. BTSequence will remember the last child task that returned <3/>, ensuring it resumes from that point in the next execution tick.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">RUNNING</span></code>"
|
||
}
|
||
},
|
||
"BTSetAgentProperty\u0000{}": {
|
||
"uid": 1308,
|
||
"tpl": "BTSetAgentProperty",
|
||
"markers": {}
|
||
},
|
||
"BT action that assigns a value to the specified agent’s property.\u0000{}": {
|
||
"uid": 1309,
|
||
"tpl": "BT action that assigns a value to the specified agent’s property.",
|
||
"markers": {}
|
||
},
|
||
"BTSetAgentProperty assigns the specified <l1>value</l> to the agent’s property identified by the <l2>property</l> and returns <3/>. Optionally, it can perform a specific <l4>operation</l> before assignment.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-property\\\"><span class=\\\"std std-ref\\\">property</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-operation\\\"><span class=\\\"std std-ref\\\">operation</span></a>\"}": {
|
||
"uid": 1310,
|
||
"tpl": "BTSetAgentProperty assigns the specified <l1>value</l> to the agent’s property identified by the <l2>property</l> and returns <3/>. Optionally, it can perform a specific <l4>operation</l> before assignment.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-value\"><span class=\"std std-ref\">value</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-property\"><span class=\"std std-ref\">property</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-operation\"><span class=\"std std-ref\">operation</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if it fails to set the property.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\"}": {
|
||
"uid": 1311,
|
||
"tpl": "Returns <1/> if it fails to set the property.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>"
|
||
}
|
||
},
|
||
"<l1>Operation</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\"}": {
|
||
"uid": 1312,
|
||
"tpl": "<l1>Operation</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>"
|
||
}
|
||
},
|
||
"<l1>operation</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-operation\\\"><span class=\\\"std std-ref\\\">operation</span></a>\"}": {
|
||
"uid": 1313,
|
||
"tpl": "<l1>operation</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-operation\"><span class=\"std std-ref\">operation</span></a>"
|
||
}
|
||
},
|
||
"<l1>property</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-property\\\"><span class=\\\"std std-ref\\\">property</span></a>\"}": {
|
||
"uid": 1314,
|
||
"tpl": "<l1>property</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-property\"><span class=\"std std-ref\">property</span></a>"
|
||
}
|
||
},
|
||
"<l1>value</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\"}": {
|
||
"uid": 1315,
|
||
"tpl": "<l1>value</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-value\"><span class=\"std std-ref\">value</span></a>"
|
||
}
|
||
},
|
||
"<l1>Operation</l> <b>operation</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-operation\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1316,
|
||
"tpl": "<l1>Operation</l> <b>operation</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-operation\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_operation</b>(value: <l2>Operation</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\"}": {
|
||
"uid": 1317,
|
||
"tpl": "<1/> <b>set_operation</b>(value: <l2>Operation</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>"
|
||
}
|
||
},
|
||
"<l1>Operation</l> <b>get_operation</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\"}": {
|
||
"uid": 1318,
|
||
"tpl": "<l1>Operation</l> <b>get_operation</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>"
|
||
}
|
||
},
|
||
"Specifies the operation to be performed before assignment. Operation is executed as follows:\u0000{}": {
|
||
"uid": 1319,
|
||
"tpl": "Specifies the operation to be performed before assignment. Operation is executed as follows:",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>property</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-property\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1320,
|
||
"tpl": "<1/> <b>property</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-property\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Parameter that specifies the agent’s property name.\u0000{}": {
|
||
"uid": 1321,
|
||
"tpl": "Parameter that specifies the agent’s property name.",
|
||
"markers": {}
|
||
},
|
||
"<l1>BBVariant</l> <b>value</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetagentproperty-property-value\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1322,
|
||
"tpl": "<l1>BBVariant</l> <b>value</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btsetagentproperty-property-value\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Parameter that specifies the value that will be assigned to agent’s property.\u0000{}": {
|
||
"uid": 1323,
|
||
"tpl": "Parameter that specifies the value that will be assigned to agent’s property.",
|
||
"markers": {}
|
||
},
|
||
"BTSetVar\u0000{}": {
|
||
"uid": 1324,
|
||
"tpl": "BTSetVar",
|
||
"markers": {}
|
||
},
|
||
"BT action that assigns <l1>value</l> to the <l2>variable</l> and then returns <3/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1325,
|
||
"tpl": "BT action that assigns <l1>value</l> to the <l2>variable</l> and then returns <3/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetvar-property-value\"><span class=\"std std-ref\">value</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btsetvar-property-variable\"><span class=\"std std-ref\">variable</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"BTSetVar assigns <l1>value</l> to the <l2>variable</l> and then returns <3/>. Optionally, it can perform a specific <l4>operation</l> before assignment.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-operation\\\"><span class=\\\"std std-ref\\\">operation</span></a>\"}": {
|
||
"uid": 1326,
|
||
"tpl": "BTSetVar assigns <l1>value</l> to the <l2>variable</l> and then returns <3/>. Optionally, it can perform a specific <l4>operation</l> before assignment.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetvar-property-value\"><span class=\"std std-ref\">value</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btsetvar-property-variable\"><span class=\"std std-ref\">variable</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-btsetvar-property-operation\"><span class=\"std std-ref\">operation</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if it fails to set the <l2>variable</l>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\"}": {
|
||
"uid": 1327,
|
||
"tpl": "Returns <1/> if it fails to set the <l2>variable</l>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btsetvar-property-variable\"><span class=\"std std-ref\">variable</span></a>"
|
||
}
|
||
},
|
||
"<l1>operation</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-operation\\\"><span class=\\\"std std-ref\\\">operation</span></a>\"}": {
|
||
"uid": 1328,
|
||
"tpl": "<l1>operation</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetvar-property-operation\"><span class=\"std std-ref\">operation</span></a>"
|
||
}
|
||
},
|
||
"<l1>value</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-value\\\"><span class=\\\"std std-ref\\\">value</span></a>\"}": {
|
||
"uid": 1329,
|
||
"tpl": "<l1>value</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetvar-property-value\"><span class=\"std std-ref\">value</span></a>"
|
||
}
|
||
},
|
||
"<l1>variable</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-variable\\\"><span class=\\\"std std-ref\\\">variable</span></a>\"}": {
|
||
"uid": 1330,
|
||
"tpl": "<l1>variable</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsetvar-property-variable\"><span class=\"std std-ref\">variable</span></a>"
|
||
}
|
||
},
|
||
"<l1>Operation</l> <b>operation</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_limboutility#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-operation\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1331,
|
||
"tpl": "<l1>Operation</l> <b>operation</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_limboutility#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btsetvar-property-operation\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>BBVariant</l> <b>value</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbvariant#class-bbvariant\\\"><span class=\\\"std std-ref\\\">BBVariant</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-value\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1332,
|
||
"tpl": "<l1>BBVariant</l> <b>value</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbvariant#class-bbvariant\"><span class=\"std std-ref\">BBVariant</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btsetvar-property-value\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Parameter that specifies the value to be assigned to the variable.\u0000{}": {
|
||
"uid": 1333,
|
||
"tpl": "Parameter that specifies the value to be assigned to the variable.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>variable</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsetvar-property-variable\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1334,
|
||
"tpl": "<1/> <b>variable</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btsetvar-property-variable\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Name of the variable to which the value will be assigned.\u0000{}": {
|
||
"uid": 1335,
|
||
"tpl": "Name of the variable to which the value will be assigned.",
|
||
"markers": {}
|
||
},
|
||
"BTStopAnimation\u0000{}": {
|
||
"uid": 1336,
|
||
"tpl": "BTStopAnimation",
|
||
"markers": {}
|
||
},
|
||
"BT action that stops the playback of an animation on the specified <1/> node.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 1337,
|
||
"tpl": "BT action that stops the playback of an animation on the specified <1/> node.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"BTStopAnimation action stops the playback of an animation on the specified <1/> node and returns <2/>. If <l3>animation_name</l> is set, it will only stop the playback if the specified animation is currently playing.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstopanimation-property-animation-name\\\"><span class=\\\"std std-ref\\\">animation_name</span></a>\"}": {
|
||
"uid": 1338,
|
||
"tpl": "BTStopAnimation action stops the playback of an animation on the specified <1/> node and returns <2/>. If <l3>animation_name</l> is set, it will only stop the playback if the specified animation is currently playing.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstopanimation-property-animation-name\"><span class=\"std std-ref\">animation_name</span></a>"
|
||
}
|
||
},
|
||
"<l1>animation_name</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstopanimation-property-animation-name\\\"><span class=\\\"std std-ref\\\">animation_name</span></a>\"}": {
|
||
"uid": 1339,
|
||
"tpl": "<l1>animation_name</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstopanimation-property-animation-name\"><span class=\"std std-ref\">animation_name</span></a>"
|
||
}
|
||
},
|
||
"<l1>animation_player</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstopanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">animation_player</span></a>\"}": {
|
||
"uid": 1340,
|
||
"tpl": "<l1>animation_player</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstopanimation-property-animation-player\"><span class=\"std std-ref\">animation_player</span></a>"
|
||
}
|
||
},
|
||
"<l1>keep_state</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstopanimation-property-keep-state\\\"><span class=\\\"std std-ref\\\">keep_state</span></a>\"}": {
|
||
"uid": 1341,
|
||
"tpl": "<l1>keep_state</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btstopanimation-property-keep-state\"><span class=\"std std-ref\">keep_state</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>animation_name</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">StringName</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">&\\\"\\\"</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstopanimation-property-animation-name\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1342,
|
||
"tpl": "<1/> <b>animation_name</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">StringName</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">&\"\"</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstopanimation-property-animation-name\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Animation’s key within the <1/> node. If not empty, BTStopAnimation will only stop the playback if the specified animation is currently playing.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">AnimationPlayer</span></code>\"}": {
|
||
"uid": 1343,
|
||
"tpl": "Animation’s key within the <1/> node. If not empty, BTStopAnimation will only stop the playback if the specified animation is currently playing.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">AnimationPlayer</span></code>"
|
||
}
|
||
},
|
||
"<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bbnode#class-bbnode\\\"><span class=\\\"std std-ref\\\">BBNode</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstopanimation-property-animation-player\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1344,
|
||
"tpl": "<l1>BBNode</l> <b>animation_player</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bbnode#class-bbnode\"><span class=\"std std-ref\">BBNode</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btstopanimation-property-animation-player\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>keep_state</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">false</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btstopanimation-property-keep-state\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1345,
|
||
"tpl": "<1/> <b>keep_state</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">false</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btstopanimation-property-keep-state\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_keep_state</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1346,
|
||
"tpl": "<1/> <b>set_keep_state</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_keep_state</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\"}": {
|
||
"uid": 1347,
|
||
"tpl": "<1/> <b>get_keep_state</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>"
|
||
}
|
||
},
|
||
"If <1/>, the animation state is not updated visually.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 1348,
|
||
"tpl": "If <1/>, the animation state is not updated visually.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"BTSubtree\u0000{}": {
|
||
"uid": 1349,
|
||
"tpl": "BTSubtree",
|
||
"markers": {}
|
||
},
|
||
"<b>Inherits:</b> <l1>BTNewScope</l> <b><</b> <l2>BTDecorator</l> <b><</b> <l3>BTTask</l> <b><</b> <l4>BT</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btnewscope#class-btnewscope\\\"><span class=\\\"std std-ref\\\">BTNewScope</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdecorator#class-btdecorator\\\"><span class=\\\"std std-ref\\\">BTDecorator</span></a>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bt#class-bt\\\"><span class=\\\"std std-ref\\\">BT</span></a>\"}": {
|
||
"uid": 1350,
|
||
"tpl": "<b>Inherits:</b> <l1>BTNewScope</l> <b><</b> <l2>BTDecorator</l> <b><</b> <l3>BTTask</l> <b><</b> <l4>BT</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btnewscope#class-btnewscope\"><span class=\"std std-ref\">BTNewScope</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_btdecorator#class-btdecorator\"><span class=\"std std-ref\">BTDecorator</span></a>",
|
||
"3": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>",
|
||
"4": "<a class=\"reference internal\" href=\"#document-classes/class_bt#class-bt\"><span class=\"std std-ref\">BT</span></a>"
|
||
}
|
||
},
|
||
"BT decorator that instantiates and runs a subtree within the larger tree.\u0000{}": {
|
||
"uid": 1351,
|
||
"tpl": "BT decorator that instantiates and runs a subtree within the larger tree.",
|
||
"markers": {}
|
||
},
|
||
"BTSubtree instantiates a <l1>BehaviorTree</l> and includes its root task as a child during initialization, while also creating a new <l2>Blackboard</l> scope.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 1352,
|
||
"tpl": "BTSubtree instantiates a <l1>BehaviorTree</l> and includes its root task as a child during initialization, while also creating a new <l2>Blackboard</l> scope.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"Returns the status of the subtree’s execution.\u0000{}": {
|
||
"uid": 1353,
|
||
"tpl": "Returns the status of the subtree’s execution.",
|
||
"markers": {}
|
||
},
|
||
"Subtree blackboard variables can be mapped to the main tree blackboard plan variables. Check out mapping section in the inspector.\u0000{}": {
|
||
"uid": 1354,
|
||
"tpl": "Subtree blackboard variables can be mapped to the main tree blackboard plan variables. Check out mapping section in the inspector.",
|
||
"markers": {}
|
||
},
|
||
"Note: BTSubTree is designed as a simpler loader, and does not support updating <l1>subtree</l> at runtime. A custom subtree decorator is better suited:\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsubtree-property-subtree\\\"><span class=\\\"std std-ref\\\">subtree</span></a>\"}": {
|
||
"uid": 1355,
|
||
"tpl": "Note: BTSubTree is designed as a simpler loader, and does not support updating <l1>subtree</l> at runtime. A custom subtree decorator is better suited:",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsubtree-property-subtree\"><span class=\"std std-ref\">subtree</span></a>"
|
||
}
|
||
},
|
||
"This allows for the <l1>BehaviorTree</l> to load a specific behavior tree from a variable in the blackboard, or from some other location, and use that new behavior tree at runtime.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_btdecorator#class-btdecorator\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1356,
|
||
"tpl": "This allows for the <l1>BehaviorTree</l> to load a specific behavior tree from a variable in the blackboard, or from some other location, and use that new behavior tree at runtime.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_btdecorator#class-btdecorator\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>subtree</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsubtree-property-subtree\\\"><span class=\\\"std std-ref\\\">subtree</span></a>\"}": {
|
||
"uid": 1357,
|
||
"tpl": "<l1>subtree</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btsubtree-property-subtree\"><span class=\"std std-ref\">subtree</span></a>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l> <b>subtree</b> <l2>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btsubtree-property-subtree\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1358,
|
||
"tpl": "<l1>BehaviorTree</l> <b>subtree</b> <l2>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-btsubtree-property-subtree\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_subtree</b>(value: <l2>BehaviorTree</l>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1359,
|
||
"tpl": "<1/> <b>set_subtree</b>(value: <l2>BehaviorTree</l>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"<l1>BehaviorTree</l> <b>get_subtree</b>()\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1360,
|
||
"tpl": "<l1>BehaviorTree</l> <b>get_subtree</b>()",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"A <l1>BehaviorTree</l> resource that will be instantiated as a subtree.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_behaviortree#class-behaviortree\\\"><span class=\\\"std std-ref\\\">BehaviorTree</span></a>\"}": {
|
||
"uid": 1361,
|
||
"tpl": "A <l1>BehaviorTree</l> resource that will be instantiated as a subtree.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_behaviortree#class-behaviortree\"><span class=\"std std-ref\">BehaviorTree</span></a>"
|
||
}
|
||
},
|
||
"BTTimeLimit\u0000{}": {
|
||
"uid": 1362,
|
||
"tpl": "BTTimeLimit",
|
||
"markers": {}
|
||
},
|
||
"BT decorator that sets a time limit for its child’s execution.\u0000{}": {
|
||
"uid": 1363,
|
||
"tpl": "BT decorator that sets a time limit for its child’s execution.",
|
||
"markers": {}
|
||
},
|
||
"BTTimeLimit allocates a limited time for the child’s execution and aborts it, returning <1/> if the <l2>time_limit</l> is exceeded.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttimelimit-property-time-limit\\\"><span class=\\\"std std-ref\\\">time_limit</span></a>\"}": {
|
||
"uid": 1364,
|
||
"tpl": "BTTimeLimit allocates a limited time for the child’s execution and aborts it, returning <1/> if the <l2>time_limit</l> is exceeded.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttimelimit-property-time-limit\"><span class=\"std std-ref\">time_limit</span></a>"
|
||
}
|
||
},
|
||
"Returns <1/> if the <l2>time_limit</l> is exceeded; otherwise, it returns the status of the child task.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">FAILURE</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttimelimit-property-time-limit\\\"><span class=\\\"std std-ref\\\">time_limit</span></a>\"}": {
|
||
"uid": 1365,
|
||
"tpl": "Returns <1/> if the <l2>time_limit</l> is exceeded; otherwise, it returns the status of the child task.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">FAILURE</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-bttimelimit-property-time-limit\"><span class=\"std std-ref\">time_limit</span></a>"
|
||
}
|
||
},
|
||
"<l1>time_limit</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttimelimit-property-time-limit\\\"><span class=\\\"std std-ref\\\">time_limit</span></a>\"}": {
|
||
"uid": 1366,
|
||
"tpl": "<l1>time_limit</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-bttimelimit-property-time-limit\"><span class=\"std std-ref\">time_limit</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>time_limit</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">5.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-bttimelimit-property-time-limit\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1367,
|
||
"tpl": "<1/> <b>time_limit</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">5.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-bttimelimit-property-time-limit\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_time_limit</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1368,
|
||
"tpl": "<1/> <b>set_time_limit</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_time_limit</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\"}": {
|
||
"uid": 1369,
|
||
"tpl": "<1/> <b>get_time_limit</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>"
|
||
}
|
||
},
|
||
"Time allocated for the child task’s execution.\u0000{}": {
|
||
"uid": 1370,
|
||
"tpl": "Time allocated for the child task’s execution.",
|
||
"markers": {}
|
||
},
|
||
"BTWait\u0000{}": {
|
||
"uid": 1371,
|
||
"tpl": "BTWait",
|
||
"markers": {}
|
||
},
|
||
"BT action that waits for a specified <l1>duration</l> to elapse and then returns <2/>.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btwait-property-duration\\\"><span class=\\\"std std-ref\\\">duration</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1372,
|
||
"tpl": "BT action that waits for a specified <l1>duration</l> to elapse and then returns <2/>.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btwait-property-duration\"><span class=\"std std-ref\">duration</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"<l1>duration</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btwait-property-duration\\\"><span class=\\\"std std-ref\\\">duration</span></a>\"}": {
|
||
"uid": 1373,
|
||
"tpl": "<l1>duration</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btwait-property-duration\"><span class=\"std std-ref\">duration</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>duration</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">float</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1.0</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btwait-property-duration\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1374,
|
||
"tpl": "<1/> <b>duration</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">float</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1.0</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btwait-property-duration\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"There is currently no description for this property. Please help us by contributing one!\u0000{}": {
|
||
"uid": 1375,
|
||
"tpl": "There is currently no description for this property. Please help us by contributing one!",
|
||
"markers": {}
|
||
},
|
||
"BTWaitTicks\u0000{}": {
|
||
"uid": 1376,
|
||
"tpl": "BTWaitTicks",
|
||
"markers": {}
|
||
},
|
||
"BT action that waits for a specified number of ticks to elapse and then returns <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1377,
|
||
"tpl": "BT action that waits for a specified number of ticks to elapse and then returns <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"<l1>num_ticks</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btwaitticks-property-num-ticks\\\"><span class=\\\"std std-ref\\\">num_ticks</span></a>\"}": {
|
||
"uid": 1378,
|
||
"tpl": "<l1>num_ticks</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-btwaitticks-property-num-ticks\"><span class=\"std std-ref\">num_ticks</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>num_ticks</b> = <2/> <l3>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\", \"3\": \"<a class=\\\"reference internal\\\" href=\\\"#class-btwaitticks-property-num-ticks\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1379,
|
||
"tpl": "<1/> <b>num_ticks</b> = <2/> <l3>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>",
|
||
"3": "<a class=\"reference internal\" href=\"#class-btwaitticks-property-num-ticks\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>set_num_ticks</b>(value: <2/>)\u0000{\"1\": \"<abbr title=\\\"No return value.\\\">void</abbr>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1380,
|
||
"tpl": "<1/> <b>set_num_ticks</b>(value: <2/>)",
|
||
"markers": {
|
||
"1": "<abbr title=\"No return value.\">void</abbr>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>get_num_ticks</b>()\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\"}": {
|
||
"uid": 1381,
|
||
"tpl": "<1/> <b>get_num_ticks</b>()",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>"
|
||
}
|
||
},
|
||
"The number of ticks to wait before returning <1/>.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">SUCCESS</span></code>\"}": {
|
||
"uid": 1382,
|
||
"tpl": "The number of ticks to wait before returning <1/>.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">SUCCESS</span></code>"
|
||
}
|
||
},
|
||
"LimboUtility\u0000{}": {
|
||
"uid": 1383,
|
||
"tpl": "LimboUtility",
|
||
"markers": {}
|
||
},
|
||
"Helper functions for LimboAI.\u0000{}": {
|
||
"uid": 1384,
|
||
"tpl": "Helper functions for LimboAI.",
|
||
"markers": {}
|
||
},
|
||
"<l1>decorate_output_var</l>(variable: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-decorate-output-var\\\"><span class=\\\"std std-ref\\\">decorate_output_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1385,
|
||
"tpl": "<l1>decorate_output_var</l>(variable: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-decorate-output-var\"><span class=\"std std-ref\">decorate_output_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>decorate_var</l>(variable: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-decorate-var\\\"><span class=\\\"std std-ref\\\">decorate_var</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1386,
|
||
"tpl": "<l1>decorate_var</l>(variable: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-decorate-var\"><span class=\"std std-ref\">decorate_var</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_check_operator_string</l>(check: <l2>CheckType</l>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-check-operator-string\\\"><span class=\\\"std std-ref\\\">get_check_operator_string</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1387,
|
||
"tpl": "<l1>get_check_operator_string</l>(check: <l2>CheckType</l>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-check-operator-string\"><span class=\"std std-ref\">get_check_operator_string</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_operation_string</l>(operation: <l2>Operation</l>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-operation-string\\\"><span class=\\\"std std-ref\\\">get_operation_string</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1388,
|
||
"tpl": "<l1>get_operation_string</l>(operation: <l2>Operation</l>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-operation-string\"><span class=\"std std-ref\">get_operation_string</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_status_name</l>(status: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-status-name\\\"><span class=\\\"std std-ref\\\">get_status_name</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1389,
|
||
"tpl": "<l1>get_status_name</l>(status: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-status-name\"><span class=\"std std-ref\">get_status_name</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>get_task_icon</l>(class_or_script_path: <2/>) <3/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-task-icon\\\"><span class=\\\"std std-ref\\\">get_task_icon</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\"}": {
|
||
"uid": 1390,
|
||
"tpl": "<l1>get_task_icon</l>(class_or_script_path: <2/>) <3/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-task-icon\"><span class=\"std std-ref\">get_task_icon</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>"
|
||
}
|
||
},
|
||
"<l1>perform_check</l>(check: <l2>CheckType</l>, a: <3/>, b: <4/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-perform-check\\\"><span class=\\\"std std-ref\\\">perform_check</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\"}": {
|
||
"uid": 1391,
|
||
"tpl": "<l1>perform_check</l>(check: <l2>CheckType</l>, a: <3/>, b: <4/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-perform-check\"><span class=\"std std-ref\">perform_check</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>"
|
||
}
|
||
},
|
||
"<l1>perform_operation</l>(operation: <l2>Operation</l>, a: <3/>, b: <4/>)\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-perform-operation\\\"><span class=\\\"std std-ref\\\">perform_operation</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\"}": {
|
||
"uid": 1392,
|
||
"tpl": "<l1>perform_operation</l>(operation: <l2>Operation</l>, a: <3/>, b: <4/>)",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-perform-operation\"><span class=\"std std-ref\">perform_operation</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>"
|
||
}
|
||
},
|
||
"enum <b>CheckType</b>: <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1393,
|
||
"tpl": "enum <b>CheckType</b>: <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>CheckType</l> <b>CHECK_EQUAL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\"}": {
|
||
"uid": 1394,
|
||
"tpl": "<l1>CheckType</l> <b>CHECK_EQUAL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>"
|
||
}
|
||
},
|
||
"Equality Check.\u0000{}": {
|
||
"uid": 1395,
|
||
"tpl": "Equality Check.",
|
||
"markers": {}
|
||
},
|
||
"<l1>CheckType</l> <b>CHECK_LESS_THAN</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\"}": {
|
||
"uid": 1396,
|
||
"tpl": "<l1>CheckType</l> <b>CHECK_LESS_THAN</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>"
|
||
}
|
||
},
|
||
"Less Than Check.\u0000{}": {
|
||
"uid": 1397,
|
||
"tpl": "Less Than Check.",
|
||
"markers": {}
|
||
},
|
||
"<l1>CheckType</l> <b>CHECK_LESS_THAN_OR_EQUAL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">2</span></code>\"}": {
|
||
"uid": 1398,
|
||
"tpl": "<l1>CheckType</l> <b>CHECK_LESS_THAN_OR_EQUAL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">2</span></code>"
|
||
}
|
||
},
|
||
"Less Than or Equal To Check.\u0000{}": {
|
||
"uid": 1399,
|
||
"tpl": "Less Than or Equal To Check.",
|
||
"markers": {}
|
||
},
|
||
"<l1>CheckType</l> <b>CHECK_GREATER_THAN</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">3</span></code>\"}": {
|
||
"uid": 1400,
|
||
"tpl": "<l1>CheckType</l> <b>CHECK_GREATER_THAN</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">3</span></code>"
|
||
}
|
||
},
|
||
"Greater Than Check.\u0000{}": {
|
||
"uid": 1401,
|
||
"tpl": "Greater Than Check.",
|
||
"markers": {}
|
||
},
|
||
"<l1>CheckType</l> <b>CHECK_GREATER_THAN_OR_EQUAL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">4</span></code>\"}": {
|
||
"uid": 1402,
|
||
"tpl": "<l1>CheckType</l> <b>CHECK_GREATER_THAN_OR_EQUAL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">4</span></code>"
|
||
}
|
||
},
|
||
"Greater Than or Equal To Check\u0000{}": {
|
||
"uid": 1403,
|
||
"tpl": "Greater Than or Equal To Check",
|
||
"markers": {}
|
||
},
|
||
"<l1>CheckType</l> <b>CHECK_NOT_EQUAL</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">5</span></code>\"}": {
|
||
"uid": 1404,
|
||
"tpl": "<l1>CheckType</l> <b>CHECK_NOT_EQUAL</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">5</span></code>"
|
||
}
|
||
},
|
||
"Inequality Check.\u0000{}": {
|
||
"uid": 1405,
|
||
"tpl": "Inequality Check.",
|
||
"markers": {}
|
||
},
|
||
"enum <b>Operation</b>: <l1>🔗</l>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1406,
|
||
"tpl": "enum <b>Operation</b>: <l1>🔗</l>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_NONE</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">0</span></code>\"}": {
|
||
"uid": 1407,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_NONE</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">0</span></code>"
|
||
}
|
||
},
|
||
"No operation.\u0000{}": {
|
||
"uid": 1408,
|
||
"tpl": "No operation.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_ADDITION</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">1</span></code>\"}": {
|
||
"uid": 1409,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_ADDITION</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">1</span></code>"
|
||
}
|
||
},
|
||
"Arithmetic addition.\u0000{}": {
|
||
"uid": 1410,
|
||
"tpl": "Arithmetic addition.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_SUBTRACTION</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">2</span></code>\"}": {
|
||
"uid": 1411,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_SUBTRACTION</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">2</span></code>"
|
||
}
|
||
},
|
||
"Arithmetic subtraction.\u0000{}": {
|
||
"uid": 1412,
|
||
"tpl": "Arithmetic subtraction.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_MULTIPLICATION</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">3</span></code>\"}": {
|
||
"uid": 1413,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_MULTIPLICATION</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">3</span></code>"
|
||
}
|
||
},
|
||
"Arithmetic multiplication.\u0000{}": {
|
||
"uid": 1414,
|
||
"tpl": "Arithmetic multiplication.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_DIVISION</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">4</span></code>\"}": {
|
||
"uid": 1415,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_DIVISION</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">4</span></code>"
|
||
}
|
||
},
|
||
"Arithmetic division.\u0000{}": {
|
||
"uid": 1416,
|
||
"tpl": "Arithmetic division.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_MODULO</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">5</span></code>\"}": {
|
||
"uid": 1417,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_MODULO</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">5</span></code>"
|
||
}
|
||
},
|
||
"Produces the remainder of an integer division.\u0000{}": {
|
||
"uid": 1418,
|
||
"tpl": "Produces the remainder of an integer division.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_POWER</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">6</span></code>\"}": {
|
||
"uid": 1419,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_POWER</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">6</span></code>"
|
||
}
|
||
},
|
||
"Multiply <1/> by itself <2/> times.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">a</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">b</span></code>\"}": {
|
||
"uid": 1420,
|
||
"tpl": "Multiply <1/> by itself <2/> times.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">a</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">b</span></code>"
|
||
}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_BIT_SHIFT_LEFT</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">7</span></code>\"}": {
|
||
"uid": 1421,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_BIT_SHIFT_LEFT</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">7</span></code>"
|
||
}
|
||
},
|
||
"Bitwise left shift.\u0000{}": {
|
||
"uid": 1422,
|
||
"tpl": "Bitwise left shift.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_BIT_SHIFT_RIGHT</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">8</span></code>\"}": {
|
||
"uid": 1423,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_BIT_SHIFT_RIGHT</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">8</span></code>"
|
||
}
|
||
},
|
||
"Bitwise right shift.\u0000{}": {
|
||
"uid": 1424,
|
||
"tpl": "Bitwise right shift.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_BIT_AND</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">9</span></code>\"}": {
|
||
"uid": 1425,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_BIT_AND</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">9</span></code>"
|
||
}
|
||
},
|
||
"Bitwise AND.\u0000{}": {
|
||
"uid": 1426,
|
||
"tpl": "Bitwise AND.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_BIT_OR</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">10</span></code>\"}": {
|
||
"uid": 1427,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_BIT_OR</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">10</span></code>"
|
||
}
|
||
},
|
||
"Bitwise OR.\u0000{}": {
|
||
"uid": 1428,
|
||
"tpl": "Bitwise OR.",
|
||
"markers": {}
|
||
},
|
||
"<l1>Operation</l> <b>OPERATION_BIT_XOR</b> = <2/>\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">11</span></code>\"}": {
|
||
"uid": 1429,
|
||
"tpl": "<l1>Operation</l> <b>OPERATION_BIT_XOR</b> = <2/>",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">11</span></code>"
|
||
}
|
||
},
|
||
"Bitwise XOR.\u0000{}": {
|
||
"uid": 1430,
|
||
"tpl": "Bitwise XOR.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>decorate_output_var</b>(variable: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-decorate-output-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1431,
|
||
"tpl": "<1/> <b>decorate_output_var</b>(variable: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limboutility-method-decorate-output-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Just like <l1>decorate_var</l>, produces a string with a <l2>Blackboard</l> variable name that is formatted for display, and also adds an additional symbol to indicate that the variable is used as an output.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-decorate-var\\\"><span class=\\\"std std-ref\\\">decorate_var</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 1432,
|
||
"tpl": "Just like <l1>decorate_var</l>, produces a string with a <l2>Blackboard</l> variable name that is formatted for display, and also adds an additional symbol to indicate that the variable is used as an output.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#class-limboutility-method-decorate-var\"><span class=\"std std-ref\">decorate_var</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>decorate_var</b>(variable: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-decorate-var\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1433,
|
||
"tpl": "<1/> <b>decorate_var</b>(variable: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limboutility-method-decorate-var\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Produces a string with a <l1>Blackboard</l> variable name that is formatted for display or console output.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_blackboard#class-blackboard\\\"><span class=\\\"std std-ref\\\">Blackboard</span></a>\"}": {
|
||
"uid": 1434,
|
||
"tpl": "Produces a string with a <l1>Blackboard</l> variable name that is formatted for display or console output.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_blackboard#class-blackboard\"><span class=\"std std-ref\">Blackboard</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_check_operator_string</b>(check: <l2>CheckType</l>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-check-operator-string\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1435,
|
||
"tpl": "<1/> <b>get_check_operator_string</b>(check: <l2>CheckType</l>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-check-operator-string\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns an operator string for a <l1>CheckType</l> enum value. For example, <l2>CHECK_EQUAL</l> returns “==”.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-constant-check-equal\\\"><span class=\\\"std std-ref\\\">CHECK_EQUAL</span></a>\"}": {
|
||
"uid": 1436,
|
||
"tpl": "Returns an operator string for a <l1>CheckType</l> enum value. For example, <l2>CHECK_EQUAL</l> returns “==”.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"2": "<a class=\"reference internal\" href=\"#class-limboutility-constant-check-equal\"><span class=\"std std-ref\">CHECK_EQUAL</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_operation_string</b>(operation: <l2>Operation</l>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-operation-string\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1437,
|
||
"tpl": "<1/> <b>get_operation_string</b>(operation: <l2>Operation</l>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-operation-string\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns a string representation of an <l1>Operation</l> enum value.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\"}": {
|
||
"uid": 1438,
|
||
"tpl": "Returns a string representation of an <l1>Operation</l> enum value.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_status_name</b>(status: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">int</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-status-name\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1439,
|
||
"tpl": "<1/> <b>get_status_name</b>(status: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">int</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-status-name\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns a name of a <l1>BTTask</l> status code.\u0000{\"1\": \"<a class=\\\"reference internal\\\" href=\\\"#document-classes/class_bttask#class-bttask\\\"><span class=\\\"std std-ref\\\">BTTask</span></a>\"}": {
|
||
"uid": 1440,
|
||
"tpl": "Returns a name of a <l1>BTTask</l> status code.",
|
||
"markers": {
|
||
"1": "<a class=\"reference internal\" href=\"#document-classes/class_bttask#class-bttask\"><span class=\"std std-ref\">BTTask</span></a>"
|
||
}
|
||
},
|
||
"<1/> <b>get_task_icon</b>(class_or_script_path: <2/>) <3/> <l4>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Texture2D</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">String</span></code>\", \"3\": \"<abbr title=\\\"This method has no side effects. It doesn't modify any of the instance's member variables.\\\">const</abbr>\", \"4\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-get-task-icon\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1441,
|
||
"tpl": "<1/> <b>get_task_icon</b>(class_or_script_path: <2/>) <3/> <l4>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Texture2D</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">String</span></code>",
|
||
"3": "<abbr title=\"This method has no side effects. It doesn't modify any of the instance's member variables.\">const</abbr>",
|
||
"4": "<a class=\"reference internal\" href=\"#class-limboutility-method-get-task-icon\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Returns the icon texture associated with a task based on its class name or script resource path.\u0000{}": {
|
||
"uid": 1442,
|
||
"tpl": "Returns the icon texture associated with a task based on its class name or script resource path.",
|
||
"markers": {}
|
||
},
|
||
"<1/> <b>perform_check</b>(check: <l2>CheckType</l>, a: <3/>, b: <4/>) <l5>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">bool</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-checktype\\\"><span class=\\\"std std-ref\\\">CheckType</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-perform-check\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1443,
|
||
"tpl": "<1/> <b>perform_check</b>(check: <l2>CheckType</l>, a: <3/>, b: <4/>) <l5>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">bool</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-checktype\"><span class=\"std std-ref\">CheckType</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-limboutility-method-perform-check\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Performs a <1/> on two values, <2/> and <3/>, and returns <4/> if the check passes.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">check</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">a</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">b</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">true</span></code>\"}": {
|
||
"uid": 1444,
|
||
"tpl": "Performs a <1/> on two values, <2/> and <3/>, and returns <4/> if the check passes.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">check</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">a</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">b</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">true</span></code>"
|
||
}
|
||
},
|
||
"<1/> <b>perform_operation</b>(operation: <l2>Operation</l>, a: <3/>, b: <4/>) <l5>🔗</l>\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"2\": \"<a class=\\\"reference internal\\\" href=\\\"#enum-limboutility-operation\\\"><span class=\\\"std std-ref\\\">Operation</span></a>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"4\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">Variant</span></code>\", \"5\": \"<a class=\\\"reference internal\\\" href=\\\"#class-limboutility-method-perform-operation\\\"><span class=\\\"std std-ref\\\">\\ud83d\\udd17</span></a>\"}": {
|
||
"uid": 1445,
|
||
"tpl": "<1/> <b>perform_operation</b>(operation: <l2>Operation</l>, a: <3/>, b: <4/>) <l5>🔗</l>",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"2": "<a class=\"reference internal\" href=\"#enum-limboutility-operation\"><span class=\"std std-ref\">Operation</span></a>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"4": "<code class=\"docutils literal notranslate\"><span class=\"pre\">Variant</span></code>",
|
||
"5": "<a class=\"reference internal\" href=\"#class-limboutility-method-perform-operation\"><span class=\"std std-ref\">🔗</span></a>"
|
||
}
|
||
},
|
||
"Performs an <1/> on two values, <2/> and <3/>, and returns the result.\u0000{\"1\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">operation</span></code>\", \"2\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">a</span></code>\", \"3\": \"<code class=\\\"docutils literal notranslate\\\"><span class=\\\"pre\\\">b</span></code>\"}": {
|
||
"uid": 1446,
|
||
"tpl": "Performs an <1/> on two values, <2/> and <3/>, and returns the result.",
|
||
"markers": {
|
||
"1": "<code class=\"docutils literal notranslate\"><span class=\"pre\">operation</span></code>",
|
||
"2": "<code class=\"docutils literal notranslate\"><span class=\"pre\">a</span></code>",
|
||
"3": "<code class=\"docutils literal notranslate\"><span class=\"pre\">b</span></code>"
|
||
}
|
||
},
|
||
"Getting started\u0000{}": {
|
||
"uid": 1447,
|
||
"tpl": "Getting started",
|
||
"markers": {}
|
||
},
|
||
"Behavior Trees\u0000{}": {
|
||
"uid": 1448,
|
||
"tpl": "Behavior Trees",
|
||
"markers": {}
|
||
},
|
||
"Hierarchical State MachineS\u0000{}": {
|
||
"uid": 1449,
|
||
"tpl": "Hierarchical State MachineS",
|
||
"markers": {}
|
||
},
|
||
"Class reference\u0000{}": {
|
||
"uid": 1450,
|
||
"tpl": "Class reference",
|
||
"markers": {}
|
||
},
|
||
"LimboAI 1.0 documentation\u0000{}": {
|
||
"uid": 1451,
|
||
"tpl": "LimboAI 1.0 documentation",
|
||
"markers": {}
|
||
}
|
||
}
|
||
} |