bacommon.workspace package

Submodules

bacommon.workspace.assetsv1 module

Public types for assets-v1 workspaces.

These types may only be used server-side, but they are exposed here for reference when setting workspace config data by hand or for use in client-side workspace modification tools. There may be advanced settings that are not accessible through the UI/etc.

class bacommon.workspace.assetsv1.AssetsV1GlobalVals(base_assets: ~typing.Annotated[str | None, <efro.dataclassio.IOAttrs object at 0x7f2d2de920c0>] = None, base_assets_filter: ~typing.Annotated[str, <efro.dataclassio.IOAttrs object at 0x7f2d2de93560>] = '')

Bases: object

Global values for an assets_v1 workspace.

base_assets: IOAttrs object at 0x7f2d2d494800>] = None

base_assets_filter: IOAttrs object at 0x7f2d2d494c50>] = ''

class bacommon.workspace.assetsv1.AssetsV1PathVals

Bases: IOMultiType[AssetsV1PathValsTypeID]

Top level class for path vals classes.

classmethod get_type(type_id: AssetsV1PathValsTypeID) → type[AssetsV1PathVals]

Return a specific subclass given a type-id.

classmethod get_type_id() → AssetsV1PathValsTypeID

Return the type-id for this subclass.

classmethod get_type_id_storage_name() → str

Return the key used to store type id in serialized data.

The default is an obscure value so that it does not conflict with members of individual type attrs, but in some cases one might prefer to serialize it to something simpler like ‘type’ by overriding this call. One just needs to make sure that no encompassed types serialize anything to ‘type’ themself.

class bacommon.workspace.assetsv1.AssetsV1PathValsTexV1(texture_quality: Annotated[TextureQuality, IOAttrs('texture_quality', store_default=False)] = TextureQuality.MEDIUM)

Bases: AssetsV1PathVals

Path-specific values for an assets_v1 workspace path.

class TextureQuality(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Quality settings for our textures.

HIGH = 'high'

LOW = 'low'

MEDIUM = 'medium'

classmethod get_type_id() → AssetsV1PathValsTypeID

Return the type-id for this subclass.

texture_quality: Annotated[TextureQuality, IOAttrs('texture_quality', store_default=False)] = 'medium'

class bacommon.workspace.assetsv1.AssetsV1PathValsTypeID(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: Enum

Types of vals we can store for paths.

TEX_V1 = 'tex_v1'

Module contents

Workspace functionality.