API Documentation for:
Show:

MaxTime

Defined in: MaxTime:5
Module: b3

The MaxTime decorator limits the maximum time the node child can execute. Notice that it does not interrupt the execution itself (i.e., the child must be non-preemptive), it only interrupts the node after a RUNNING status.

Item Index

Methods

Properties

Methods

initialize

(
  • params
)

Defined in initialize:39

Initialization method.

Settings parameters:

  • maxTime (Integer) Maximum time a child can execute.
  • child (BaseNode) The child node.

Parameters:

  • params Object

    Object with parameters.

open

(
  • tick
)

Defined in open:62

Open method.

Parameters:

  • tick Tick

    A tick instance.

tick

(
  • tick
)
Constant

Defined in tick:72

Tick method.

Parameters:

  • tick Tick

    A tick instance.

Returns:

Constant:

A state constant.

Properties

name

String

Defined in name:18

Node name. Default to MaxTime.

parameters

String

Defined in parameters:32

Node parameters.

title

String

Defined in title:25

Node title. Default to Max XXms. Used in Editor.