Module nwcStaff
nwcStaff object.
The nwcStaff object is used to encapsulate a NWC staff. The data is kept in fields that match the nwctxt source lines. For example, the nwcStaff.AddStaff object contains the staff's Name and Group properties.
Type nwcStaff
| nwcStaff.AddStaff |
This contains the nwctxt AddStaff properties |
| nwcStaff.Items |
This is a list of the nwcItem#nwcItem notation items found in the staff, which includes notes, bars, and signatures. |
| nwcStaff.Lyric |
This contains a list of lyric lines found in the staff, each as a nwcItem#nwcItem |
| nwcStaff.Lyrics |
This contains the nwctxt Lyrics config |
| nwcStaff.StaffInstrument |
This contains the nwctxt StaffInstrument config |
| nwcStaff.StaffProperties |
This contains the nwctxt StaffProperties |
| nwcStaff:add(item) |
nwcStaff add a line of nwctxt to the staff. |
| nwcStaff.new() |
nwcStaff constructor. |
| nwcStaff:save(writeln) |
nwcStaff output function which generates a nwctxt representation. |
Type nwcStaff
Field(s)
- nwcItem#nwcItem nwcStaff.AddStaff
-
This contains the nwctxt AddStaff properties
- nwcItem#list_nwcItem nwcStaff.Items
-
This is a list of the nwcItem#nwcItem notation items found in the staff, which includes notes, bars, and signatures.
- nwcItem#list_nwcItem nwcStaff.Lyric
-
This contains a list of lyric lines found in the staff, each as a nwcItem#nwcItem
- nwcItem#nwcItem nwcStaff.Lyrics
-
This contains the nwctxt Lyrics config
- nwcItem#nwcItem nwcStaff.StaffInstrument
-
This contains the nwctxt StaffInstrument config
- nwcItem#nwcItem nwcStaff.StaffProperties
-
This contains the nwctxt StaffProperties
- nwcStaff:add(item)
-
nwcStaff add a line of nwctxt to the staff.
Parameter
-
nwcItem#nwcItem item: to add
-
- nwcStaff.new()
-
nwcStaff constructor.
Returns an object representation of a NWC staff.
Return value
#nwcStaff: an object representation of a NWC staff.
- nwcStaff:save(writeln)
-
nwcStaff output function which generates a nwctxt representation.
Writes an object representation of a NWC staff.
Parameter
-
#function writeln: function used to write the nwctxt data
-
