games.game_installer_if.GameInstallerIf Class Reference

Environment adapter used to query, install, and launch game packages. More...

Inheritance diagram for games.game_installer_if.GameInstallerIf:

Public Member Functions
str	backend_id (self)
	Return the stable identifier used for persistent inventory entries.
bool	is_available (self, GameDefinition game)
	Return whether this environment can install a game.
bool	is_installed (self, GameDefinition game)
	Return whether a game is installed in this environment.
None	install (self, GameDefinition game)
	Install a game or raise an exception on failure.
Sequence[str]	launch_command (self, GameDefinition game)
	Build the host command used to launch a game.
tuple[str|None, str|None]	window_selectors (self, GameDefinition game)
	Return backend-specific X11 window selectors when needed.
bool	relax_window_size_hints (self, GameDefinition game)
	Return whether the embedding backend may ignore application size hints.

Detailed Description

Environment adapter used to query, install, and launch game packages.

Member Function Documentation

backend_id()

str games.game_installer_if.GameInstallerIf.backend_id

(

self

)

Return the stable identifier used for persistent inventory entries.

Returns

Stable backend identifier.

Reimplemented in games.debian_game_installer.DebianGameInstaller, and games.termux_game_installer.TermuxGameInstaller.

install()

None games.game_installer_if.GameInstallerIf.install	(		self,
		GameDefinition	game
	)

Install a game or raise an exception on failure.

Parameters

game	Configured game definition to install.

Reimplemented in games.debian_game_installer.DebianGameInstaller, and games.termux_game_installer.TermuxGameInstaller.

is_available()

bool games.game_installer_if.GameInstallerIf.is_available	(		self,
		GameDefinition	game
	)

Return whether this environment can install a game.

Parameters

game	Configured game definition to query.

Returns

True when this backend can install the game, otherwise False.

Reimplemented in games.debian_game_installer.DebianGameInstaller, and games.termux_game_installer.TermuxGameInstaller.

is_installed()

bool games.game_installer_if.GameInstallerIf.is_installed	(		self,
		GameDefinition	game
	)

Return whether a game is installed in this environment.

Parameters

game	Configured game definition to query.

Returns

True when this backend already has the game installed, otherwise False.

Reimplemented in games.debian_game_installer.DebianGameInstaller, and games.termux_game_installer.TermuxGameInstaller.

launch_command()

Sequence[str] games.game_installer_if.GameInstallerIf.launch_command	(		self,
		GameDefinition	game
	)

Build the host command used to launch a game.

Parameters

game	Configured game definition to launch.

Returns

Command arguments suitable for the host process launcher.

Reimplemented in games.debian_game_installer.DebianGameInstaller, and games.termux_game_installer.TermuxGameInstaller.

relax_window_size_hints()

bool games.game_installer_if.GameInstallerIf.relax_window_size_hints	(		self,
		GameDefinition	game
	)

Return whether the embedding backend may ignore application size hints.

Parameters

game	Configured game definition whose window hints may be relaxed.

Returns

True when the backend may ignore application size hints, otherwise False.

Reimplemented in games.debian_game_installer.DebianGameInstaller.

window_selectors()

tuple[str | None, str | None] games.game_installer_if.GameInstallerIf.window_selectors	(		self,
		GameDefinition	game
	)

Return backend-specific X11 window selectors when needed.

Parameters

game	Configured game definition whose runtime window will be selected.

Returns

Pair containing an optional window name and optional window class.

Reimplemented in games.debian_game_installer.DebianGameInstaller.

---

The documentation for this class was generated from the following file:

• controllers/games/game_installer_if.py