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= "BBParam" inherits= "Resource" 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
A base class for typed parameters to be used with BT tasks.
2022-11-01 20:31:22 +00:00
</brief_description>
<description >
2022-11-04 12:27:09 +00:00
A base class for typed parameters.
BBParam can store a blackboard variable name or a raw value of specific type.
*Note*: Don't instantiate. Use specific subclasses instead.
2022-11-01 20:31:22 +00:00
</description>
<tutorials >
</tutorials>
<methods >
<method name= "get_type" qualifiers= "const" >
<return type= "int" enum= "Variant.Type" />
<description >
2022-11-04 12:27:09 +00:00
Returns expected type of the parameter.
2022-11-01 20:31:22 +00:00
</description>
</method>
<method name= "get_value" >
<return type= "Variant" />
2023-04-10 14:57:36 +00:00
<param index= "0" name= "p_agent" type= "Object" />
<param index= "1" name= "p_blackboard" type= "Blackboard" />
<param index= "2" name= "p_default" type= "Variant" default= "null" />
2022-11-01 20:31:22 +00:00
<description >
2022-11-04 12:27:09 +00:00
Returns value of the parameter.
2022-11-01 20:31:22 +00:00
</description>
</method>
</methods>
<members >
2023-04-10 14:57:36 +00:00
<member name= "saved_value" type= "Variant" setter= "set_saved_value" getter= "get_saved_value" default= "0" >
2022-11-04 12:27:09 +00:00
A value that is saved with BBParam resource. The type of value is defined by [method get_type]. Provides the parameter's value, if [member value_source] is [constant SAVED_VALUE].
2022-11-01 20:31:22 +00:00
</member>
<member name= "value_source" type= "int" setter= "set_value_source" getter= "get_value_source" enum= "BBParam.ValueSource" default= "0" >
2022-11-04 12:27:09 +00:00
A source for the value of BBParam. See [enum ValueSource].
2022-11-01 20:31:22 +00:00
</member>
<member name= "variable" type= "String" setter= "set_variable" getter= "get_variable" >
2022-11-04 12:27:09 +00:00
A name of [Blackboard] variable. It is used to retrieve the parameter's value, if [member value_source] is [constant BLACKBOARD_VAR].
2022-11-01 20:31:22 +00:00
</member>
</members>
<constants >
<constant name= "SAVED_VALUE" value= "0" enum= "ValueSource" >
2022-11-04 12:27:09 +00:00
Value is stored directly with BBParam resource.
2022-11-01 20:31:22 +00:00
</constant>
<constant name= "BLACKBOARD_VAR" value= "1" enum= "ValueSource" >
2022-11-04 12:27:09 +00:00
Value is referenced by a variable name and retrieved from the [Blackboard]. A variable name is stored with BBParam resource.
2022-11-01 20:31:22 +00:00
</constant>
</constants>
</class>
