limboai/doc_classes/BlackboardPlan.xml

34 lines
1.7 KiB
XML
Raw Normal View History

2024-01-25 13:56:59 +00:00
<?xml version="1.0" encoding="UTF-8" ?>
<class name="BlackboardPlan" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
<brief_description>
Stores and manages variables that will be used in constructing new [Blackboard] instances.
</brief_description>
<description>
</description>
<tutorials>
</tutorials>
<methods>
<method name="create_blackboard">
<return type="Blackboard" />
2024-03-06 20:50:35 +00:00
<param index="0" name="node" type="Node" />
<description>
2024-03-06 20:50:35 +00:00
Constructs a new instance of a [Blackboard] using this plan. If [NodePath] prefetching is enabled, [param node] will be used to retrieve node instances for [NodePath] variables and substitute their values.
</description>
</method>
<method name="populate_blackboard">
<return type="void" />
<param index="0" name="blackboard" type="Blackboard" />
<param index="1" name="overwrite" type="bool" />
2024-03-06 20:50:35 +00:00
<param index="2" name="node" type="Node" />
<description>
2024-03-06 20:50:35 +00:00
Populates [param blackboard] with the variables from this plan. If [param overwrite] is [code]true[/code], existing variables with the same names will be overwritten. If [NodePath] prefetching is enabled, [param node] will be used to retrieve node instances for [NodePath] variables and substitute their values.
</description>
</method>
</methods>
2024-03-06 20:50:35 +00:00
<members>
<member name="prefetch_nodepath_vars" type="bool" setter="set_prefetch_nodepath_vars" getter="is_prefetching_nodepath_vars" default="true">
Enables or disables [NodePath] variable prefetching. If [code]true[/code], [NodePath] values will be replaced with node instances when the [Blackboard] is created.
</member>
</members>
2024-01-25 13:56:59 +00:00
</class>