Blackboard

BlackBoard~ Blackboard

new Blackboard()

Source:

Initialization method.

Members

_shared :Board

Source:
Type:

_trees :Object.<NodeId, TreeBoard>

Source:
Type:

shared

Source:

get shared board

trees :Object.<string, TreeBoard>

Source:

Get all TreeBoard

Type:

Methods

createTree(tree) → {undefined|TreeBoard}

Source:

Create new TreeBoard

Parameters:
Name Type Description
tree BehaviorTree | NodeId
Returns:
Type
undefined | TreeBoard

get(key) → {*}

Source:

Get data by using key

Parameters:
Name Type Description
key String

key

Returns:
Type
*

listTree() → {Array.<NodeId>}

Source:

Get list of BehaviorTree Id

Returns:
Type
Array.<NodeId>

removeTree(tree) → {boolean}

Source:

Remove specific TreeBoard

Parameters:
Name Type Description
tree BehaviorTree | NodeId
Returns:
Type
boolean

set(key, value)

Source:

Set data with key

Parameters:
Name Type Description
key String

key where store value

value *

value to store

toJSON() → {object}

Source:

Dump data in black in JSON

Returns:
Type
object

tree(tree, optsopt) → {TreeBoard}

Source:

Get tree board by treeId

Parameters:
Name Type Attributes Description
tree BaseNode | string

tree id

opts object <optional>

options

Properties
Name Type Attributes Default Description
safe boolean <optional>
false

if flag enabled, generate empty tree board when cannot find tree board

Returns:
Type
TreeBoard

BlackBoard~ Blackboard

new Blackboard()

Source:

The Blackboard is memory

Members

_shared :Board

Source:
Type:

_trees :Object.<NodeId, TreeBoard>

Source:
Type:

shared

Source:

get shared board

trees :Object.<string, TreeBoard>

Source:

Get all TreeBoard

Type:

Methods

createTree(tree) → {undefined|TreeBoard}

Source:

Create new TreeBoard

Parameters:
Name Type Description
tree BehaviorTree | NodeId
Returns:
Type
undefined | TreeBoard

get(key) → {*}

Source:

Get data by using key

Parameters:
Name Type Description
key String

key

Returns:
Type
*

listTree() → {Array.<NodeId>}

Source:

Get list of BehaviorTree Id

Returns:
Type
Array.<NodeId>

removeTree(tree) → {boolean}

Source:

Remove specific TreeBoard

Parameters:
Name Type Description
tree BehaviorTree | NodeId
Returns:
Type
boolean

set(key, value)

Source:

Set data with key

Parameters:
Name Type Description
key String

key where store value

value *

value to store

toJSON() → {object}

Source:

Dump data in black in JSON

Returns:
Type
object

tree(tree, optsopt) → {TreeBoard}

Source:

Get tree board by treeId

Parameters:
Name Type Attributes Description
tree BaseNode | string

tree id

opts object <optional>

options

Properties
Name Type Attributes Default Description
safe boolean <optional>
false

if flag enabled, generate empty tree board when cannot find tree board

Returns:
Type
TreeBoard