chore: autopublish 2023-01-19T00:03:18Z

Author: github-actions[bot]

docs/library/utils.md

@@ -7,11 +7,12 @@ A library of general Lua utility functions.
 - [copy_table(t)](#copy_table)
 - [table_remove_first(t, value)](#table_remove_first)
 - [iterate_keys(t)](#iterate_keys)
-- [round(num)](#round)
+- [round(num, places)](#round)
 - [calc_roman_numeral(num)](#calc_roman_numeral)
 - [calc_ordinal(num)](#calc_ordinal)
 - [calc_alphabet(num)](#calc_alphabet)
 - [clamp(num, minimum, maximum)](#clamp)
+- [ltrim(str)](#ltrim)
 
 ### copy_table
 
@@ -67,16 +68,17 @@ Returns an unordered iterator for the keys in a table.
 ### round
 
 ```lua
-utility_functions.round(num)
+utility_functions.round(num, places)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L71)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L72)
 
-Rounds a number to the nearest whole integer.
+Rounds a number to the nearest integer or the specified number of decimal places.
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
 | `num` | `number` |  |
+| `places` (optional) | `number` | If specified, the number of decimal places to round to. If omitted or 0, will round to the nearest integer. |
 
 | Return type | Description |
 | ----------- | ----------- |
@@ -88,7 +90,7 @@ Rounds a number to the nearest whole integer.
 utility_functions.calc_roman_numeral(num)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L83)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L86)
 
 Calculates the roman numeral for the input number. Adapted from https://exercism.org/tracks/lua/exercises/roman-numerals/solutions/Nia11 on 2022-08-13
 
@@ -106,7 +108,7 @@ Calculates the roman numeral for the input number. Adapted from https://exercism
 utility_functions.calc_ordinal(num)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L104)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L107)
 
 Calculates the ordinal for the input number (e.g. 1st, 2nd, 3rd).
 
@@ -124,7 +126,7 @@ Calculates the ordinal for the input number (e.g. 1st, 2nd, 3rd).
 utility_functions.calc_alphabet(num)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L128)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L131)
 
 This returns one of the ways that Finale handles numbering things alphabetically, such as rehearsal marks or measure numbers.
 
@@ -144,7 +146,7 @@ This function was written to emulate the way Finale numbers saves when Autonumbe
 utility_functions.clamp(num, minimum, maximum)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L145)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L148)
 
 Clamps a number between two values.
 
@@ -157,3 +159,21 @@ Clamps a number between two values.
 | Return type | Description |
 | ----------- | ----------- |
 | `number` |  |
+
+### ltrim
+
+```lua
+utility_functions.ltrim(str)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/library/utils.lua#L160)
+
+Removes whitespace from the start of a string.
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `str` | `string` |  |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `string` |  |

docs/mixin/FCMCtrlEdit.md

@@ -3,6 +3,7 @@
 Summary of modifications:
 - Added `Change` custom control event.
 - Added hooks for restoring control state
+- `GetMeasurement*` and `SetMeasurement*` methods have been overridden to use the `FCMString` versions of those methods under the hood. For more details on any changes, see the documentation for `FCMString`.
 
 ## Functions
 
@@ -12,15 +13,18 @@ Summary of modifications:
 - [GetFloat(self)](#getfloat)
 - [SetFloat(self, value)](#setfloat)
 - [GetMeasurement(self, measurementunit)](#getmeasurement)
+- [GetRangeMeasurement(self, measurementunit, minimum, maximum)](#getrangemeasurement)
 - [SetMeasurement(self, value, measurementunit)](#setmeasurement)
 - [GetMeasurementEfix(self, measurementunit)](#getmeasurementefix)
+- [GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)](#getrangemeasurementefix)
 - [SetMeasurementEfix(self, value, measurementunit)](#setmeasurementefix)
 - [GetMeasurementInteger(self, measurementunit)](#getmeasurementinteger)
+- [GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)](#getrangemeasurementinteger)
 - [SetMeasurementInteger(self, value, measurementunit)](#setmeasurementinteger)
+- [GetMeasurement10000th(self, measurementunit)](#getmeasurement10000th)
+- [GetRangeMeasurement10000th(self, measurementunit, minimum, maximum)](#getrangemeasurement10000th)
+- [SetMeasurement10000th(self, value, measurementunit)](#setmeasurement10000th)
 - [GetRangeInteger(self, minimum, maximum)](#getrangeinteger)
-- [GetRangeMeasurement(self, measurementunit, minimum, maximum)](#getrangemeasurement)
-- [GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)](#getrangemeasurementefix)
-- [GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)](#getrangemeasurementinteger)
 - [HandleChange(control, last_value)](#handlechange)
 - [AddHandleChange(self, callback)](#addhandlechange)
 - [RemoveHandleChange(self, callback)](#removehandlechange)
@@ -31,7 +35,7 @@ Summary of modifications:
 fcmctrledit.SetText(self, str)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L29)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L30)
 
 **[Fluid] [Override]**
 Ensures that `Change` event is triggered.
@@ -47,7 +51,7 @@ Ensures that `Change` event is triggered.
 fcmctrledit.GetInteger(self)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L201)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L286)
 
 **[Override]**
 Hooks into control state restoration.
@@ -119,7 +123,7 @@ Also hooks into control state restoration.
 fcmctrledit.GetMeasurement(self, measurementunit)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L120)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L134)
 
 **[Override]**
 Hooks into control state restoration.
@@ -133,13 +137,35 @@ Hooks into control state restoration.
 | ----------- | ----------- |
 | `number` |  |
 
+### GetRangeMeasurement
+
+```lua
+fcmctrledit.GetRangeMeasurement(self, measurementunit, minimum, maximum)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L145)
+
+**[Override]**
+Hooks into control state restoration.
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `self` | `FCMCtrlEdit` |  |
+| `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
+| `minimum` | `number` |  |
+| `maximum` | `number` |  |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `number` |  |
+
 ### SetMeasurement
 
 ```lua
 fcmctrledit.SetMeasurement(self, value, measurementunit)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L131)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L158)
 
 **[Fluid] [Override]**
 Ensures that `Change` event is triggered.
@@ -157,7 +183,27 @@ Also hooks into control state restoration.
 fcmctrledit.GetMeasurementEfix(self, measurementunit)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L241)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L-1)
+
+**[Override]**
+Hooks into control state restoration.
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `self` | `FCMCtrlEdit` |  |
+| `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `number` |  |
+
+### GetRangeMeasurementEfix
+
+```lua
+fcmctrledit.GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L-1)
 
 **[Override]**
 Hooks into control state restoration.
@@ -166,6 +212,8 @@ Hooks into control state restoration.
 | ----- | ---- | ----------- |
 | `self` | `FCMCtrlEdit` |  |
 | `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
+| `minimum` | `number` |  |
+| `maximum` | `number` |  |
 
 | Return type | Description |
 | ----------- | ----------- |
@@ -195,15 +243,38 @@ Also hooks into control state restoration.
 fcmctrledit.GetMeasurementInteger(self, measurementunit)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L261)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L-1)
+
+**[Override]**
+Hooks into control state restoration.
+
+| Input | Type | Description |
+| ----- | ---- | ----------- |
+| `self` | `FCMCtrlEdit` |  |
+| `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
+
+| Return type | Description |
+| ----------- | ----------- |
+| `number` |  |
+
+### GetRangeMeasurementInteger
+
+```lua
+fcmctrledit.GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)
+```
+
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L-1)
 
 **[Override]**
 Hooks into control state restoration.
+Also fixes issue with decimal places in `minimum` being discarded instead of being correctly taken into account (see `FCMString.GetRangeMeasurementInteger`).
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
 | `self` | `FCMCtrlEdit` |  |
 | `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
+| `minimum` | `number` |  |
+| `maximum` | `number` |  |
 
 | Return type | Description |
 | ----------- | ----------- |
@@ -227,37 +298,34 @@ Also hooks into control state restoration.
 | `value` | `number` |  |
 | `measurementunit` | `number` |  |
 
-### GetRangeInteger
+### GetMeasurement10000th
 
 ```lua
-fcmctrledit.GetRangeInteger(self, minimum, maximum)
+fcmctrledit.GetMeasurement10000th(self, measurementunit)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L197)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L-1)
 
-**[Override]**
-Hooks into control state restoration.
+Returns the measurement in 10000ths of an EVPU.
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
 | `self` | `FCMCtrlEdit` |  |
-| `minimum` | `number` |  |
-| `maximum` | `number` |  |
+| `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
 
 | Return type | Description |
 | ----------- | ----------- |
 | `number` |  |
 
-### GetRangeMeasurement
+### GetRangeMeasurement10000th
 
 ```lua
-fcmctrledit.GetRangeMeasurement(self, measurementunit, minimum, maximum)
+fcmctrledit.GetRangeMeasurement10000th(self, measurementunit, minimum, maximum)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L216)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L-1)
 
-**[Override]**
-Hooks into control state restoration.
+Returns the measurement in 10000ths of an EVPU, clamped between two values.
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
@@ -270,43 +338,38 @@ Hooks into control state restoration.
 | ----------- | ----------- |
 | `number` |  |
 
-### GetRangeMeasurementEfix
+### SetMeasurement10000th
 
 ```lua
-fcmctrledit.GetRangeMeasurementEfix(self, measurementunit, minimum, maximum)
+fcmctrledit.SetMeasurement10000th(self, value, measurementunit)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L236)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L-1)
 
-**[Override]**
-Hooks into control state restoration.
+**[Fluid]**
+Sets a measurement in 10000ths of an EVPU.
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
 | `self` | `FCMCtrlEdit` |  |
-| `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
-| `minimum` | `number` |  |
-| `maximum` | `number` |  |
-
-| Return type | Description |
-| ----------- | ----------- |
-| `number` |  |
+| `value` | `number` |  |
+| `measurementunit` | `number` |  |
 
-### GetRangeMeasurementInteger
+### GetRangeInteger
 
 ```lua
-fcmctrledit.GetRangeMeasurementInteger(self, measurementunit, minimum, maximum)
+fcmctrledit.GetRangeInteger(self, minimum, maximum)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L256)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L282)
 
 **[Override]**
 Hooks into control state restoration.
+Fixes issue with decimal places in `minimum` being discarded instead of being correctly taken into account.
 
 | Input | Type | Description |
 | ----- | ---- | ----------- |
 | `self` | `FCMCtrlEdit` |  |
-| `measurementunit` | `number` | Any of the finale.MEASUREMENTUNIT_* constants. |
 | `minimum` | `number` |  |
 | `maximum` | `number` |  |
 
@@ -320,7 +383,7 @@ Hooks into control state restoration.
 fcmctrledit.HandleChange(control, last_value)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L274)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L299)
 
 **[Callback Template]**
 
@@ -335,7 +398,7 @@ fcmctrledit.HandleChange(control, last_value)
 fcmctrledit.AddHandleChange(self, callback)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L291)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L316)
 
 **[Fluid]**
 Adds a handler for when the value of the control changes.
@@ -355,7 +418,7 @@ The even will fire when:
 fcmctrledit.RemoveHandleChange(self, callback)
 ```
 
-[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L296)
+[View source](https://github.com/finale-lua/lua-scripts/tree/master/src/mixin/FCMCtrlEdit.lua#L321)
 
 **[Fluid]**
 Removes a handler added with `AddHandleChange`.