:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/modules/limboai/doc_classes/BBParam.xml. .. _class_BBParam: BBParam ======= **Inherits:** **Inherited By:** :ref:`BBAabb`, :ref:`BBArray`, :ref:`BBBasis`, :ref:`BBBool`, :ref:`BBByteArray`, :ref:`BBColor`, :ref:`BBColorArray`, :ref:`BBDictionary`, :ref:`BBFloat`, :ref:`BBFloat32Array`, :ref:`BBFloat64Array`, :ref:`BBInt`, :ref:`BBInt32Array`, :ref:`BBInt64Array`, :ref:`BBNode`, :ref:`BBPlane`, :ref:`BBProjection`, :ref:`BBQuaternion`, :ref:`BBRect2`, :ref:`BBRect2i`, :ref:`BBString`, :ref:`BBStringArray`, :ref:`BBStringName`, :ref:`BBTransform2D`, :ref:`BBTransform3D`, :ref:`BBVariant`, :ref:`BBVector2`, :ref:`BBVector2Array`, :ref:`BBVector2i`, :ref:`BBVector3`, :ref:`BBVector3Array`, :ref:`BBVector3i`, :ref:`BBVector4`, :ref:`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` variable or hold a raw value of a specific :ref:`Variant.Type`. \ **Note**: Don't instantiate. Use specific subtypes instead. .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +----------------------------------------------+----------------------------------------------------------+----------+ | ``Variant`` | :ref:`saved_value` | ``null`` | +----------------------------------------------+----------------------------------------------------------+----------+ | :ref:`ValueSource` | :ref:`value_source` | ``0`` | +----------------------------------------------+----------------------------------------------------------+----------+ | ``StringName`` | :ref:`variable` | | +----------------------------------------------+----------------------------------------------------------+----------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Variant.Type` | :ref:`get_type`\ (\ ) |const| | +-----------------------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``Variant`` | :ref:`get_value`\ (\ scene_root\: ``Node``, blackboard\: :ref:`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:`🔗` .. _class_BBParam_constant_SAVED_VALUE: .. rst-class:: classref-enumeration-constant :ref:`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` **BLACKBOARD_VAR** = ``1`` The value is referenced by a variable name and retrieved from the :ref:`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:`🔗` .. rst-class:: classref-property-setget - |void| **set_saved_value**\ (\ value\: ``Variant``\ ) - ``Variant`` **get_saved_value**\ (\ ) Stores the parameter value when :ref:`value_source` is set to :ref:`SAVED_VALUE`. The data type of the value is determined by :ref:`get_type`. .. rst-class:: classref-item-separator ---- .. _class_BBParam_property_value_source: .. rst-class:: classref-property :ref:`ValueSource` **value_source** = ``0`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_value_source**\ (\ value\: :ref:`ValueSource`\ ) - :ref:`ValueSource` **get_value_source**\ (\ ) Specifies the source of the value for BBParam. See :ref:`ValueSource`. .. rst-class:: classref-item-separator ---- .. _class_BBParam_property_variable: .. rst-class:: classref-property ``StringName`` **variable** :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_variable**\ (\ value\: ``StringName``\ ) - ``StringName`` **get_variable**\ (\ ) Stores the name of a :ref:`Blackboard` variable when :ref:`value_source` is set to :ref:`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` **get_type**\ (\ ) |const| :ref:`🔗` 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`, default\: ``Variant`` = null\ ) :ref:`🔗` 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.)`