SetCurrentRecipe
(Recipe Book module)
Description: | Sets the current recipe and clears or updates the current version |
Returns: | Nothing |
Usage: | Script Only. |
Function Groups: | Recipe Book |
Related to: | GetRecipes | GetVersions | GetCurrentRecipe | GetCurrentVersion | SetCurrentVersion | |
Format: | RecipeBook.SetCurrentRecipe(NewVal[, PickFirstVersion]) |
Parameters: |
NewVal |
Required text. The new value, to which CurrentRecipe should be set. This must use the phrase key of the recipe name, not the displayed name in the current language. Refer to your language .CSV file to find the matching phase key. |
PickFirstVersion |
Optional Boolean. If TRUE (the default), the version is set to the alphabetically first version. If FALSE, the version is set to the alphabetically last version. |
Comments: |
"RecipeBook" must be a reference to a Recipe Book tag object, not the name of the tag. The ingredient tags will be updated automatically for the newly set recipe. |