limboai/doc_classes/BlackboardPlan.xml

27 lines
1006 B
XML

<?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" />
<description>
Constructs a new instance of a [Blackboard] using this plan.
</description>
</method>
<method name="populate_blackboard">
<return type="void" />
<param index="0" name="p_blackboard" type="Blackboard" />
<param index="1" name="p_overwrite" type="bool" />
<description>
Populates [param p_blackboard] with the variables from this plan. If [param p_overwrite] is [code]true[/code], existing variables with the same names will be overwritten.
</description>
</method>
</methods>
</class>