JSDoc: Class: Wine

Constructor

new Wine()

Source:

Engines/Wine/Engine/Object/script.js, line 23

Methods

adobeair() → {Wine}

Verb to install adobeair

Source:

Engines/Wine/Verbs/adobeair/script.js, line 10

Returns:

Wine object

Type: Wine

amstream() → {Wine}

Verb to install amstream

Source:

Engines/Wine/Verbs/amstream/script.js, line 15

Returns:

Wine object

Type: Wine

architecture() → {string}

Source:

Engines/Wine/Engine/Object/script.js, line 34

Returns:

architecture ("x86" or "amd64")

Type: string

atmlib() → {Wine}

Verb to install atmlib

Source:

Engines/Wine/Verbs/atmlib/script.js, line 10

Returns:

Wine object

Type: Wine

availableDistributions(architectureopt) → {Array.<string>}

Parameters:

Name	Type	Attributes	Default	Description
`architecture`	string	<optional>	current architecture

Source:

Engines/Wine/Engine/Object/script.js, line 301

Returns:

Type: Array.<string>

availableVersions(distribution nameopt) → {Array.<string>}

Parameters:

Name	Type	Attributes	Default	Description
`distribution name`	string	<optional>	current distribution

Source:

Engines/Wine/Engine/Object/script.js, line 318

Returns:

Type: Array.<string>

binPath(subCategoryopt, versionopt) → {string}

returns the path to the engine binary directory if no parameters are given, the Wine version of the current prefix is used

Parameters:

Name	Type	Attributes	Description
`subCategory`	string	<optional>	Wine sub-category
`version`	string	<optional>	Wine version

Source:

Engines/Wine/Engine/Object/script.js, line 112

Returns:

path to "wine" binary

Type: string

corefonts() → {Wine}

Verb to install corefonts

Source:

Engines/Wine/Verbs/corefonts/script.js, line 11

Returns:

Wine object

Type: Wine

cpuCycles(cpuCycles) → {string}

Sets CPU cycles in the current prefix https://www.dosbox.com/wiki/dosbox.conf#.5Bcpu.5D

Parameters:

Name	Type	Description
`cpuCycles`	*	(example: max 95% limit 33000)

Source:

Engines/Wine/Plugins/DOS support/script.js, line 130

Returns:

current cpuCycles

Type: string

create() → {Wine}

runs "wineboot"

Source:

Engines/Wine/Engine/Object/script.js, line 212

Returns:

The Wine object

Type: Wine

crypt32() → {Wine}

Verb to install crypt32

Source:

Engines/Wine/Verbs/crypt32/script.js, line 10

Returns:

Wine object

Type: Wine

d3drm() → {Wine}

Verb to install d3drm

Source:

Engines/Wine/Verbs/d3drm/script.js, line 13

Returns:

Wine object

Type: Wine

d3dx9() → {Wine}

Verb to install D3DX9

Source:

Engines/Wine/Verbs/d3dx9/script.js, line 10

Returns:

Wine object

Type: Wine

d3dx10() → {Wine}

Verb to install D3DX10

Source:

Engines/Wine/Verbs/d3dx10/script.js, line 10

Returns:

Wine object

Type: Wine

d3dx11() → {Wine}

Verb to install D3DX11

Source:

Engines/Wine/Verbs/d3dx11/script.js, line 10

Returns:

Wine object

Type: Wine

D9VK(d9vkVersion) → {Wine}

Verb to install D9VK see: https://github.com/Joshua-Ashton/d9vk/

Parameters:

Name	Type	Description
`d9vkVersion`	String	D9VK version to download

Source:

Engines/Wine/Verbs/D9VK/script.js, line 13

Returns:

Wine object

Type: Wine

devenum() → {Wine}

Verb to install devenum

Source:

Engines/Wine/Verbs/devenum/script.js, line 14

Returns:

Wine object

Type: Wine

DirectDrawRenderer(mode) → {Wine}

force the DirectDrawRenderer

Parameters:

Name	Type	Description
`mode`	string	(gdi or opengl)

Source:

Engines/Wine/Plugins/DirectDraw renderer/script.js, line 8

Returns:

Wine object

Type: Wine

dosbox() → {Wine}

This extensions allows script to add extra settings to dos_support wine builds

Source:

Engines/Wine/Plugins/DOS support/script.js, line 8

Returns:

Wine object

Type: Wine

dosConfigFile() → {string}

Fetch the prefix dosbox configuration file

Source:

Engines/Wine/Plugins/DOS support/script.js, line 15

Returns:

The dosbox configuration file path

Type: string

dotnet20() → {Wine}

Verb to install .NET 2.0

Source:

Engines/Wine/Verbs/dotnet20/script.js, line 13

Returns:

Wine object

Type: Wine

dotnet20sp2() → {Wine}

Verb to install .NET 2.0 SP2

Source:

Engines/Wine/Verbs/dotnet20sp2/script.js, line 16

Returns:

Wine object

Type: Wine

dotnet40() → {Wine}

Verb to install .NET 4.0

Source:

Engines/Wine/Verbs/dotnet40/script.js, line 14

Returns:

Wine object

Type: Wine

dotnet45() → {Wine}

Verb to install .NET 4.5

Source:

Engines/Wine/Verbs/dotnet45/script.js, line 13

Returns:

Wine object

Type: Wine

dotnet46() → {Wine}

Verb to install .NET 4.6

Source:

Engines/Wine/Verbs/dotnet46/script.js, line 14

Returns:

Wine object

Type: Wine

dotnet452() → {Wine}

Verb to install .NET 4.5.2

Source:

Engines/Wine/Verbs/dotnet452/script.js, line 15

Returns:

Wine object

Type: Wine

dotnet461() → {Wine}

Verb to install .NET 4.6.1

Source:

Engines/Wine/Verbs/dotnet461/script.js, line 15

Returns:

Wine object

Type: Wine

dotnet462() → {Wine}

Verb to install .NET 4.6.2

Source:

Engines/Wine/Verbs/dotnet462/script.js, line 15

Returns:

Wine object

Type: Wine

dotnet472() → {Wine}

Verb to install .NET 4.7.2

Source:

Engines/Wine/Verbs/dotnet472/script.js, line 15

Returns:

Wine object

Type: Wine

DXVK(dxvkVersion) → {Wine}

Verb to install DXVK see: https://github.com/doitsujin/dxvk/

Parameters:

Name	Type	Description
`dxvkVersion`	String	DXVK version to download

Source:

Engines/Wine/Verbs/DXVK/script.js, line 13

Returns:

Wine object

Type: Wine

enableCSMT() → {Wine}

enable command stream multi-threading

Source:

Engines/Wine/Plugins/csmt/script.js, line 8

Returns:

Wine object

Type: Wine

faudio(faudioVersion) → {Wine}

Verb to install FAudio see: https://github.com/Kron4ek/FAudio-Builds

Parameters:

Name	Type	Description
`faudioVersion`	String	version of FAudio to downlaod

Source:

Engines/Wine/Verbs/FAudio/script.js, line 13

Returns:

Wine object

Type: Wine

fontDirectory() → {string}

Source:

Engines/Wine/Engine/Object/script.js, line 359

Returns:

font directory

Type: string

fontSmoothing(mode) → {Wine}

Force the Font smoothing

Parameters:

Name	Type	Description
`mode`	string	("RGB", "BGR" or "Gray Scale")

Source:

Engines/Wine/Plugins/Font smoothing/script.js, line 8

Returns:

Wine object

Type: Wine

gallium9(gallium9Version) → {Wine}

Verb to install Gallium 9 Standalone see: https://github.com/iXit/wine-nine-standalone/

Parameters:

Name	Type	Description
`gallium9Version`	String	Gallium 9 Standalone version to download

Source:

Engines/Wine/Verbs/gallium9/script.js, line 13

Returns:

Wine object

Type: Wine

gdiplus() → {Wine}

Verb to install gdiplus

Source:

Engines/Wine/Verbs/gdiplus/script.js, line 11

Returns:

Wine object

Type: Wine

getSetting(key) → {*}

Get one dosbox setting

Parameters:

Name	Type	Description
`key`	string	The key of the setting (example dosbox_memsize)

Source:

Engines/Wine/Plugins/DOS support/script.js, line 61

Returns:

The value (example: 64)

Type: *

getSettings() → {Object}

Fetch all prefix dosbox sttings

Source:

Engines/Wine/Plugins/DOS support/script.js, line 42

Returns:

All the settings

Type: Object

hdpi(hdpiopt) → {boolean|Wine}

gets/sets hdpi state

Parameters:

Name	Type	Attributes	Description
`hdpi`	boolean	<optional>	true if hdpi shall be enabled

Source:

Engines/Wine/Plugins/hdpi/script.js, line 9

Returns:

get: if is hdpi, set: Wine object

Type: boolean | Wine

kill() → {Wine}

kill wine server

Source:

Engines/Wine/Engine/Object/script.js, line 290

Returns:

Type: Wine

luna() → {Wine}

Verb to install luna

Source:

Engines/Wine/Verbs/luna/script.js, line 11

Returns:

Wine object

Type: Wine

managed(managedopt) → {boolean|Wine}

gets/sets managed state

Parameters:

Name	Type	Attributes	Description
`managed`	boolean	<optional>	true if it shall be managed

Source:

Engines/Wine/Plugins/managed/script.js, line 9

Returns:

get: if is managed, set: Wine object

Type: boolean | Wine

memSize(memSize) → {string}

Sets dosbox_memsize parameter in the current prefix https://www.dosbox.com/wiki/dosbox.conf#.5Bdosbox.5D

Parameters:

Name	Type	Description
`memSize`	int	The memory size

Source:

Engines/Wine/Plugins/DOS support/script.js, line 85

Returns:

current memory size

Type: string

mfc42() → {Wine}

Verb to install mfc42.dll and mfc42u.dll

Source:

Engines/Wine/Verbs/mfc42/script.js, line 10

Returns:

Wine object

Type: Wine

msls31() → {Wine}

Verb to install msls31.dll

Source:

Engines/Wine/Verbs/msls31/script.js, line 9

Returns:

Wine object

Type: Wine

mspatcha() → {Wine}

Verb to install mspatcha

Source:

Engines/Wine/Verbs/mspatcha/script.js, line 11

Returns:

Wine object

Type: Wine

msxml3() → {Wine}

Verb to install msxml3

Source:

Engines/Wine/Verbs/msxml3/script.js, line 12

Returns:

Wine object

Type: Wine

msxml6() → {Wine}

Verb to install msxml6

Source:

Engines/Wine/Verbs/msxml6/script.js, line 11

Returns:

Wine object

Type: Wine

nativeApplication(extensionopt) → {string|Wine}

use native application for a certain file extension

Parameters:

Name	Type	Attributes	Description
`extension`	string	<optional>	file extension (pdf, txt, rtf)

Source:

Engines/Wine/Plugins/native application/script.js, line 9

Returns:

get: native application, set: Wine object

Type: string | Wine

physx() → {Wine}

Verb to install Nvidia PhysX

Source:

Engines/Wine/Verbs/PhysX/script.js, line 10

Returns:

Wine object

Type: Wine

prefix(prefixopt, distributionopt, architectureopt, versionopt) → {string|Wine}

Parameters:

Name	Type	Attributes
`prefix`	string	<optional>
`distribution`	string	<optional>
`architecture`	string	<optional>
`version`	string	<optional>

Source:

Engines/Wine/Engine/Object/script.js, line 77

Returns:

Type: string | Wine

prefixDirectory() → {string}

returns prefix directory

Source:

Engines/Wine/Engine/Object/script.js, line 101

Returns:

Type: string

programFiles() → {string}

Source:

Engines/Wine/Engine/Object/script.js, line 222

Returns:

name of "Program Files"

Type: string

quartz() → {Wine}

Verb to install quartz

Source:

Engines/Wine/Verbs/quartz/script.js, line 12

Returns:

Wine object

Type: Wine

quicktime76() → {Wine}

Verb to install QuickTime 7.6

Source:

Engines/Wine/Verbs/QuickTime 7.6/script.js, line 9

Returns:

Wine object

Type: Wine

regedit() → {Wine}

Regedit support

Source:

Engines/Wine/Plugins/regedit/script.js, line 7

Returns:

Wine object

Type: Wine

regsvr32() → {Wine}

runs "regsvr32"

Source:

Engines/Wine/Plugins/regsvr32/script.js, line 7

Returns:

Wine object

Type: Wine

removeMono() → {Wine}

Verb to remove mono

Source:

Engines/Wine/Verbs/Remove Mono/script.js, line 10

Returns:

Wine object

Type: Wine

renderAspect(renderAspect) → {string}

Sets render_aspect parameter in the current prefix https://www.dosbox.com/wiki/dosbox.conf#.5Brender.5D

Parameters:

Name	Type	Description
`renderAspect`	boolean	The render aspect

Source:

Engines/Wine/Plugins/DOS support/script.js, line 100

Returns:

current renderAspect

Type: string

renderFrameSkip(renderFrameSkip) → {string}

Sets render_frameskip parameter in the current prefix https://www.dosbox.com/wiki/dosbox.conf#.5Brender.5D

Parameters:

Name	Type	Description
`renderFrameSkip`	int	The render frameskip

Source:

Engines/Wine/Plugins/DOS support/script.js, line 115

Returns:

current frameskip

Type: string

run(executable, argsopt, workingDirectoryopt, captureOutputopt, waitopt, userDataopt) → {String}

Parameters:

Name	Type	Attributes	Default
`executable`	string
`args`	array	<optional>	[]
`workingDirectory`	string	<optional>	working container
`captureOutput`	boolean	<optional>	false
`wait`	boolean	<optional>	false
`userData`	map	<optional>	empty

Source:

Engines/Wine/Engine/Object/script.js, line 162

Returns:

output

Type: String

runInsidePrefix(executable, argsopt, waitopt)

Parameters:

Name	Type	Attributes	Default
`executable`	string
`args`	array	<optional>	[]
`wait`	boolean	<optional>	false

Source:

Engines/Wine/Engine/Object/script.js, line 138

sandbox() → {Wine}

Verb to install a sandbox

Source:

Engines/Wine/Verbs/sandbox/script.js, line 9

Returns:

Wine object

Type: Wine

secur32() → {Wine}

Verb to install secur32

Source:

Engines/Wine/Verbs/secur32/script.js, line 11

Returns:

Wine object

Type: Wine

setSetting(key, value) → {void}

Set a setting in the prefix dosbox configuration file

Parameters:

Name	Type	Description
`key`	string	The key (example: dosbox_memsize)
`value`	*	The value (example: 64)

Source:

Engines/Wine/Plugins/DOS support/script.js, line 25

Returns:

Type: void

setSoundDriver(driver) → {Wine}

sets sound driver

Parameters:

Name	Type	Description
`driver`	string	(alsa, pulse)

Source:

Engines/Wine/Plugins/sound driver/script.js, line 9

Returns:

Wine object

Type: Wine

setting(key, value:) → {*}

Set or get one dosbox setting

Parameters:

Name	Type	Description
`key`	string	The key of the setting (example dosbox_memsize)
`value:`	string	The value to be set

Source:

Engines/Wine/Plugins/DOS support/script.js, line 71

Returns:

The value (example: 64) if this is a getter, the same object otherwise

Type: *

setVersionGL(major, minor) → {Wine}

sets OpenGL max core version

Parameters:

Name	Type	Description
`major`	number	major version
`minor`	number	minor version

Source:

Engines/Wine/Plugins/OpenGL version/script.js, line 10

Returns:

Wine object

Type: Wine

setVirtualDesktop(width, height) → {Wine}

sets Virtual Desktop with window resolution

Parameters:

Name	Type	Description
`width`	number	width of virtual desktop (in px)
`height`	number	height of virtual desktop (in px)

Source:

Engines/Wine/Plugins/virtual desktop/script.js, line 9

Returns:

Wine object

Type: Wine

sp3extract(fileToExtract) → {Wine}

Verb to install Windows XP Service Pack 3

Parameters:

Name	Type	Description
`fileToExtract`	string	path to file which shall be extracted

Source:

Engines/Wine/Verbs/Windows XP SP 3/script.js, line 11

Returns:

Wine object

Type: Wine

system32directory() → {string}

Source:

Engines/Wine/Engine/Object/script.js, line 335

Returns:

system32 directory

Type: string

system64directory() → {string}

Source:

Engines/Wine/Engine/Object/script.js, line 347

Returns:

system64 directory

Type: string

tahoma() → {Wine}

Verb to install the Tahoma font

Source:

Engines/Wine/Verbs/Tahoma/script.js, line 13

Returns:

Wine object

Type: Wine

uninstall(name) → {bool}

uninstall application

Parameters:

Name	Type	Description
`name`	string	of the application which shall be uninstalled

Source:

Engines/Wine/Engine/Object/script.js, line 190

Returns:

true if an application has been uninstalled, false otherwise

Type: bool

uplay() → {Wine}

Verb to install Uplay

Source:

Engines/Wine/Verbs/Uplay/script.js, line 9

Returns:

Wine object

Type: Wine

UseGLSL(mode) → {Wine}

force the Use of GLSL

Parameters:

Name	Type	Description
`mode`	string	(enabled or disabled)

Source:

Engines/Wine/Plugins/GLSL/script.js, line 9

Returns:

Wine object

Type: Wine

UseTakeFocus(mode) → {Wine}

force the UseTakeFocus

Parameters:

Name	Type	Description
`mode`	string	("Y" or "N")

Source:

Engines/Wine/Plugins/UseTakeFocus/script.js, line 9

Returns:

Wine object

Type: Wine

vcrun6sp6() → {Wine}

Verb to install vcrun6sp6

Source:

Engines/Wine/Verbs/vcrun6sp6/script.js, line 10

Returns:

Wine object

Type: Wine

vcrun2003() → {Wine}

Verb to install vcrun2003

Source:

Engines/Wine/Verbs/vcrun2003/script.js, line 11

Returns:

Wine object

Type: Wine

vcrun2005() → {Wine}

Verb to install vcrun2005

Source:

Engines/Wine/Verbs/vcrun2005/script.js, line 10

Returns:

Wine object

Type: Wine

vcrun2008() → {Wine}

Verb to install vcrun2008

Source:

Engines/Wine/Verbs/vcrun2008/script.js, line 11

Returns:

Wine object

Type: Wine

vcrun2010() → {Wine}

Verb to install vcrun2010

Source:

Engines/Wine/Verbs/vcrun2010/script.js, line 11

Returns:

Wine object

Type: Wine

vcrun2012() → {Wine}

Verb to install vcrun2012

Source:

Engines/Wine/Verbs/vcrun2012/script.js, line 11

Returns:

Wine object

Type: Wine

vcrun2013() → {Wine}

Verb to install vcrun2013

Source:

Engines/Wine/Verbs/vcrun2013/script.js, line 11

Returns:

Wine object

Type: Wine

vcrun2015() → {Wine}

Verb to install vcrun2015

Source:

Engines/Wine/Verbs/vcrun2015/script.js, line 11

Returns:

Wine object

Type: Wine

vcrun2017() → {Wine}

Verb to install vcrun2017

Source:

Engines/Wine/Verbs/vcrun2017/script.js, line 11

Returns:

Wine object

Type: Wine

VK9(vk9Version) → {Wine}

Verb to install VK9 see: https://github.com/disks86/VK9

Parameters:

Name	Type	Description
`vk9Version`	String	VK9 version to install

Source:

Engines/Wine/Verbs/VK9/script.js, line 13

Returns:

Wine object

Type: Wine

vulkanSDK() → {Wine}

All the necessary things to run winevulkan (even inside wine mainline or newest wine-staging) see: https://github.com/roderickc/wine-vulkan

Source:

Engines/Wine/Verbs/vulkanSDK/script.js, line 13

Returns:

Wine object

Type: Wine

wait() → {Wine}

wait until wineserver finishes

Source:

Engines/Wine/Engine/Object/script.js, line 280

Returns:

Type: Wine

windowsVersion(version, servicePackopt) → {string|Wine}

default windows version

Parameters:

Name	Type	Attributes	Description
`version`	string		(win7, vista, win2003, winxp, win2k, winnt, winme, win98, win95, win31)
`servicePack`	string	<optional>	e.g. sp3

Source:

Engines/Wine/Plugins/Windows version/script.js, line 10

Returns:

get: Windows version, set: Wine object

Type: string | Wine

winepath(pathopt) → {String}

Parameters:

Name	Type	Attributes	Description
`path`	String	<optional>

Source:

Engines/Wine/Engine/Object/script.js, line 65

Returns:

Type: String

wineServer(wineserver)

executes wineserver in current prefix

Parameters:

Name	Type	Description
`wineserver`	string	parameter

Source:

Engines/Wine/Engine/Object/script.js, line 242

wizard(wizardopt) → {SetupWizard|Wine}

Parameters:

Name	Type	Attributes	Description
`wizard`	SetupWizard	<optional>

Source:

Engines/Wine/Engine/Object/script.js, line 50

Returns:

Type: SetupWizard | Wine

xact() → {Wine}

Verb to install xact

Source:

Engines/Wine/Verbs/xact/script.js, line 11

Returns:

Wine object

Type: Wine