2022-11-01 20:31:22 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
2023-11-15 14:40:07 +00:00
<class name= "BBParam" inherits= "Resource" xmlns:xsi= "http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation= "../../../doc/class.xsd" >
2022-11-01 20:31:22 +00:00
<brief_description >
2023-10-27 11:32:55 +00:00
A base class for LimboAI typed parameters.
2022-11-01 20:31:22 +00:00
</brief_description>
<description >
2023-10-27 11:32:55 +00:00
A base class for LimboAI typed parameters, with the ability to reference a [Blackboard] variable or hold a raw value of a specific [enum Variant.Type].
[b]Note[/b]: Don't instantiate. Use specific subtypes 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 >
2023-10-27 11:32:55 +00:00
Returns the expected data type of the parameter.
2022-11-01 20:31:22 +00:00
</description>
</method>
<method name= "get_value" >
<return type= "Variant" />
2024-03-04 20:36:16 +00:00
<param index= "0" name= "agent" type= "Object" />
<param index= "1" name= "blackboard" type= "Blackboard" />
<param index= "2" name= "default" type= "Variant" default= "null" />
2022-11-01 20:31:22 +00:00
<description >
2023-10-27 11:32:55 +00:00
Returns the value of the parameter.
2022-11-01 20:31:22 +00:00
</description>
</method>
</methods>
<members >
2023-08-07 13:30:04 +00:00
<member name= "saved_value" type= "Variant" setter= "set_saved_value" getter= "get_saved_value" default= "null" >
2023-10-27 11:32:55 +00:00
Stores the parameter value when [member value_source] is set to [constant SAVED_VALUE]. The data type of the value is determined by [method get_type].
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" >
2023-10-27 11:32:55 +00:00
Specifies the source of the value for BBParam. See [enum ValueSource].
2022-11-01 20:31:22 +00:00
</member>
2024-03-04 15:14:47 +00:00
<member name= "variable" type= "StringName" setter= "set_variable" getter= "get_variable" >
2023-10-27 11:32:55 +00:00
Stores the name of a [Blackboard] variable when [member value_source] is set to [constant BLACKBOARD_VAR].
2022-11-01 20:31:22 +00:00
</member>
</members>
<constants >
<constant name= "SAVED_VALUE" value= "0" enum= "ValueSource" >
2023-10-27 11:32:55 +00:00
The value is stored directly within the BBParam resource.
2022-11-01 20:31:22 +00:00
</constant>
<constant name= "BLACKBOARD_VAR" value= "1" enum= "ValueSource" >
2023-10-27 11:32:55 +00:00
The value is referenced by a variable name and retrieved from the [Blackboard]. The variable name is stored within the BBParam resource.
2022-11-01 20:31:22 +00:00
</constant>
</constants>
</class>
