Skip to content
Bit Quirky Behavior Trees and
State Machines

Search documentation

All topics and APIs

Close returns focus to Search.

What are you looking for?

Try a common topic or enter a complete API identifier.

Browse the reference instead

Esc closes · Tab reaches results · Enter opens the focused link

v0.11.0
Menu

BitQuirky.Core.Config

Public bit quirky core symbols in BitQuirky.Core.Config.

Source snapshot 29003d8b1658.

Assembly: BitQuirky.Core

Category: Low-level runtime

C#
class BitQuirky.Core.Config.BaseConfig

Source declaration: ../bitquirky-core/Runtime/Config/BaseConfig.cs:22-45

Inherits: DataObject

Optional per-game configuration hook. A project needs a config asset only when it overrides a convention; at most one instance may exist in a project.

Responsibilities:

  • Receives the GameLogic lifecycle first when present, before any other data object.
  • Lets a game override the built scene list viaGetScenePaths.

Does NOT:

  • Exist by requirement: builds use the enabled Editor Build Settings scenes by convention, and the assembly-definition generator owns its own ignore list.

GetScenePaths(BaseConfig.BuildType buildType)

Section titled “GetScenePaths(BaseConfig.BuildType buildType)”
C#
public virtual string[] GetScenePaths(BitQuirky.Core.Config.BaseConfig.BuildType buildType)

Source declaration: ../bitquirky-core/Runtime/Config/BaseConfig.cs:43-44

Override to replace the build-scene convention (the enabled Editor Build Settings scenes). Returning null keeps the convention.

Category: Low-level runtime

C#
enum BitQuirky.Core.Config.BaseConfig.BuildType

Source declaration: ../bitquirky-core/Runtime/Config/BaseConfig.cs:25-37

Underlying type: int

Kind of build a scene list is being requested for.

C#
Demo = 0

Source declaration: ../bitquirky-core/Runtime/Config/BaseConfig.cs:30

Cut-down build for public demos.

C#
Development = 1

Source declaration: ../bitquirky-core/Runtime/Config/BaseConfig.cs:32

Internal build with development tooling.

C#
Release = 2

Source declaration: ../bitquirky-core/Runtime/Config/BaseConfig.cs:34

Build shipped to players.

C#
Test = 3

Source declaration: ../bitquirky-core/Runtime/Config/BaseConfig.cs:36

Build used by automated tests.

Category: Low-level runtime

C#
class BitQuirky.Core.Config.ConfigLoader

Source declaration: ../bitquirky-core/Runtime/Config/ConfigLoader.cs:18-118

Inherits: DataObject

Bootstrap asset that tells the game which data object index and which optional per-game config to use. A game assigns it once at startup, throughInitializeor, with Addressables installed, InitializeAsync; everything that resolves data objects by name then goes through it.

C#
public BitQuirky.Core.Config.BaseConfig Config { get; }

Source declaration: ../bitquirky-core/Runtime/Config/ConfigLoader.cs:35

Per-game configuration asset, or null when the game relies entirely on conventions.

C#
public BitQuirky.Core.Data.DataObjectIndex DataObjectIndex { get; }

Source declaration: ../bitquirky-core/Runtime/Config/ConfigLoader.cs:33

Index used to resolve data objects by name throughout the game.

C#
public static BitQuirky.Core.Config.ConfigLoader Instance { get; }

Source declaration: ../bitquirky-core/Runtime/Config/ConfigLoader.cs:42-54

The loader assigned byInitialize. In the editor, an uninitialized instance resolves by convention to the project’s unique ConfigLoader asset; a project without one yields null, because the loader is optional bootstrap wiring.

C#
public static void Initialize(BitQuirky.Core.Config.ConfigLoader loader)

Source declaration: ../bitquirky-core/Runtime/Config/ConfigLoader.cs:67-71

Assign the runtime instance directly (no Addressables required).

Parameters

  • loader: Loader asset to use; asserts when null.

InitializeAsync<TAssetReference>(TAssetReference assetReference)

Section titled “InitializeAsync<TAssetReference>(TAssetReference assetReference)”
C#
public static System.Threading.Tasks.Task InitializeAsync<TAssetReference>(TAssetReference assetReference)

Source declaration: ../bitquirky-core/Runtime/Config/ConfigLoader.cs:75-84

Loads the loader asset through an Addressables asset reference and assigns it for the rest of the session. Does nothing when a loader is already assigned. The binary API does not depend on compilation symbols; callers must supply an Addressables asset reference when using this overload.

Parameters

  • assetReference: Addressables asset reference pointing at the loader asset.

Source fingerprint: sha256:29003d8b1658b98a79bebcd93e3b4030caf8511268b96817ab764d63df8d6c3b

Full-size image