Skip to content

addon

Declare the xStudio Addon.

XStudioAddon

Bases: AYONAddon, IPluginPaths

Addon adds xstudio functionality via plugins.

Source code in client/ayon_xstudio/addon.py 
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
class XStudioAddon(AYONAddon, IPluginPaths):
    """Addon adds xstudio functionality via plugins."""

    name = ADDON_NAME  # type: ignore  # noqa: PGH003
    version = __version__  # type: ignore  # noqa: PGH003

    def get_loader_action_plugin_paths(  # noqa: PLR6301
        self, host_name: Optional[str] = None
    ) -> list[str]:
        """Get load plugin paths.

        Args:
            host_name: Optional host name to filter paths.

        Returns:
            List[str]: List of load plugin paths.
        """
        return [
            os.path.join(XSTUDIO_ROOT, "plugins", "loader"),
        ]

get_loader_action_plugin_paths(host_name=None)

Get load plugin paths.

Parameters:

Name Type Description Default
host_name Optional[str]

Optional host name to filter paths.

 None

Returns:

Type Description
list[str]

List[str]: List of load plugin paths.
Source code in client/ayon_xstudio/addon.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def get_loader_action_plugin_paths(  # noqa: PLR6301
    self, host_name: Optional[str] = None
) -> list[str]:
    """Get load plugin paths.

    Args:
        host_name: Optional host name to filter paths.

    Returns:
        List[str]: List of load plugin paths.
    """
    return [
        os.path.join(XSTUDIO_ROOT, "plugins", "loader"),
    ]