limboai/doc_classes/BTRunLimit.xml

18 lines
800 B
XML
Raw Normal View History

2022-11-01 20:31:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-04-10 14:57:36 +00:00
<class name="BTRunLimit" inherits="BTDecorator" version="4.1" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
2022-11-01 20:31:22 +00:00
<brief_description>
2022-11-04 12:27:09 +00:00
BT decorator that allows child's execution a limited number of times.
2022-11-01 20:31:22 +00:00
</brief_description>
<description>
2022-11-04 12:27:09 +00:00
BT decorator that allows child's execution a limited number of times defined by [member run_limit].
Returns [code]FAILURE[/code], if a limit on executions is exceeded. Otherwise, returns child's status.
2022-11-01 20:31:22 +00:00
</description>
<tutorials>
</tutorials>
<members>
<member name="run_limit" type="int" setter="set_run_limit" getter="get_run_limit" default="1">
2022-11-04 12:27:09 +00:00
A limit on number of times the child is allowed to be executed.
2022-11-01 20:31:22 +00:00
</member>
</members>
</class>