Caffeine

Service registry

Reference Last updated:

Serviços partilhados entre plugins através do registo do host.

Host legado. O Doppio atual em Rust/Iced não carrega plugins C++. Estas páginas documentam o SDK de plugins C++/ImGui e o seu host no editor C++ arquivado (doppio-archived/). A engine continua a compilar todos os plugins do submódulo, para que o SDK se mantenha testado na compilação.

O host C++ legado fornece um registo genérico de serviços. Os plugins registam handlers com nome; qualquer código (host ou outros plugins) pode chamar invokeService.

Isto evita embutir pontes de funcionalidades no core do editor.

Architecture#

text
┌──────────────┐     registerService      ┌─────────────────┐
│ terrain_plugin│ ──────────────────────► │ PluginService   │
└──────────────┘                          │ Registry        │
                                          └────────┬────────┘
┌──────────────┐     invokeService                │
│ other plugin │ ◄────────────────────────────────┘
└──────────────┘

Well-known services#

Defined in include/caffeine/plugin/PluginServices.hpp:

Terrain#

Service Request Response
terrain.generateUltra TerrainGenerateUltraRequest —
terrain.importHeightmap TerrainImportHeightmapRequest —

Procedural streaming#

Service Request Response
procedural.installScripts — —
procedural.createStreamingSetup ProceduralStreamingSetupRequest ProceduralSetupResponse
procedural.loadBenchmark ProceduralLoadBenchmarkRequest ProceduralSetupResponse

Registering a service#

cpp
bool myHandler(void* editorContext, const void* request, std::size_t requestSize,
               void* response, std::size_t responseSize) {
    // parse request, fill response
    return true;
}

void OnLoad() override {
    m_host->registerService(m_host->editorContext, GetName(),
                            "myplugin.export", &myHandler);
}

Invoking a service#

cpp
MyRequest req{};
MyResponse resp{};
m_host->invokeService(m_host->editorContext, "terrain.generateUltra",
                      &req, sizeof(req), &resp, sizeof(resp));

Guidelines for new services#

  1. Use dot-separated names: vendor.feature.action (e.g. acme.navmesh.bake)
  2. Document struct layouts in your plugin README — they are plain C structs, not versioned wire format
  3. Return false on unknown request size or invalid state
  4. Keep handlers fast; offload heavy work to background jobs inside your plugin

Owner plugins#

Service prefix Owner
terrain.* terrain-generator
procedural.* procedural-tools