:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/4.3/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/4.3/modules/limboai/doc_classes/BBParam.xml. .. _class_BBParam: BBParam ======= **Inherits:** **Inherited By:** :ref:`BBAabb<class_BBAabb>`, :ref:`BBArray<class_BBArray>`, :ref:`BBBasis<class_BBBasis>`, :ref:`BBBool<class_BBBool>`, :ref:`BBByteArray<class_BBByteArray>`, :ref:`BBColor<class_BBColor>`, :ref:`BBColorArray<class_BBColorArray>`, :ref:`BBDictionary<class_BBDictionary>`, :ref:`BBFloat<class_BBFloat>`, :ref:`BBFloat32Array<class_BBFloat32Array>`, :ref:`BBFloat64Array<class_BBFloat64Array>`, :ref:`BBInt<class_BBInt>`, :ref:`BBInt32Array<class_BBInt32Array>`, :ref:`BBInt64Array<class_BBInt64Array>`, :ref:`BBNode<class_BBNode>`, :ref:`BBPlane<class_BBPlane>`, :ref:`BBProjection<class_BBProjection>`, :ref:`BBQuaternion<class_BBQuaternion>`, :ref:`BBRect2<class_BBRect2>`, :ref:`BBRect2i<class_BBRect2i>`, :ref:`BBString<class_BBString>`, :ref:`BBStringArray<class_BBStringArray>`, :ref:`BBStringName<class_BBStringName>`, :ref:`BBTransform2D<class_BBTransform2D>`, :ref:`BBTransform3D<class_BBTransform3D>`, :ref:`BBVariant<class_BBVariant>`, :ref:`BBVector2<class_BBVector2>`, :ref:`BBVector2Array<class_BBVector2Array>`, :ref:`BBVector2i<class_BBVector2i>`, :ref:`BBVector3<class_BBVector3>`, :ref:`BBVector3Array<class_BBVector3Array>`, :ref:`BBVector3i<class_BBVector3i>`, :ref:`BBVector4<class_BBVector4>`, :ref:`BBVector4i<class_BBVector4i>` A base class for LimboAI typed parameters. .. rst-class:: classref-introduction-group Description ----------- A base class for LimboAI typed parameters, with the ability to reference a :ref:`Blackboard<class_Blackboard>` variable or hold a raw value of a specific :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>`. \ **Note**: Don't instantiate. Use specific subtypes instead. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------+----------------------------------------------------------+----------+ | ``Variant`` | :ref:`saved_value<class_BBParam_property_saved_value>` | ``null`` | +----------------------------------------------+----------------------------------------------------------+----------+ | :ref:`ValueSource<enum_BBParam_ValueSource>` | :ref:`value_source<class_BBParam_property_value_source>` | ``0`` | +----------------------------------------------+----------------------------------------------------------+----------+ | ``StringName`` | :ref:`variable<class_BBParam_property_variable>` | | +----------------------------------------------+----------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` | :ref:`get_type<class_BBParam_method_get_type>`\ (\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``Variant`` | :ref:`get_value<class_BBParam_method_get_value>`\ (\ scene_root\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, default\: ``Variant`` = null\ ) | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Enumerations ------------ .. _enum_BBParam_ValueSource: .. rst-class:: classref-enumeration enum **ValueSource**: :ref:`🔗<enum_BBParam_ValueSource>` .. _class_BBParam_constant_SAVED_VALUE: .. rst-class:: classref-enumeration-constant :ref:`ValueSource<enum_BBParam_ValueSource>` **SAVED_VALUE** = ``0`` The value is stored directly within the BBParam resource. .. _class_BBParam_constant_BLACKBOARD_VAR: .. rst-class:: classref-enumeration-constant :ref:`ValueSource<enum_BBParam_ValueSource>` **BLACKBOARD_VAR** = ``1`` The value is referenced by a variable name and retrieved from the :ref:`Blackboard<class_Blackboard>`. The variable name is stored within the BBParam resource. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_BBParam_property_saved_value: .. rst-class:: classref-property ``Variant`` **saved_value** = ``null`` :ref:`🔗<class_BBParam_property_saved_value>` .. rst-class:: classref-property-setget - |void| **set_saved_value**\ (\ value\: ``Variant``\ ) - ``Variant`` **get_saved_value**\ (\ ) Stores the parameter value when :ref:`value_source<class_BBParam_property_value_source>` is set to :ref:`SAVED_VALUE<class_BBParam_constant_SAVED_VALUE>`. The data type of the value is determined by :ref:`get_type<class_BBParam_method_get_type>`. .. rst-class:: classref-item-separator ---- .. _class_BBParam_property_value_source: .. rst-class:: classref-property :ref:`ValueSource<enum_BBParam_ValueSource>` **value_source** = ``0`` :ref:`🔗<class_BBParam_property_value_source>` .. rst-class:: classref-property-setget - |void| **set_value_source**\ (\ value\: :ref:`ValueSource<enum_BBParam_ValueSource>`\ ) - :ref:`ValueSource<enum_BBParam_ValueSource>` **get_value_source**\ (\ ) Specifies the source of the value for BBParam. See :ref:`ValueSource<enum_BBParam_ValueSource>`. .. rst-class:: classref-item-separator ---- .. _class_BBParam_property_variable: .. rst-class:: classref-property ``StringName`` **variable** :ref:`🔗<class_BBParam_property_variable>` .. rst-class:: classref-property-setget - |void| **set_variable**\ (\ value\: ``StringName``\ ) - ``StringName`` **get_variable**\ (\ ) Stores the name of a :ref:`Blackboard<class_Blackboard>` variable when :ref:`value_source<class_BBParam_property_value_source>` is set to :ref:`BLACKBOARD_VAR<class_BBParam_constant_BLACKBOARD_VAR>`. .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_BBParam_method_get_type: .. rst-class:: classref-method :ref:`Variant.Type<enum_@GlobalScope_Variant.Type>` **get_type**\ (\ ) |const| :ref:`🔗<class_BBParam_method_get_type>` Returns the expected data type of the parameter. .. rst-class:: classref-item-separator ---- .. _class_BBParam_method_get_value: .. rst-class:: classref-method ``Variant`` **get_value**\ (\ scene_root\: ``Node``, blackboard\: :ref:`Blackboard<class_Blackboard>`, default\: ``Variant`` = null\ ) :ref:`🔗<class_BBParam_method_get_value>` Returns the value of the parameter. .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)` .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)` .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)` .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)` .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`