Problem Statement
The main entry point to run the engine is core.RunCore(), which is redundant — the object is already named core, making the call read as "core run core". This was flagged in ES-Factoria src/main.cpp:
core.RunCore(); // TODO: rename to Run or Start or something like that
Proposed Solution
Rename Engine::Core::RunCore() to Run() or Start() — a short, idiomatic name that reads naturally: core.Run().
Alternative Solutions
- Keep RunCore() and add a Run() alias — avoids breaking changes but keeps the redundancy.
- Rename to Execute() or Loop() — valid but less conventional than Run/Start.
Use Cases
- Use case 1: Any user bootstrapping an EngineSquared project writes core.Run() instead of the redundant core.RunCore().
- Use case 2: Documentation and tutorials read more naturally.
Impact
- No performance implications.
- Breaking API change: all existing call sites must be updated from RunCore() to the new name.
- Should be done before a stable public API is established.
Implementation Details (optional)
- Rename RunCore() to Run() (preferred) in Engine::Core.
- Search and replace all usages across the engine, plugins, examples, and ES-Factoria.
Additional Context
Spotted via a // TODO audit of the ES-Factoria demo project.
Related Issues
Reactions are currently unavailable
Problem Statement
The main entry point to run the engine is core.RunCore(), which is redundant — the object is already named core, making the call read as "core run core". This was flagged in ES-Factoria src/main.cpp:
core.RunCore(); // TODO: rename to Run or Start or something like thatProposed Solution
Rename Engine::Core::RunCore() to Run() or Start() — a short, idiomatic name that reads naturally: core.Run().
Alternative Solutions
Use Cases
Impact
Implementation Details (optional)
Additional Context
Spotted via a // TODO audit of the ES-Factoria demo project.
Related Issues