Margrete RPC

AirCrush

An air-crush note: an air-lane long note with height and a color.

Like a slide but in the air lane: it carries height h, a :attr:color, and a gap (:attr:gap, with the :attr:interval beat-fraction view) controlling the spacing of generated segments between joints. Add control joints with :meth:with_ctrl / :meth:add_ctrl.

Attributes

attributeh
= h
attributegapint

Segment gap as an int tick count.

Set with an int tick count or an :data:DivisionLike (numerator, denominator) beat fraction. Read the fraction form via the :attr:interval view.

attributecolorColorValue | int

The crush color (:class:ColorValue, or a raw int for non-standard values).

attributeintervalDivision

Read-only (numerator, denominator) beat-fraction view of gap.

Functions

func__init__(self, *, t, x, w, h, gap=DEFAULT_AIRCRUSH_GAP, color=ColorValue.DEFAULT, _info=None, _id=None) -> None

Create an air-crush begin note.

paramself
paramtint | PositionLike

Absolute tick or :data:Position tuple.

paramxint

Left lane index.

paramwint

Width in lane units.

paramhint

Air height.

paramgapint | DivisionLike
= DEFAULT_AIRCRUSH_GAP

Segment gap as a tick count or (numerator, denominator) beat fraction.

paramcolorColorLike | int
= ColorValue.DEFAULT

Crush color (:class:ColorValue or raw int).

param_infoNoteInfo | None
= None
param_idint | None
= None

Returns

None
funcwith_ctrl(self, *, t, x, w, h) -> Self

Return a copy with a control joint appended at the given timing and geometry.

paramself
paramtint | PositionLike
paramxint
paramwint
paramhint

Returns

typing.Self
funcconverted(self, target, **overrides) -> T

Return a new note of type target carrying this note's geometry and joints.

paramself
paramtargettype[T]
paramoverridesAny
= {}

Returns

margrete_rpc.chart.notes.long.AirCrush.converted[T]
functo_raw(self, *, skip_validation=False) -> RawNote

Convert to a :class:RawNote tree (begin note with joint children).

paramself
paramskip_validationbool
= False

Returns

margrete_rpc.chart.notes.raw.RawNote

On this page