limboai/doc_classes/BTCallMethod.xml

27 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="BTCallMethod" inherits="BTAction" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
BT action that calls a method on a specified [Node] or [Object].
</brief_description>
<description>
BTCallMethod action calls a [member method] on the specified [Node] or [Object] instance and returns [code]SUCCESS[/code].
Returns [code]FAILURE[/code] if the action encounters an issue during the method execution.
</description>
<tutorials>
</tutorials>
<members>
<member name="args" type="Array" setter="set_args" getter="get_args" default="[]">
The arguments to be passed when calling the method.
</member>
<member name="include_delta" type="bool" setter="set_include_delta" getter="is_delta_included" default="false">
Include delta as a first parameter and shift the position of the rest of the arguments if any.
</member>
<member name="method" type="StringName" setter="set_method" getter="get_method" default="&amp;&quot;&quot;">
The name of the method to be called.
</member>
<member name="node" type="BBNode" setter="set_node_param" getter="get_node_param">
Specifies the [Node] or [Object] instance containing the method to be called.
</member>
</members>
</class>