limboai/doc_classes/BTCallMethod.xml

30 lines
1.5 KiB
XML
Raw Permalink Normal View History

2023-08-15 11:29:12 +00:00
<?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">
2023-08-15 11:29:12 +00:00
<brief_description>
2023-09-05 08:55:17 +00:00
BT action that calls a method on a specified [Node] or [Object].
2023-08-15 11:29:12 +00:00
</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.
2023-08-15 11:29:12 +00:00
</description>
<tutorials>
</tutorials>
<members>
<member name="args" type="BBVariant[]" setter="set_args" getter="get_args" default="[]">
The arguments to be passed when calling the method.
2023-08-15 11:29:12 +00:00
</member>
<member name="args_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.
2023-08-15 11:29:12 +00:00
</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.
2023-08-15 11:29:12 +00:00
</member>
<member name="result_var" type="String" setter="set_result_var" getter="get_result_var" default="&quot;&quot;">
if non-empty, assign the result of the method call to the blackboard variable specified by this property.
</member>
2023-08-15 11:29:12 +00:00
</members>
</class>