Class StoryboardBaseEncoder Abstract

The base of per-section storyboard encoders.

Hierarchy

BaseEncoder
- StoryboardBaseEncoder

Index

Constructors

constructor

Properties

Methods

encode

Constructors

constructor

new StoryboardBaseEncoder(storyboard: Storyboard, encodeSections?: boolean): StoryboardBaseEncoder

Overrides BaseEncoder.constructor
- Defined in osu-base/src/beatmap/encoder/storyboard/StoryboardBaseEncoder.ts:13
Parameters
- storyboard: Storyboard
- encodeSections: boolean = true
Returns StoryboardBaseEncoder

Properties

Readonly encodeSections

encodeSections: boolean

Whether sections should be encoded. Defaults to true.

Readonly storyboard

storyboard: Storyboard

The storyboard that is being encoded.

Methods

encode

encode(): string

Inherited from BaseEncoder.encode
- Defined in osu-base/src/beatmap/encoder/SectionEncoder.ts:24
Performs the encoding process.

Returns string
The result.

Generated using TypeDoc