allow_local_file_access? | boolean | Allows access to local files that are not located in your app’s (extension) folder. Default value is false. |
background_optimization? | boolean | Enables JS engine background optimization. Default value is true. |
block_top_window_navigation? | boolean | Refrain from non _blank elements from “taking-over” the entire app’s window. |
bottommost? | boolean | Indicates whether the window will be on bottom of other Overwolf windows. Handle with care as bottommost windows can negatively impact user experience. |
clickthrough? | boolean | Indicates whether the window will not receive clicks in-game, instead, the clicks will be passed on to the game. To change this property at runtime, use setWindowStyle(). |
debug_url | string | For local-server debugging (like react apps). You can use this field to set the localhost:port URL. Notes: You must have a local web server installed on your machine. Valid only when loading unpacked extensions. Valid only with "localhost" / "127.0.0.1". |
desktop_only? | boolean | Marks the window as available on desktop only, and not in-game. This flag should be used (set to “true”) when “use_os_windowing” or “native_window” flags are set to true. Note: using “desktop_only” and “native_window” flags for desktop windows will dramatically improve your app’s performance. |
dev_tools_window_style? | boolean | Opens developer tools in dedicated window. |
disable_auto_dpi_sizing | boolean | Relevant only for native windows. Disable the DPI Aware behavior of native windows. |
disable_blur? | boolean | Causes the app’s window to never “lose focus”, so the window.onblur event is never triggered. Default value is false. |
disable_hardware_acceleration | boolean | Disable GPU hardware acceleration, per window. Relevant only to native windows. Notes: Use this flag mainly for native windows that run as a second-screen with fps intensive games. It improves the performance of the game by reducing usage of the GPU while you are playing. |
disable_restore_animation? | boolean | Indicates whether the window will animate on minimize/restore while in game. |
disable_rightclick? | boolean | When set to true, disable right clicks entirely for this window. |
enable_top_isolation? | boolean | Enable iframe isolation: runs it in a different process, so if some iframe is misbehaving (e.g. memory leak, etc.) it won’t crash your app and will only crash the iframe process. useful with Overwolf ads that run in an iframe. Note: Please contact us before adding it to your app. Default value is true. |
file | string | Points to a local HTML file to be loaded inside the window. If you wish to host your app in a remote web-site, you’ll have to have a local page that redirects to that remote website. In such cases, you need to make sure that the block_top_window_navigation property is set to false. |
focus_game_takeover? | "ReleaseOnHidden" | "ReleaseOnLostFocus" | Allows you to control the behavior of an app window while in a “mouse-less” game state. |
focus_game_takeover_release_hotkey? | string | Allow Overwolf to display your app’s hotkey combination on the screen when the user switches to “exclusive mode”. The string value should be the hotkey name from the hotkeys section. Relevant only if you set focus_game_takeover=ReleaseOnHidden. |
forcecapture? | boolean | Indicates whether this window should always be included in recordings, overriding any other setting. |
grab_focus_on_desktop? | boolean | Indicates whether the desktop window will grab the focus automatically when it opens, or leave the focus untouched. Default value is true. |
grab_keyboard_focus? | boolean | Indicates whether the in-game window will 'steal' the keyboard focus automatically from the game when it opens, or leave the keyboard focus untouched. Default value is false. |
ignore_keyboard_events? | boolean | Indicates whether the window will receive keyboard events or pass them on to the game. |
in_game_only? | boolean | Marks the window as available in-game only (Not accessible on Desktop). |
is_alt_f4_blocked? | boolean | Blocks the user from closing the window by using Alt+F4. You can register to the onAltF4Blocked event to be noticed when a “block” was triggered. |
is_background_page? | boolean | This flag MUST be used with background/hidden controller windows. Note: With this flag set to 'true', there's no need to set window related properties such as size, focus, transparency, etc. |
keep_window_location? | boolean | Window location won’t be changed when game focus is changed. |
max_size? | Size | Defines the maximum size of the window in pixels. |
min_size? | Size | Defines the minimum size of the window in pixels. |
mute? | boolean | Mutes sounds in window. |
mute_excluded_hosts? | string[] | Excludes hosts list so a stream from these hosts origins will not get muted even if the window is on "mute": true. |
native_window? | boolean | Creates a native CEF desktop only window (which improves performance) Note: Should only be used with desktop_only windows. Default value is false. |
optimize_accelerate_rendering | boolean | Deprecated No longer supported. Valid only for transparent windows. Valid only if enable_osr_acceleration is on. |
override_on_update? | boolean | Indicates whether the window’s locally saved data should be overridden when the window’s size/location/opacity changes after a version update. |
popup_blocker? | boolean | Prevents new browser windows being opened automatically using script. Default value is false. |
resizable? | boolean | Indicates whether the window can be resized. |
restrict_to_game_bounds | boolean | A window will always stay inside the game window while dragging. |
show_in_taskbar? | boolean | Define if the window is displayed in the Windows taskbar and alt-tab window selection menu. |
show_maximize? | boolean | Enables window maximize button. Relevant only for the standard Overwolf window ("transparent": false) Default value is false. |
show_minimize? | boolean | Indicates whether to show the window minimize button. Only relevant when not in transparent mode. |
show_only_on_stream? | boolean | Indicates whether this window is visible only in streams (not visible to the streamer), overriding any other setting. |
size? | Size | Defines the size of the window in pixels when it is first opened. If your window is not resizable, this will be the constant size of your window. However, if your app is resizable – the app size is saved by Overwolf when closed so that the next time it is opened, it will preserve it. |
start_position? | Point | The default starting position of the window counted in pixels from the top left corner of the screen. |
style? | WindowStyle | Indicates whether the Mouse and keyboard input will pass to the window AND to the game (no input blocking). To change this property at runtime, use setWindowStyle(). |
topmost? | boolean | Indicates whether the window will be on top of other Overwolf windows. Handle with care as topmost windows can negatively impact user experience. |
transparent? | boolean | Indicates whether the window will be transparent and borderless. Any part of your window with transparent background ("background: transparent;") will become a see-through area that blends with the game or desktop. If set to false a standard Overwolf window will be created. |
use_os_windowing? | boolean | When set to true, allows your window to have a full-screen maximize when calling the overwolf.windows.maximize function, and a real taskbar minimize when calling overwolf.windows.minimize. Note: Should only be used with desktop_only windows. |