API Documentation for:
Show:

Limiter

Defined in: Limiter:5
Module: b3

This decorator limit the number of times its child can be called. After a certain number of times, the Limiter decorator returns FAILURE without executing the child.

Item Index

Methods

Properties

Methods

initialize

(
  • params
)

Defined in initialize:38

Initialization method.

Settings parameters:

  • maxLoop (Integer) Maximum number of repetitions.
  • child (BaseNode) The child node.

Parameters:

  • params Object

    Object with parameters.

open

(
  • tick
)

Defined in open:61

Open method.

Parameters:

  • tick Tick

    A tick instance.

tick

(
  • tick
)
Constant

Defined in tick:70

Tick method.

Parameters:

  • tick Tick

    A tick instance.

Returns:

Constant:

A state constant.

Properties

name

String

Defined in name:17

Node name. Default to Limiter.

parameters

String

Defined in parameters:31

Node parameters.

title

String

Defined in title:24

Node title. Default to Limit X Activations. Used in Editor.