libretro.drivers.user.default

A user driver with configurable username and language.

See also

libretro.api.user

Defines the language and username types this driver supplies.

Classes

DefaultUserDriver

A UserDriver with configurable username and language.

class DefaultUserDriver[source]

Bases: UserDriver

A UserDriver with configurable username and language.

__init__(username='libretro.py', language=Language.ENGLISH)[source]
Parameters:
  • username (str | bytes | None) – The player username to expose to cores. str values are encoded to bytes via UTF-8. None disables RETRO_ENVIRONMENT_GET_USERNAME.

  • language (Language | None) – The UI language to expose to cores. Defaults to ENGLISH.

Raises:

TypeError – If either argument is not of the expected type.

classmethod __new__(*args, **kwargs)
property username

The player username exposed to the core via RETRO_ENVIRONMENT_GET_USERNAME.

None disables the environment call.

property language

The UI language exposed to the core via RETRO_ENVIRONMENT_GET_LANGUAGE.

None disables the environment call.