Name
SCREEN -- configure screen mode for script (V4.5)
Synopsis
@SCREEN table
Function
Important note: This preprocessor command is deprecated since Hollywood 6.0. As Hollywood 6.0 introduced support for multiple monitors, there can also be multiple displays in full screen mode on separate monitors. That is why a single @SCREEN preprocessor command is no longer sufficient. Instead, display mode parameters should now be configured using the @DISPLAY preprocessor command or the CreateDisplay() function. You can still use this preprocessor command but it will affect the first display only.

This preprocessor command can be used to configure the initial screen mode for your script. By default, all Hollywood scripts will open in a window. If you want your script to open in full screen mode by default, you can use this preprocessor command to achieve this.

Before Hollywood 4.5, screen mode was configured using the @DISPLAY preprocessor command. Hollywood 4.5, however, introduced multiple displays which made it necessary to move the screen mode settings into its own preprocessor command because it is impossible to have multiple displays running in full screen mode.

You have to pass a table to this command. The following table tags are currently recognized:

Mode:
Defines which display mode your script should start in. This can be either Windowed, FullScreen, FullScreenScale, FakeFullScreen, or Ask. See Console arguments for information on what the different modes mean. If you specify Ask, Hollywood will ask the user if the script should be run in full screen or windowed mode. Defaults to Windowed.

HideTitleBar:
This field can be used to hide the screen's title bar. It is only effective when Hollywood opens on its own screen or when you use a backfill. Defaults to False.

Desktop:
If you set this field to True, the initial background picture will be a copy of your desktop screen. This can be used for some nice effects with that screen. Hollywood will also automatically open a borderless window if this field is True. Note that setting this attribute puts Hollywood in a special mode and you must not open any other displays.

Width, Height:
If Mode is set to FullScreen, you can use these two to specify the dimensions for the screen that Hollywood should open. If you pass 0 in here, Hollywood will use the dimensions of the desktop screen. If you do not specify them at all, Hollywood will automatically determine a screen size that fits.

Depth:
This field can be used to specify the color depth of the screen that Hollywood should open. Thus, it can only be used when Hollywood opens in full screen mode. If you do not specify this field, Hollywood will use the color depth of the desktop screen for the new screen. Normally, you should not use this field and leave the choice to Hollywood to detect an appropriate depth for the current system.

Alternatively, screen mode settings can also be configured from the command line. If you want to disable this, you should compile your scripts using the -locksettings console argument.

You can also switch between full screen and windowed mode at run time using the ChangeDisplayMode() command.

Inputs
table
table declaring the initial screen mode for the script
Example
@SCREEN {Mode = "FullScreen", Width = 800, Height = 600}
This declaration will set up 800x600 as the initial screen mode for the script.

Show TOC