API Documentation for:
Show:

Condition

Extends BaseNode
Defined in: Condition:5
Module: b3

Condition is the base class for all condition nodes. Thus, if you want to create new custom condition nodes, you need to inherit from this class.

Methods

_close

(
  • tick
)
protected

Inherited from BaseNode: _close:178

Wrapper for close method.

Parameters:

  • tick Tick

    A tick instance.

_enter

(
  • tick
)
protected

Inherited from BaseNode: _enter:143

Wrapper for enter method.

Parameters:

  • tick Tick

    A tick instance.

_execute

(
  • tick
)
Constant protected

Inherited from BaseNode: _execute:108

This is the main method to propagate the tick signal to this node. This method calls all callbacks: enter, open, tick, close, and exit. It only opens a node if it is not already open. In the same way, this method only close a node if the node returned a status different of RUNNING.

Parameters:

  • tick Tick

    A tick instance.

Returns:

Constant:

The tick state.

_exit

(
  • tick
)
protected

Inherited from BaseNode: _exit:190

Wrapper for exit method.

Parameters:

  • tick Tick

    A tick instance.

_open

(
  • tick
)
protected

Inherited from BaseNode: _open:154

Wrapper for open method.

Parameters:

  • tick Tick

    A tick instance.

_tick

(
  • tick
)
Constant protected

Inherited from BaseNode: _tick:166

Wrapper for tick method.

Parameters:

  • tick Tick

    A tick instance.

Returns:

Constant:

A state constant.

close

(
  • tick
)

Inherited from BaseNode: close:231

Close method, override this to use. This method is called after the tick callback, and only if the tick return a state different from RUNNING.

Parameters:

  • tick Tick

    A tick instance.

enter

(
  • tick
)

Inherited from BaseNode: enter:201

Enter method, override this to use. It is called every time a node is asked to execute, before the tick itself.

Parameters:

  • tick Tick

    A tick instance.

exit

(
  • tick
)

Inherited from BaseNode: exit:241

Exit method, override this to use. Called every time in the end of the execution.

Parameters:

  • tick Tick

    A tick instance.

initialize

()

Inherited from BaseNode but overwritten in initialize:22

Initialization method.

open

(
  • tick
)

Inherited from BaseNode: open:210

Open method, override this to use. It is called only before the tick callback and only if the not isn't closed.

Note: a node will be closed if it returned RUNNING in the tick.

Parameters:

  • tick Tick

    A tick instance.

tick

(
  • tick
)

Inherited from BaseNode: tick:221

Tick method, override this to use. This method must contain the real execution of node (perform a task, call children, etc.). It is called every time a node is asked to execute.

Parameters:

  • tick Tick

    A tick instance.

Properties

category

String

Inherited from BaseNode but overwritten in category:15

Node category. Default to b3.CONDITION.

description

String

Inherited from BaseNode: description:62

Node description.

id

String

Inherited from BaseNode: id:28

Node ID.

name

String

Inherited from BaseNode: name:35

Node name. Must be a unique identifier, preferable the same name of the class. You have to set the node name in the prototype.

parameters

Object deprecated

Inherited from BaseNode: parameters:70

Deprecated: since 0.2.0.

A dictionary (key, value) describing the node parameters. Useful for defining parameter values in the visual editor. Note: this is only useful for nodes when loading trees from JSON files.

Deprecated since 0.2.0. This is too similar to the properties attribute, thus, this attribute is deprecated in favor to properties.

properties

Object

Inherited from BaseNode: properties:85

A dictionary (key, value) describing the node properties. Useful for defining custom variables inside the visual editor.

title

String

Inherited from BaseNode: title:54

Node title.