Margrete RPC

NoteInfo

The full field set of a single note node, shared by typed notes and :class:RawNote.

This is the low-level bag of attributes (type, geometry, direction, color, timing) that backs every note. Typed notes expose the relevant fields as their own properties; construct :class:NoteInfo directly only for raw/manual work. Timing accepts a tick t or a :data:Position p; option_value accepts an :data:DivisionLike.

Attributes

attributetype
= type
attributelong_attr
= long_attr
attributeex_attr
= ex_attr
attributex
= x
attributew
= w
attributeh
= h
attributetil
= til
attributedirectionDirection
attributevariation_idColor
attributetint
attributepPosition

Timing as a (bar, beat, offset) :class:Position; the read-only view of t.

attributeoption_valueint
attribute__repr__
= __str__

Functions

func__init__(self, type=NoteType.UNKNOWN, long_attr=LongAttr.NONE, direction=Direction.UP, ex_attr=ExAttr.NONE, variation_id=Color.DEFAULT, x=0, w=0, h=DEFAULT_H, t=0, til=0, option_value=0, *, p=None) -> None
paramself
paramtypeNoteType
= NoteType.UNKNOWN
paramlong_attrLongAttr
= LongAttr.NONE
paramdirectionDirectionValue | str
= Direction.UP
paramex_attrExAttr
= ExAttr.NONE
paramvariation_idColorLike | int
= Color.DEFAULT
paramxint
= 0
paramwint
= 0
paramhint
= DEFAULT_H
paramtint
= 0
paramtilint
= 0
paramoption_valueint | DivisionLike
= 0
parampPositionLike | None
= None

Returns

None
funccopy(self, **changes) -> NoteInfo

Return a copy with any given fields overridden by keyword.

paramself
paramchangesAny
= {}

Returns

margrete_rpc.chart.notes.types.NoteInfo
func__eq__(self, other) -> bool
paramself
paramotherobject

Returns

bool
func__str__(self) -> str
paramself

Returns

str

On this page