OPTIONS -- configure miscellaneous options (V4.5)
@OPTIONS table
This preprocessor command allows you configure miscellaneous general options. You have to pass a table to this command that specifies which things you want to configure.

The following tags are currently recognized by @OPTIONS:

This tag has the same function as the console argument with the same name. If you set LockSettings to True, compiled Hollywood programs will not accept any arguments from the console or from the pseudo-console. The only difference to the console argument is that if you use LockSettings in the preprocessor commands, it will also forbid any user changes when running Hollywood scripts. I.e. if you use LockSettings here, your script will always use the style as defined in the preprocessor commands. You cannot change the style by passing arguments like Borderless or Sizeable to the script.

If you set this tag to True, Hollywood will use a low resolution software timer instead of the high resolution hardware timer. This is sometimes necessary because with certain older Windows XP hardware, the timer may occassionally leap which can cause unexpected behaviour. This tag is only supported on the Windows platform. (V5.3)

If you set this tag to True, Hollywood will not add itself to the system's list of commodities on AmigaOS. This tag is only supported on AmigaOS and compatibles. Defaults to False. (V6.0)

If you set this tag to True, Hollywood will register itself as an AmigaOS 4 application on startup through application.library. This is necessary if you want to call functions that deal with AmigaOS 4 application objects like SendApplicationMessage() or if you want your application to appear in AmiDock. To change the icon that is shown in AmiDock, use the @APPICON preprocessor command. This tag is only available on AmigaOS 4. Defaults to False. (V6.0)

This tag allows you to specify the identifier of a menu strip that should be used as a context menu for your application's docky in AmigaOS 4's AmiDock system. The menu strip you specify here must only contain a single menu tree without any sub menus. Hotkeys inside the menu strip are not supported either because they don't make sense in a context menu that isn't always visible. Please note that setting this tag will automatically make your application appear as an app docky in AmiDock. See AmiDock information for details on the difference between app and standard dockies. This tag is only recognized if RegisterApplication has been set to True and it is obviously only supported on AmigaOS 4. (V6.0)

This tag allows you to specify the identifier of a brush that should be shown as your application's icon in AmiDock on AmigaOS 4. Normally, you would use the @APPICON preprocessor command to configure your application's AmiDock icon but the DockyBrush tag can come in handy in one of the following situations: First, DockyBrush allows you to specify an arbitrary brush and thus you are not restricted to the predefined sizes made available by @APPICON. Instead, your application's docky icon can be of any size you want. Second, if you use DockyBrush Hollywood will automatically create an app docky for you whereas using @APPICON would create a standard docky (as long as your docky does not have a context menu attached). See AmiDock information for more details on the difference between app and standard dockies. This tag is only recognized if RegisterApplication has been set to True and it is obviously only supported on AmigaOS 4. (V6.0)

If this tag is set to True, Hollywood will not show your application in AmiDock. This tag is useful if you would like to have an invisible application that can use all the application functionality like the message mechanism and Ringhio but doesn't appear in AmiDock. This tag is only recognized if RegisterApplication has been set to True and it is obviously only supported on AmigaOS 4. (V6.0)

This tag can be used to set the script's character encoding. Note that you have to put this statement at the very beginning of your script or there will be problems. The following character encodings are currently supported:

Script's character encoding is UTF-8 (with or without BOM). This is also the default and should be used whenever and whereever possible.

Script's character encoding is ISO 8859-1. Note that due to historical reasons Hollywood will not use ISO 8859-1 character encoding on AmigaOS and compatibles but whatever is the system's default character encoding. #ENCODING_ISO8859_1 will put Hollywood in legacy mode and should make your script fully compatible with Hollywood versions older than 7.0. However, since ISO 8859-1 mode has several drawbacks, it isn't recommended to use this legacy mode permanently. Instead, you should adapt your scripts to work correctly in Unicode mode.

Note that it isn't recommended to use #ENCODING_ISO8859_1 because Hollywood will only run correctly on locales compatible with Western European languages then. You should always use #ENCODING_UTF8 because this will put Hollywood in Unicode mode and make sure that Hollywood runs correctly on all locales. Since #ENCODING_UTF8 is also the default, you normally don't have to use the Encoding tag at all.

The encoding you specify here is automatically set as the default encoding for both the text and string library using SetDefaultEncoding(). This means that all functions of the string and text libraries will default to this encoding. (V7.0)

By default, Hollywood will always change the current directory to the directory of the script or applet it is currently running. Pass this argument if you don't want this behaviour. In that case, Hollywood won't change the current directory when running a script. (V7.1)

If this tag is set to False, the commands DebugPrint(), DebugPrintNR(), Assert(), DebugOutput() and @WARNING will be ignored. This allows you to globally disable debugging functions with just a single call. When compiling scripts Hollywood will set EnableDebug to False by default. This is the recommended setting because it will prevent people from reverse engineering your projects because they won't be able to activate debug output by specifying the ‘-debugoutput’ console argument. When running scripts, EnableDebug defaults to True to allow you to debug your scripts. (V7.1)

On AmigaOS and compatibles, plugins can also be globally installed in LIBS:Hollywood. Executables compiled by Hollywood, however, will only load the plugins that are stored next to the executable in its directory. If you want your executable to load all plugins in LIBS:Hollywood as well, you have to set the GlobalPlugins tag to True. Obviously, this tag is only supported on AmigaOS and compatible platforms. (V9.0)

This tag is only supported on Windows. If you set it to True, Hollywood will start in DPI-aware mode. This means that it will not ask the OS to automatically scale Hollywood to fit to the monitor's DPI. If DPIAware is set to False (which is also the default), Hollywood will automatically apply scaling on high-DPI monitors so that its display doesn't appear too small on them. For example, a display of 640x480 pixels will appear really tiny on a high-DPI monitor. By automatically adapting displays to the monitor's DPI, Hollywood will try to avoid this. However, that scaling can make displays appear blurry on high-DPI monitors. So if you don't want that, set DPIAware to True. Note, however, that you'll need to take care of making sure that your display appears correctly on high-DPI monitors then. You can do this by setting the SystemScale tag in the @DISPLAY preprocessor command, for example. Note that DPIAware is only supported on Windows. On all other platforms Hollywood is always DPI-aware. (V9.0)

If you set this tag to True, Hollywood will compile an executable that runs in console mode on Windows. On Windows, there is a distinction between console and Windows programs so if you want to compile a program for the console, you will explicitly have to tell Hollywood to do so. You can do that by setting this tag to True. Note that this tag is obviously only handled when compiling executables for Windows with Hollywood. Otherwise it is simply ignored. Defaults to False. (V9.0)

If you set this tag to True, Hollywood won't show its traditional startup output but will start quietly. When running Hollywood applets that have Quiet set to True using the Hollywood Player for Amiga and compatibles, the player also won't open its startup window. Defaults to False. (V9.0)

table specifying desired options (see above)

Show TOC