limboai/doc_classes/BTProbability.xml

18 lines
792 B
XML
Raw Normal View History

2022-11-01 20:31:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTProbability" inherits="BTDecorator" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2022-11-01 20:31:22 +00:00
<brief_description>
BT decorator that executes its child task with a given probability.
2022-11-01 20:31:22 +00:00
</brief_description>
<description>
BTProbability executes its child task with a given probability defined by [member run_chance].
Returns the result of the child task if it was executed; otherwise, it returns [code]FAILURE[/code].
2022-11-01 20:31:22 +00:00
</description>
<tutorials>
</tutorials>
<members>
<member name="run_chance" type="float" setter="set_run_chance" getter="get_run_chance" default="0.5">
2023-07-20 20:15:30 +00:00
Probability that defines how likely the child task will be executed.
2022-11-01 20:31:22 +00:00
</member>
</members>
</class>