Class OptionType

Composite callback option type — combines include and exclude CbType lists to express complex listener filter conditions.

An interaction satisfies an OptionType when the interactor has at least one of the included types and none of the excluded types.

Example

// Listen only for bodies that are "enemy" but not "boss"
const filter = new OptionType(enemyType).excluding(bossType);
const listener = new BodyListener(CbEvent.WAKE, filter, (cb) => { ... });

Converted from nape-compiled.js lines 2647–2698.

Index

Constructors

constructor

new OptionType(
includes?: CbType | OptionType,
excludes?: CbType | OptionType,
): OptionType
Creates an OptionType optionally seeded with initial include/exclude entries.
Parameters
- Optionalincludes: CbType | OptionType
  Initial type(s) to include.
- Optionalexcludes: CbType | OptionType
  Initial type(s) to exclude.
Returns OptionType
- Defined in src/callbacks/OptionType.ts:38

Accessors

excludes

get excludes(): object
Live list of CbTypes that an interactor must have none of.

Returns object
- Defined in src/callbacks/OptionType.ts:63

includes

get includes(): object
Live list of CbTypes that an interactor must have at least one of.

Returns object
- Defined in src/callbacks/OptionType.ts:55

Methods

excluding

excluding(excludes: CbType | OptionType): this
Adds excludes to the exclude list and returns this for chaining.
Parameters
- excludes: CbType | OptionType
  CbType or OptionType whose types should be added to excludes.
Returns this
- Defined in src/callbacks/OptionType.ts:89

including

including(includes: CbType | OptionType): this
Adds includes to the include list and returns this for chaining.
Parameters
- includes: CbType | OptionType
  CbType or OptionType whose types should be added to includes.
Returns this
- Defined in src/callbacks/OptionType.ts:79

toString

toString(): string
Returns string
- Defined in src/callbacks/OptionType.ts:94

Class OptionType

Example

Index

Constructors

Accessors

Methods

Constructors

constructor

Parameters

Returns OptionType

Accessors

excludes

Returns object

includes

Returns object

Methods

excluding

Parameters

Returns this

including

Parameters

Returns this

toString

Returns string

Settings

On This Page