Merge remote-tracking branch 'Github/main' into deploy

book.toml

@@ -3,7 +3,7 @@ authors = ["mklag"]
 language = "en"
 multilingual = false
 src = "src"
-title = "HALion 7.0.0"
+title = "HALion 7.1.10"
 
 [build]
 build-dir = "book"

src/HALion-Macro-Page/pages/Drag-Group.md

@@ -54,10 +54,22 @@ The function can return a table with the following keys:
 |**move**|Set this to ``true`` if moving is allowed, ``false`` if not.|boolean|
 |**info**|The draginfo argument of the subsequent callbacks is determined by this return value. By default, 'info' returns the string specified by the Drag Info property. By modifying the 'info' return value you can control the response of the subsequent callbacks.|string|
 |**files**|A table with file paths for evaluation by external software when the drop operation is executed there.|table with file paths as strings|
+|**data** {{#include ../../_Version.md:halion710}}|A table with filenames and region information, created when dropping a region from Cubase, for example.|See [Data Field Format](#data-field-format).|
+
+##### Data Field Format
+
+The data field contains tables with filenames and region information. 
+
+```lua
+{ files = { "fn1", "fn2", ... } }
+
+{ regions = { { filename = "fn1", start = 123, length = 456 }, { filename = "fn2", start = 456, length = 789 }, ... } } }
+
+```
 
 ### onDropInsert
 
->**onDropInsert(viewname, draginfo, copy)**
+>**onDropInsert(viewname, draginfo, copy, data)**
 
 #### Description
 
@@ -70,10 +82,30 @@ Callback for the target of the drag operation when the drop is executed.
 |**viewname**|The name of the targeted view.|string|
 |**draginfo**|This string is specified by the 'info' return value of the [onDropGetInfo](#ondropgetinfo) callback when the drag operation starts.|string|
 |**copy**|Indicates if the drag is a copy operation.|string|
+|**data** {{#include ../../_Version.md:halion710}}|A table with filenames and region information when dropping a region from Cubase, for example.|See [Data Field Format](#data-field-format).|
+
+### onDropFeedback
+
+{{#include ../../_Version.md:halion710}}
+
+>**onDropFeedback(viewname, draginfo, copy, data)**
+
+#### Description
+
+Callback for the target of the drag operation when a drag object is held over it.
+
+#### Arguments
+
+|Argument|Description|Value Type|
+|:-|:-|:-|
+|**viewname**|The name of the targeted view.|string|
+|**draginfo**|This string is specified by the 'info' return value of the [onDropGetInfo](#ondropgetinfo) callback when the drag operation starts.|string|
+|**copy**|Indicates if the drag is a copy operation.|string|
+|**data**|A table with filenames and region information when dropping a region from Cubase, for example.|See [Data Field Format](#data-field-format).|
 
 ### onDropDone
 
->**onDropDone(viewname, draginfo, copy)**
+>**onDropDone(viewname, draginfo, copy, data)**
 
 #### Description
 
@@ -86,3 +118,5 @@ This callback is called when the drop operation is complete.
 |**viewname**|The name of the source view.|string|
 |**draginfo**|This string is specified by the 'info' return value of the [onDropGetInfo](#ondropgetinfo) callback when the drag operation starts.|string|
 |**copy**|Indicates if the drag is a copy operation.|string|
+|**data** {{#include ../../_Version.md:halion710}}|A table with filenames and region information when dropping a region from Cubase, for example.|See [Data Field Format](#data-field-format).|
+

src/HALion-Macro-Page/pages/Envelope-Shaper.md

@@ -96,7 +96,8 @@ In addition to standard properties like size, position, etc., the Envelope View
 |**Fixed**|Connected to the corresponding control template by the [UI variable](#ui-variables) ``@fixed``.|
 |**Tool**|Connected to the corresponding controls Edit_1, Erase, Draw, and Paint by the [UI variable](#ui-variables) ``@tool``.|
 |**ShapeSave**|Connected to the corresponding control SaveShape_1 by the [UI variable](#ui-variables) ``@shapesave``.|
-|**ShapeSelect**|Connected to the corresponding control SelectShape by the [UI variable](#ui-variables) ``@shapeselect``|
+|**ShapeSelect**|Connected to the corresponding control SelectShape by the [UI variable](#ui-variables) ``@shapeselect``.|
+|**ShapePage**|Controls the state of the page switches in the shape selector dialog. Must be connected to the corresponding [UI variable](#ui-variables) ``@shapepage``.|
 |**Shape**|Connected to the corresponding control Shape Preview by the [UI variable](#ui-variables) ``@shape``.|
 |**Index**|Connected to the corresponding control template by the [UI variable](#ui-variables) ``@index``.|
 |**Level**|Connected to the corresponding control template by the [UI variable](#ui-variables) ``@level``.|

src/HALion-Macro-Page/pages/Mixer-Channel.md

@@ -49,7 +49,7 @@ The Mixer Channel template contains all necessary controls for the parameters of
 |:-|:-|
 |**Ch_Output**|This template contains the necessary elements to specify the output of a bus. It contains the following elements:<ul><li>**Menu:** A [Menu](./Menu.md) control that opens a context menu showing the available outputs. The Value must be set to ``@TargetBusMenu``.</li><li>**Name:** A [Text](./Text.md) control showing the name of the selected output. The Value must be set to ``@TargetBusMenu``.</li><li>**Image:** An [Image](./Image.md) control that provides the background bitmap.</li></ul>To specify the outputs that are made available in the menu, you can configure Menu by adding one of the following tags to its Value property:<ul><li>**{TargetBusses}:** Set this to evaluate the busses provided by the TargetBusses parameter of the Mixer Channel template. </li><li>**default:** Set this to route the output to the default bus (usually the next bus higher up in the hierarchy).</li><li>**default='name':** Same as above, but 'name' is shown as text instead of '--'.</li><li>**local:** Set this to show all available busses higher up in the hierarchy.</li><li>**buslist='BusName1; BusName2; ...':** Allows to specify a list of busses.</li><li>**aux:** Shows the plug-in aux busses.</li><li>**noplug:** Hides the plug-in output busses.</li></ul>For example, ``@TargetBusMenu local aux noplug`` shows only the busses higher up in the hierarchy and the aux busses, but none of the plug-in outputs in the menu.|
 |**Ch_Pan**|This template contains the necessary elements to control the pan parameter of the bus. It contains the following elements:<ul><li>**Slider:** A [Slider](./Slider.md) control. The Value of this control is exported to the Ch_Pan template and must be set to ``@Pan``.</li><li>**Image:** An [Image](./Image.md) control that provides the background bitmap.</li></ul>|
-|**Ch_Meter**|This template references the Bus Meter V Peak template. The PeakReset and PeakValue template parameters are exported values from inside the template. By using ``{bus}`` these parameters evaluate the bus provided by the corresponding parameter of the Mixer Channel template. ``/@id:21`` and ``/@id:19`` connects them to the peak reset and peak value parameters of the specified bus. The template contains the following elements:<ul><li>**switch:** A [Switch](./Switch.md) control that resets the peak value of the bus. Its Value is exported as PeakReset.</li><li>**text:** A [Text](./Text.md) control that displays the peak value of the bus. Its Value is exported as PeakValue</li><li>**image:** An [Image](./Image.md) control that provides the background bitmap for the text.</li><li>**vumeter:** A [Meter](./Meter.md) control for the right channel of a stereo bus. Its Value must be set to ``@meter1`` and its Peak Value to ``@peak1``.</li><li>**vumeter:** A [Meter](./Meter.md) control for the left channel of a stereo bus. Its Value must be set to ``@meter0`` and its Peak Value to ``@peak0``.</li><li>**Back:** An [Image](./Image.md) control that provides the background bitmap for the meters.</li></ul>|
+|**Ch_Meter**|This template references the Bus Meter V Peak template. All parameters are connected to the bus defined by the Mixer Channel template's ``bus`` parameter. The Bus Meter V Peak template contains the following elements:<ul><li>**switch:** A [Switch](./Switch.md) control that resets the peak value of the bus. Its Value must be set to ``@VUPeakReset``.</li><li>**text:** A [Text](./Text.md) control that displays the peak value of the bus. Its Value must be set to ``@peak``.</li><li>**image:** An [Image](./Image.md) control that provides the background bitmap for the text.</li><li>**vumeter:** A [Meter](./Meter.md) control for the right channel of a stereo bus. Its Value must be set to ``@meter1`` and its Peak Value to ``@peak1``.</li><li>**vumeter:** A [Meter](./Meter.md) control for the left channel of a stereo bus. Its Value must be set to ``@meter0`` and its Peak Value to ``@peak0``.</li><li>**Back:** An [Image](./Image.md) control that provides the background bitmap for the meters.</li></ul>|
 |**Ch_Level**|A [Text](./Text.md) control showing the value of the level slider. The Value property must be set to ``@LogLevel``.|
 |**Ch_Slider**|This template contains the necessary elements to control the level of the bus. It contains the following elements:<ul><li>**Slider:** A [Slider](./Slider.md) control. The Value is exported to the template and must be set to ``@LogLevel``.</li><li>**Scale:** An [Image](./Image.md) control showing a dB scale.</li><li>**Guide:** An [Image](./Image.md) control showing the slider guidance.</li></ul>|
 |**SoloMute**|A [Group](./Group.md) control with two templates: Ch_Solo and Ch_Mute. They provide the solo/mute functionality of the bus.<ul><li>**Ch_Solo:** This template contains the necessary elements to control and show the solo state of the bus. It contains the following elements:</li><ul><li>**Switch:** An invisible [Switch](./Switch.md) control which contains a hover overlay that lights up the underlying VisualState animation control when hovering over it. The Value is exported to the template and must be set to ``@Solo Layer``.</li><li>**VisualState:** An [Animation](./Animation.md) control showing the solo state (Solo Off, Solo On, or Implicit Solo). The Value is exported to the template and must be set to ``@Solo State``.</li></ul><li>**Ch_Mute:** This template contains the necessary elements to control and show the mute state of the bus. It contains the following elements:</li><ul><li>**Switch:** An invisible [Switch](./Switch.md) control which contains a hover overlay that lights up the underlying VisualState animation control when hovering over it. The Value is exported to the template and must be set to ``@Mute Layer``.</li><li>**VisualState:** An [Animation](./Animation.md) control showing the mute state (Mute Off, Mute On, or Implicit Mute). The Value is exported to the template and must be set to ``@Mute State``.</li></ul></ul>|

src/HALion-Macro-Page/pages/Step-Modulator.md

@@ -27,6 +27,7 @@ The Step Modulator is intended to control HALion's step modulator. It provides a
 |**Slope Amnt**|This property must be connected to the engine parameter SlopeAmount to show the slope. Connect additional controls, e.g., a knob, to set the slope.|
 |**Show All**|Activate this option to show all steps with a fixed width. When dectivated, the width of the individual steps scales with the number of steps as set in **Steps**, to fill the full size of the control.|
 |**Advanced Editing** {{#include ../../_Version.md:halion640}}|Activate this option to provide additional editing possibillities. These are either available as context menu entries or as line editing functions using modifier keys (Shift, Alt). These editing functions were originally made to work best inside HALion's Stepmodulator and Flexphraser. In case the control is used to control other custom script modules, where these functions are not needed or need to work differently, they can be deactivated.|
+|**Play Pos** {{#include ../../_Version.md:halion710}}|Activate this option to show the current playback position on the curve.
 |**Height** {{#include ../../_Version.md:halion6410}}|Defines how the indivdual step values are displayed.<ul><li>&nbsp;&nbsp;0 = Standard look, with bars starting at 0 and going up to the adjusted value.</li><li>>0 = Bars with a defined heigth in pixels for continous parameters.</li><li>&nbsp;&nbsp;1 = Bars with a an automatic height or stepped parameters. The height of a bar correponds to 1/number of steps.</li></ul>|
 |**Step 1-32**|The Step levels. This property can be connected to the engine stepmodulator parameters Step1-32.
 |**Length** {{#include ../../_Version.md:halion640}}|If the step modulator is used to control a custom script module, the Length parameter can be used to adjust the length of each step.|

src/HALion-Macro-Page/pages/Template-List.md

@@ -174,8 +174,8 @@ The subsequent example is presented as illustrative guide to kickstart your own
 **To explore the example:**
 
 1. Load [Template List.vstpreset](../vstpresets/Template%20List.vstpreset).
-1. Open the **Macro Page Designer**, activate **Show/Hide Script Output Messages**.
-1. Click **Test Macro page** ![Edit Element](../images/TestMacroPage-Off.PNG), then drag and drop elements from the left to the right template list and vice versa.
+1. Open the **Macro Page Designer**, activate **Show/Hide Script Output Messages** ![Show/Hide Script Output Messages](../images/ShowHideScriptOutputMessages.png).
+1. Click **Test Macro Page** ![Test Macro Page](../images/TestMacroPage-Off.PNG), then drag and drop elements from the left to the right Template List and vice versa.
 1. Use the **Alt/Cmd**-key to copy elements.
 1. Read the output messages of the script.
 

src/HALion-Script/pages/AlternateData-Table.md

@@ -6,7 +6,7 @@
 
 ## Description
 
-The alternations in the Alternation List of the Layer Alternate MIDI module are managed through a predefined table: the AlternateData table. This table can be obtained by making a call to [getParameter](./getParameter.md) with ``"AlternateData"`` as parameter. The alternations are referenced by their index. Each alternate has the fields ``.keyswitch`` and ``.layer``. You can change the values, but the structure of this table must remain unaltered. The values are set by making a call to [setParameter](./setParameter.md). See the example below for more details.
+The alternations in the Alternation List of the Layer Alternate MIDI module are managed via a predefined table: the AlternateData table. This table can be obtained by making a call to [getParameter](./getParameter.md) with ``"AlternateData"`` as parameter. The alternations are referenced by their index. Each alternation has the fields ``.keyswitch`` and ``.layer``. You can change the values, but the structure of this table must remain unaltered. The values are set by making a call to [setParameter](./setParameter.md). See the example below for more details.
 
 **Available in:** Controller.
 

src/HALion-Script/pages/Bus.md

@@ -34,11 +34,11 @@ The [Element](./Element.md) object of a bus can be obtained with [findBusses](./
 
 |Field|Description|Value Type|
 |:-|:-|:-|
-|**.isAuxBus**|Returns true if this is an aux bus and false if it is not.|boolean|
+|**.isAuxBus**|Returns ``true`` if this is an aux bus and ``false`` if it is not.|boolean|
 |**.auxNumber**|The number of the corresponding aux bus.|number|
 |**.numChannels**|The number of output channels of the bus.|number|
-|**.active**|Returns true if the bus is active and false if it is not active.|boolean|
-|**.bypassMask**|Determines if a bus follows the global inserts and Aux bypass buttons. See Bypass Masks for details.|number|
+|**.active**|Returns ``true`` if the bus is active and ``false`` if it is not active.|boolean|
+|**.bypassMask**|Determines if a bus follows the global inserts and Aux bypass buttons. See [Bypass Masks](./Bypass-Masks.md) for details.|number|
 
 #### Example
 

src/HALion-Script/pages/Bypass-Masks.md

@@ -6,7 +6,7 @@
 
 ## Description
 
-Enumerator to determine the values that configure if a bus or effect follows the global inserts and Aux bypass buttons of the plug-in. The values must be applied to the ``bypassMask`` field of the desired [Bus](./Bus.md) or [Effect](./Effect.md) object. See the example below for details.
+Enumerator to determine the values that determine if a bus or effect follows the global inserts and Aux bypass buttons of the plug-in. The values must be applied to the ``bypassMask`` field of the desired [Bus](./Bus.md) or [Effect](./Effect.md) object. See the example below for details.
 
 **Available in:** Controller.