Module xPersistentSettings
Store and retrieve information in the song or instrument comments field
Functions
| store (arr, token_start, token_end, instr) | Output the current settings as a lua string in the song comments |
| retrieve (token_start, token_end, instr) | Retrive and apply the locally stored settings TODO deserialize using sandbox |
| test (token_start, token_end, instr) | Check if the song contains locally stored settings |
| clear (token_start, token_end, instr) | Clear locally stored settings if matched |
| _obtain_source (instr) | decide on the source for our persisted data |
| _update_source (t, instr) | update our persisted data source |
Functions
- store (arr, token_start, token_end, instr)
-
Output the current settings as a lua string in the song comments
Parameters:
- arr (table)
- token_start (string)
- token_end (string)
- instr (renoise.Instrument), instrument - otherwise song
- retrieve (token_start, token_end, instr)
-
Retrive and apply the locally stored settings
TODO deserialize using sandbox
Parameters:
- token_start (string)
- token_end (string)
- instr (renoise.Instrument), instrument - otherwise song
Returns:
- table when settings were found
- [string], error message when failed
- test (token_start, token_end, instr)
-
Check if the song contains locally stored settings
Parameters:
- token_start (string)
- token_end (string)
- instr (renoise.Instrument), instrument - otherwise song
Returns:
- boolean, true when settings were found
- [string], error message when failed
- clear (token_start, token_end, instr)
-
Clear locally stored settings if matched
Parameters:
- token_start (string)
- token_end (string)
- instr (renoise.Instrument), instrument - otherwise song
Returns:
- boolean, true when cleared/passed without problems
- [string], error message when failed
- _obtain_source (instr)
-
decide on the source for our persisted data
Parameters:
- instr (renoise.Instrument), instrument - otherwise song
- _update_source (t, instr)
-
update our persisted data source
Parameters:
- t
(table
) - instr (renoise.Instrument), instrument - otherwise song
- t
(table