The statement is used to create a droplet file. The statement is only run once, regardless of the execution mode. (grouped or interactive). The statement is not valid while batch processing.
The three text fields may contain any of the escape sequences described in Escape Sequences.
The name of the action to be run is supplied in the Action name field.
The name of the droplet file can optionally be supplied in the Display name field. If the content resolves to be empty at runtime, the action name will serve as the display name. Note that the display name cannot contain : or / characters. The characters will be replaced as if renaming.
Various runtime errors are warnings. These warnings can be suppressed by checking the Suppress warnings control.
The droplet configuration is optionally read from the Settings field. The content is interpreted as containing case insensitive character codes. The following codes are supported and mostly correspond to settings on the droplet creation panel. See Droplets for additional information. Note that Open Mode settings are only used when the runmode is Load Dropped Files and Run Action.
| Character | Description |
|---|---|
| A | Set open mode Album. If neither A or P is specified, this code is assumed. |
| P | Set open mode Playlist. |
| + | Set open mode Add to the File List. |
| - | Set open mode Replace the File List. If neither + or - is specified, this code is assumed. |
| X | Set open mode Do Not Process Subfolders. If neither X or S is specified, this code is assumed. |
| S | Set open mode Process Subfolders |
| D | Runmode is Load Dropped Files and Run Action. If none of D, R or L is specified, this code is assumed. |
| R | Runmode is Run Action Without Loading Files. |
| L | Runmode is Run Action With a List of Dropped Files. |
| H | When the action is run and Yate has to be started, suppress opening the main window. If not specified, the main window will always be opened. |
| T | When the action is run and Yate has to be started, do not suppress opening the main window. This is the default setting. |
| N | Warning errors are not enabled. If present overrides the Suppress warnings checkbox setting. |
| W | Warning errors are enabled. If present overrides the Suppress warnings checkbox setting. |
The codes are applied strictly left to right. A settings string of AP is equivalent to P. At runtime, any characters not in the above table are ignored.
The action test state is set to true if a droplet was created and false if an error occurred. If an error occurred, the error text is in named variable Action Error Text. The text is prefixed with an integer to make it easier to identify particular errors. A negative integer implies that the error is a warning and can be suppressed. The following error codes are currently supported:
| Code | Description |
|---|---|
| 1 | The display name is empty. |
| 2 | The action name is empty. |
| 3 | The specified action does not exist. |
| -4 | The specified action is marked as hidden in the Action Manager. When suppressed, this error is not issued. The droplet will refer to the hidden action. |
| 5 | The display name is empty after normalizing. (removing : and / characters) |
| -6 | The droplet already exists. When suppressed, this error is not issued and the older droplet will be overwritten. |
| -7 | The droplet is already registered. When suppressed, this error is not issued and the registration is refreshed. |
| 8 | Error creating Yate's droplets folder. This should not be possible. |
| 9 | Error creating the droplet configuration file. |
| 10 | Error creating the droplet application file. |
| 11 | Unable to determine the desktop folder location. This should not be possible. |
| -12 | The display name has been modified after normalizing. (removing : and / characters). When suppressed, this error is not issued. |