User Tools
jwlua:finaleplugin_properties
Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
jwlua:finaleplugin_properties [2013/11/21 12:51] jariw |
jwlua:finaleplugin_properties [2013/11/21 14:17] (current) jariw |
||
|---|---|---|---|
| Line 99: | Line 99: | ||
| === ParameterTypes (multiline string) === | === ParameterTypes (multiline string) === | ||
| - | <code lua>finaleplugin.ParameterTypes = [[ | + | The types to the script parameters. The syntax is similar to the ''SetTypes()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. Use one line for each parameter. Don't use quotation marks around the types. The number of types must be identical to the number of descriptions. |
| + | Valid types are ''Number'', ''String'', ''Boolean'' and ''NumberedList''. Example: | ||
| + | <code lua>finaleplugin.ParameterTypes = [[ | ||
| + | Number | ||
| + | Boolean | ||
| ]]</code> | ]]</code> | ||
| === ParameterDescriptions (multiline string) === | === ParameterDescriptions (multiline string) === | ||
| + | The syntax is similar to the ''SetDescriptions()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. Use one line for each parameter. Don't put quotation marks around the descriptions. The number of descriptions must be identical to the number of types. Example: | ||
| <code lua>finaleplugin.ParameterDecriptions = [[ | <code lua>finaleplugin.ParameterDecriptions = [[ | ||
| + | Resize (in percent) | ||
| + | Resize relative | ||
| ]]</code> | ]]</code> | ||
| === ParameterLists (multiline string) === | === ParameterLists (multiline string) === | ||
| + | The syntax is similar to the ''SetLists()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. These settings are optional for script parameters. Use one line for each parameter, but __don't__ put ''{}'' around the list. If a list isn't required for a parameter, set it to ''nil''. If a comma is needed within a list item, quotation marks can be used around that list item. Example: | ||
| <code lua>finaleplugin.ParameterLists = [[ | <code lua>finaleplugin.ParameterLists = [[ | ||
| + | nil | ||
| + | Yes, No | ||
| ]]</code> | ]]</code> | ||
| === ParameterInitValues (multiline string) === | === ParameterInitValues (multiline string) === | ||
| + | The syntax is similar to the ''SetInitValues()'' method when using [[jwlua:uservalueinput|UserInputValue dialog input]]. These settings are optional for script parameters. Use one line for each parameter. If a user value isn't required for a parameter, set it to ''nil''. Example: | ||
| <code lua>finaleplugin.ParameterInitValues = [[ | <code lua>finaleplugin.ParameterInitValues = [[ | ||
| + | nil | ||
| + | true | ||
| ]]</code> | ]]</code> | ||
| - | |||
| - | |||
| - | |||
jwlua/finaleplugin_properties.1385038271.txt.gz · Last modified: 2013/11/21 12:51 by jariw
Page Tools
