bacommon.workspace package

Functionality related to ballistica.net workspaces.

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: str | None = None, base_assets_filter: str = '')[source]

Bases: object

Global values for an assets_v1 workspace.

base_assets: str | None = None
base_assets_filter: str = ''
class bacommon.workspace.assetsv1.AssetsV1PathVals[source]

Bases: IOMultiType[AssetsV1PathValsTypeID]

Top level class for path vals classes.

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

Return a specific subclass given a type-id.

classmethod get_type_id() → AssetsV1PathValsTypeID[source]

Return the type-id for this subclass.

classmethod get_type_id_storage_name() → str[source]

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: TextureQuality = TextureQuality.MEDIUM)[source]

Bases: AssetsV1PathVals

Path-specific values for an assets_v1 workspace path.

class TextureQuality(*values)[source]

Bases: Enum

Quality settings for our textures.

HIGH = 'high'
LOW = 'low'
MEDIUM = 'medium'
classmethod get_type_id() → AssetsV1PathValsTypeID[source]

Return the type-id for this subclass.

texture_quality: TextureQuality = 'medium'
class bacommon.workspace.assetsv1.AssetsV1PathValsTypeID(*values)[source]

Bases: Enum

Types of vals we can store for paths.

TEX_V1 = 'tex_v1'
class bacommon.workspace.assetsv1.AssetsV1StrData(inputs: list[AssetsV1StrInput] = <factory>, outputs: list[Output] = <factory>, next_output_id: int = 0)[source]

Bases: object

Data and output for a string asset.

class Output(output_id: int, created: datetime.datetime, source: Source, locale: Locale, value_default: str | None = None)[source]

Bases: object

Represents a single instance of localized output.

class Source(*values)[source]

Bases: Enum

Where localized output can come from.

AI_V1 = 'ai_v1'
created: datetime.datetime
locale: Locale
output_id: int
source: Source
value_default: str | None = None
inputs: list[AssetsV1StrInput]
next_output_id: int = 0
outputs: list[Output]
class bacommon.workspace.assetsv1.AssetsV1StrInput[source]

Bases: IOMultiType[AssetsV1StrInputTypeID]

Top level class for our multitype.

classmethod get_type(type_id: AssetsV1StrInputTypeID) → type[AssetsV1StrInput][source]

Return the subclass for each of our type-ids.

classmethod get_type_id() → AssetsV1StrInputTypeID[source]

Return the type-id for this subclass.

class bacommon.workspace.assetsv1.AssetsV1StrInputTypeID(*values)[source]

Bases: Enum

Type ID for each of our subclasses.

BASIC = 'b'
class bacommon.workspace.assetsv1.BasicV1StrInput[source]

Bases: AssetsV1StrInput

Just a test.

classmethod get_type_id() → AssetsV1StrInputTypeID[source]

Return the type-id for this subclass.