Skip to main content

Overview

APIDescription
overwolf.windows.enums.FlashBehavior-
overwolf.windows.enums.MessagePromptIcon-
overwolf.windows.enums.WindowDragEdge-
overwolf.windows.enums.WindowStateEx-
overwolf.windows.enums.WindowStyle-
overwolf.windows.enums.WindowType-
overwolf.windows.bringToFrontBrings the requested window to the front.
overwolf.windows.changePositionChanges the window position in pixels from the top left corner.
overwolf.windows.changeSizeChanges the window size to the new width and height, in pixels.
overwolf.windows.closeCloses the window.
overwolf.windows.displayMessageBoxDisplays a customized popup message prompt.
overwolf.windows.dragMoveStart dragging a window.
overwolf.windows.dragResizeStart resizing the window from a specific edge or corner.
overwolf.windows.flashFlashes a window.
overwolf.windows.getCurrentWindowCalls the given callback function with the current window object as a parameter.
overwolf.windows.getMainWindowReturns a window object of the index page.
overwolf.windows.getOpenWindowsReturns an array of all open windows as objects. The objects can be manipulated like any other window.
overwolf.windows.getWindowReturns WindowResult object for a specific open window.
overwolf.windows.getWindowDPIGet Window DPI.
overwolf.windows.getWindowsStatesReturns the state of all windows owned by the app (normal/minimized/maximized/closed).
overwolf.windows.getWindowStateReturns the state of the window (normal/minimized/maximized/closed).
overwolf.windows.hideHides the window.
overwolf.windows.isAccelreatedOSRFor OSR window only (for other window the callback return error status. { "status": string (|error, success|), "reason": string (error reason), "accelerated": bool, "optimized" : bool (for accelerated windows only and only valid in Game) }
overwolf.windows.isMutedIs window muted.
overwolf.windows.isWindowVisibleToUserIs window fully visible to user (has overlap windows)
overwolf.windows.maximizeMaximizes the window.
overwolf.windows.minimizeMinimizes the window.
overwolf.windows.muteAllMute all sound source include all excluded white list
overwolf.windows.obtainDeclaredWindowCreates or returns a window by the window name that was declared in the manifest.
overwolf.windows.openOptionsPageOpens the options page specified in the manifest file. Does nothing if no such page has been specified.
overwolf.windows.removeWindowStyleRemove Window In Game Styling
overwolf.windows.restoreRestores a minimized window.
overwolf.windows.sendMessageSends a message to an open window.
overwolf.windows.sendToBackSends the window to the back.
overwolf.windows.setDesktopOnlySets whether the window should be injected to games or not.
overwolf.windows.setMinSizeChanges the window minimum size to the new width and height, in pixels.
overwolf.windows.setMuteSet current window Mute state.
overwolf.windows.setPositionChange window position (see SetWindowPositionProperties))
overwolf.windows.setRestoreAnimationsEnabledSets whether the window should have minimize/restore animations while in game.
overwolf.windows.setTopmostChange the window's topmost status. Handle with care as topmost windows can negatively impact user experience.
overwolf.windows.setWindowStyleAdd Window In Game styling
overwolf.windows.setZoomSet window zoom level (0.0 for reset).
overwolf.windows.AltF4BlockedEvent-
overwolf.windows.ChangeWindowSizeParams-
overwolf.windows.DefaultSizeAndLocation-
overwolf.windows.DragMovedResult-
overwolf.windows.DragResizeResult-
overwolf.windows.GetWindowsStatesResult-
overwolf.windows.GetWindowStateResult-
overwolf.windows.IsAccelreatedOSRResult-
overwolf.windows.IsMutedResult-
overwolf.windows.IsolatedIframeProcessCrashedEvent-
overwolf.windows.IsWindowVisibleToUserResult-
overwolf.windows.MessageBoxParams-
overwolf.windows.MessageReceivedEvent-
overwolf.windows.ODKRect-
overwolf.windows.onScreenPropertyChangedEvent-
overwolf.windows.SetWindowPositionProperties-
overwolf.windows.WindowIdResult-
overwolf.windows.WindowInfo-
overwolf.windows.WindowProperties-
overwolf.windows.WindowResult-
overwolf.windows.WindowStateChangedEvent-
overwolf.windows.onAltF4BlockedFired when the user was prevented from closing a window using Alt+F4
overwolf.windows.onIsolatedIframeProcessCrashedFired when out of process iframe crashed.
overwolf.windows.onMainWindowRestoredFired when the main window is restored.
overwolf.windows.onMessageReceivedFired when this window received a message.
overwolf.windows.onStateChangedFired when the state of a window is changed.
overwolf.windows.onSubscriptionChangedFired when current extension subscription has changed.