Enum ChartEvent 

pub enum ChartEvent {
    Note {
        side: PlayerSide,
        key: Key,
        kind: NoteKind,
        wav_id: Option<WavId>,
        length: Option<YCoordinate>,
        continue_play: bool,
    },
    Bgm {
        wav_id: Option<WavId>,
    },
    BpmChange {
        bpm: Decimal,
    },
    ScrollChange {
        factor: Decimal,
    },
    SpeedChange {
        factor: Decimal,
    },
    Stop {
        duration: Decimal,
    },
    BgaChange {
        layer: BgaLayer,
        bmp_id: Option<BmpId>,
    },
    BgaOpacityChange {
        layer: BgaLayer,
        opacity: u8,
    },
    BgaArgbChange {
        layer: BgaLayer,
        argb: u32,
    },
    BgmVolumeChange {
        volume: u8,
    },
    KeyVolumeChange {
        volume: u8,
    },
    TextDisplay {
        text: String,
    },
    JudgeLevelChange {
        level: JudgeLevel,
    },
    VideoSeek {
        seek_time: f64,
    },
    BgaKeybound {
        event: SwBgaEvent,
    },
    OptionChange {
        option: String,
    },
    BarLine,
}

Events generated during playback (Elm style).

These events represent actual events during chart playback, such as note triggers, BGM playback, BPM changes, etc. Setting and control related events have been separated into ControlEvent.

The effects of ChartEvent members on YCoordinate and DisplayRatio are calculated by the corresponding ChartProcessor implementation, so there’s no need to recalculate them.

Variants

Note

Key note reaches judgment line (includes visible, long, mine, invisible notes, distinguished by kind)

Fields

side: PlayerSide

Player side

key: Key

Key position

kind: NoteKind

Note type (NoteKind)

wav_id: Option<WavId>

Corresponding sound resource ID (if any)

length: Option<YCoordinate>

Note length (end position for long notes, None for regular notes)

continue_play: bool

Note continue play flag (fixed as false for BMS, based on Note.c field for BMSON)

Bgm

BGM and other non-key triggers (no valid side/key)

Fields

wav_id: Option<WavId>

Corresponding sound resource ID (if any)

BpmChange

BPM change

Fields

bpm: Decimal

New BPM value (beats per minute)

ScrollChange

Scroll factor change

Fields

factor: Decimal

Scroll factor (relative value)

SpeedChange

Speed factor change

Fields

factor: Decimal

Spacing factor (relative value)

Stop

Stop scroll event

Fields

duration: Decimal

Stop duration (BMS: converted from chart-defined time units; BMSON: pulse count)

BgaChange

BGA (background animation) change event

Triggered when playback position reaches BGA change time point, indicating the need to switch to the specified background image. Supports multiple BGA layers: Base (base layer), Overlay (overlay layer), Overlay2 (second overlay layer), and Poor (displayed on failure).

Fields

layer: BgaLayer

BGA layer

bmp_id: Option<BmpId>

BGA/BMP resource ID, get the corresponding file path through the bmp_files() method (if any)

BgaOpacityChange

BGA opacity change event (requires minor-command feature)

Dynamically adjust the opacity of the specified BGA layer to achieve fade-in/fade-out effects.

Fields

layer: BgaLayer

BGA layer

opacity: u8

Opacity value (0x01-0xFF, 0x01 means almost transparent, 0xFF means completely opaque)

BgaArgbChange

BGA ARGB color change event (requires minor-command feature)

Dynamically adjust the color of the specified BGA layer through ARGB values to achieve color filter effects.

Fields

layer: BgaLayer

BGA layer

argb: u32

ARGB color value (format: 0xAARRGGBB)

BgmVolumeChange

BGM volume change event

Triggered when playback position reaches BGM volume change time point, used to adjust background music volume.

Fields

volume: u8

Volume value (0x01-0xFF, 0x01 means minimum volume, 0xFF means maximum volume)

KeyVolumeChange

KEY volume change event

Triggered when playback position reaches KEY volume change time point, used to adjust key sound effect volume.

Fields

volume: u8

Volume value (0x01-0xFF, 0x01 means minimum volume, 0xFF means maximum volume)

TextDisplay

Text display event

Triggered when playback position reaches text display time point, used to display text information in the chart.

Fields

text: String

Text content to display

JudgeLevelChange

Judge level change event

Triggered when playback position reaches judge level change time point, used to adjust the strictness of the judgment window.

Fields

level: JudgeLevel

Judge level (VeryHard, Hard, Normal, Easy, OtherInt)

VideoSeek

Video seek event (requires minor-command feature)

Triggered when playback position reaches video seek time point, used for video playback control.

Fields

seek_time: f64

Seek time point (seconds)

BgaKeybound

BGA key binding event (requires minor-command feature)

Triggered when playback position reaches BGA key binding time point, used for BGA and key binding control.

Fields

event: SwBgaEvent

BGA key binding event type

OptionChange

Option change event (requires minor-command feature)

Triggered when playback position reaches option change time point, used for dynamic game option adjustment.

Fields

option: String

Option content

BarLine

Measure line event

Triggered when playback position reaches measure line position, used for chart structure display.

Trait Implementations

impl Clone for ChartEvent

fn clone(&self) -> ChartEvent

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ChartEvent

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.