Note

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/ivan-1f/phichain/llms.txt

Use this file to discover all available pages before exploring further.

​

Overview

​

Types

​

Note

​

NoteKind

NoteKind::Tap

NoteKind::Drag

NoteKind::Hold { hold_beat: Beat }

NoteKind::Flick

​

Creating Notes

use phichain_chart::note::{Note, NoteKind};
use phichain_chart::beat::Beat;

let tap = Note::new(
    NoteKind::Tap,
    true,              // above the line
    Beat::from(2.0),   // at beat 2
    0.5,               // x position
    1.0,               // normal speed
);

​

Working with Notes

let note = Note::new(NoteKind::Tap, true, Beat::ZERO, 0.0, 1.0);

if note.kind.is_tap() {
    println!("This is a tap note");
}

if note.kind.is_hold() {
    println!("This is a hold note");
}

if note.kind.is_flick() {
    println!("This is a flick note");
}

if note.kind.is_drag() {
    println!("This is a drag note");
}

​

JSON Serialization

{
  "kind": "tap",
  "above": true,
  "beat": [2, 0, 1],
  "x": 0.5,
  "speed": 1.0
}

​

Note Properties Explained

​

Position (x)

• 0.0 = center of the line
• Positive values = right side
• Negative values = left side
• Typical range: -1.0 to 1.0, but can go beyond

​

Above/Below

• true = above the line (notes fall down)
• false = below the line (notes rise up)

​

Speed

• 1.0 = normal speed (affected by line speed events)
• > 1.0 = faster approach
• < 1.0 = slower approach
• 0.5 = half speed (appears to move slowly)
• 2.0 = double speed (appears to move quickly)

​

Beat Position

​

Examples

// Create a stream of tap notes
let mut notes = Vec::new();
for i in 0..8 {
    notes.push(Note::new(
        NoteKind::Tap,
        true,
        Beat::from(i as f32),
        0.0,
        1.0,
    ));
}

​

Notes

• Hold notes are the only note type with additional state (hold_beat)
• For non-hold notes, end_beat() returns the same value as beat
• Notes are sorted by beat position when needed
• Speed only affects visual approach, not timing