FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

[FEATURE] Rename `Core::RunCore()` to a cleaner name (`Run` or `Start`) · Issue #489 · EngineSquared/EngineSquared · GitHub

[FEATURE] Rename Core::RunCore() to a cleaner name (Run or Start) #489

Description

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)

  1. Rename RunCore() to Run() (preferred) in Engine::Core.
  2. 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

  • N/A

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or requestgood-first-issueGood issue for first-time contributorsquality of lifeImprovements that enhance user or developer experience without adding new core features

    Type

    No type

    Projects

    Status
    Done

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions


    Back | FazBrowse Home | New Git URL