Class EventIterator

Fluent iterator that filters and transforms events across all lines.

Example

eventIterator()
  .onChannels('moveX', 'moveY')
  .between(0, 32)
  .process(ev => { ev.start *= -1; ev.end *= -1; })
  .run(chart);

Index

Constructors

constructor

Methods

addCondition after before between onLines onLineIndices onChannels addProcess process scaleValues negateValues offsetValues offsetBeats setEasing run

Constructors

constructor

new EventIterator(): EventIterator
Returns EventIterator

Methods

addCondition

addCondition(predicate: EventPredicate): this
Add a custom predicate.
Parameters
- predicate: EventPredicate
Returns this
- Defined in iterators.ts:833

after

after(beat: number): this
Limit to events that start at or after beat.
Parameters
- beat: number
Returns this
- Defined in iterators.ts:839

before

before(beat: number): this
Limit to events that start before beat.
Parameters
- beat: number
Returns this
- Defined in iterators.ts:844

between

between(start: number, end: number): this
Limit to events whose start beat is in [start, end).
Parameters
- start: number
- end: number
Returns this
- Defined in iterators.ts:851

onLines

onLines(predicate: LinePredicate): this
Limit to events on lines matching the given predicate.
Parameters
- predicate: LinePredicate
Returns this
- Defined in iterators.ts:861

onLineIndices

onLineIndices(...indices: number[]): this
Limit to events on lines at the given indices.
Parameters
- ...indices: number[]
Returns this
- Defined in iterators.ts:869

onChannels

onChannels(...channels: EventChannelType[]): this
Limit to specific event channels.
Parameters
- ...channels: EventChannelType[]
Returns this
Example
```
`.onChannels('moveX', 'moveY')`
```
Example
```
`.onChannels('extended')`
```
- Defined in iterators.ts:880
onChannels(filter: EventChannelFilter): this
Limit to specific event channels.
Parameters
- filter: EventChannelFilter
Returns this
Example
```
`.onChannels('moveX', 'moveY')`
```
Example
```
`.onChannels('extended')`
```
- Defined in iterators.ts:881

addProcess

addProcess(process: EventProcess): this
Add a custom process callback.
Parameters
- process: EventProcess
Returns this
- Defined in iterators.ts:894

process

process(fn: EventProcess): this
Shorthand for addProcess.
Parameters
- fn: EventProcess
Returns this
- Defined in iterators.ts:900

scaleValues

scaleValues(factor: number): this
Multiply start and end values by factor.
Parameters
- factor: number
Returns this
- Defined in iterators.ts:905

negateValues

negateValues(): this
Negate both start and end values (mirror).

Returns this
- Defined in iterators.ts:913

offsetValues

offsetValues(offset: number): this
Add offset to both start and end values.
Parameters
- offset: number
Returns this
- Defined in iterators.ts:918

offsetBeats

offsetBeats(beatOffset: number): this
Shift event start and end beats by beatOffset.
Parameters
- beatOffset: number
Returns this
- Defined in iterators.ts:926

setEasing

setEasing(
    easingType:
        | number
        | "linear"
        | "sineOut"
        | "sineIn"
        | "quadOut"
        | "quadIn"
        | "sineInOut"
        | "quadInOut"
        | "cubicOut"
        | "cubicIn"
        | "quartOut"
        | "quartIn"
        | "cubicInOut"
        | "quartInOut"
        | "quintOut"
        | "quintIn"
        | "expoOut"
        | "expoIn"
        | "circOut"
        | "circIn"
        | "backOut"
        | "backIn"
        | "circInOut"
        | "backInOut"
        | "elasticOut"
        | "elasticIn"
        | "bounceOut"
        | "bounceIn"
        | "bounceInOut",
): this
Set the easing type on all matched events.
Parameters
- easingType:
      | number
      | "linear"
      | "sineOut"
      | "sineIn"
      | "quadOut"
      | "quadIn"
      | "sineInOut"
      | "quadInOut"
      | "cubicOut"
      | "cubicIn"
      | "quartOut"
      | "quartIn"
      | "cubicInOut"
      | "quartInOut"
      | "quintOut"
      | "quintIn"
      | "expoOut"
      | "expoIn"
      | "circOut"
      | "circIn"
      | "backOut"
      | "backIn"
      | "circInOut"
      | "backInOut"
      | "elasticOut"
      | "elasticIn"
      | "bounceOut"
      | "bounceIn"
      | "bounceInOut"
Returns this
- Defined in iterators.ts:938

run

run(chart: RpeJson): number
Run the iterator over all events in the chart.
Parameters
- chart: RpeJson
Returns number
The number of events processed.
- Defined in iterators.ts:951

Class EventIterator

Example

Index

Constructors

Methods

Constructors

constructor

Returns EventIterator

Methods

addCondition

Parameters

Returns this

after

Parameters

Returns this

before

Parameters

Returns this

between

Parameters

Returns this

onLines

Parameters

Returns this

onLineIndices

Parameters

Returns this

onChannels

Parameters

Returns this

Example

Example

Parameters

Returns this

Example

Example

addProcess

Parameters

Returns this

process

Parameters

Returns this

scaleValues

Parameters

Returns this

negateValues

Returns this

offsetValues

Parameters

Returns this

offsetBeats

Parameters

Returns this

setEasing

Parameters

Returns this

run

Parameters

Returns number

Settings

On This Page