System¶

Description¶

System is a virtual platform-abstraction layer. It provides screen dimensions, file-system paths, virtual keyboard control, fullscreen management, persistent key-value storage, and optional SDK integrations (AdMob, CrazyGames). You access it via System::instance() in C++ or the global System table in Lua.

Each target platform provides its own concrete System subclass; the engine injects the correct implementation at startup.

#include "Doriax.h"
using namespace doriax;

int screenW = System::instance().getScreenWidth();
int screenH = System::instance().getScreenHeight();
Log::print("Screen: %dx%d", screenW, screenH);

local w = System.getScreenWidth()
local h = System.getScreenHeight()
Log.print("Screen: " .. w .. "x" .. h)

Methods¶

Method details¶

getScreenWidth / getScreenHeight¶

• virtual int getScreenWidth() = 0
• virtual int getScreenHeight() = 0

Physical screen (window) dimensions in pixels. These may differ from Engine::canvasWidth / canvasHeight when a scaling mode other than NATIVE is active.

int w = System::instance().getScreenWidth();
int h = System::instance().getScreenHeight();

local w = System.getScreenWidth()
local h = System.getScreenHeight()

getSampleCount¶

• virtual int getSampleCount()

Returns the MSAA sample count configured for the current graphics backend (e.g. 1, 2, or 4). Useful when creating render targets that must match the main framebuffer.

showVirtualKeyboard¶

• virtual void showVirtualKeyboard(std::wstring text = L"")

Displays the platform's on-screen keyboard with text as the initial input buffer. Has no effect on desktop platforms. On iOS/Android, raises the software keyboard and fires Engine::onCharInput for each key typed.

System::instance().showVirtualKeyboard(L"Enter name");

System.showVirtualKeyboard("Enter name")

hideVirtualKeyboard¶

• virtual void hideVirtualKeyboard()

Dismisses the on-screen keyboard.

isFullscreen / requestFullscreen / exitFullscreen¶

• virtual bool isFullscreen()
• virtual void requestFullscreen()
• virtual void exitFullscreen()

Query and control fullscreen mode. On desktop platforms, requestFullscreen() typically toggles borderless fullscreen; on web, it requests the Fullscreen API. Has no effect on mobile (always fullscreen).

if (!System::instance().isFullscreen()) {
    System::instance().requestFullscreen();
}

if not System.isFullscreen() then
    System.requestFullscreen()
end

getDirSeparator¶

• virtual char getDirSeparator()

Returns the platform path directory separator: '/' on Unix/macOS/iOS/Android/Web, '\\' on Windows.

getAssetPath¶

• virtual std::string getAssetPath()

Returns the root path for read-only assets bundled with the project. Prepend this to asset file names when opening files directly from C++. In Lua and the high-level C++ loaders (setTexture, etc.), paths are automatically resolved relative to the asset root.

std::string path = System::instance().getAssetPath() + "textures/sprite.png";

getUserDataPath¶

• virtual std::string getUserDataPath()

Returns a writable per-user data directory (Documents on iOS, internal storage on Android, %AppData% on Windows, ~/.local/share on Linux). Use for save files and configuration.

std::string savePath = System::instance().getUserDataPath() + "save.dat";

getLuaPath¶

• virtual std::string getLuaPath()

Returns the base path prepended when Lua require() looks for script modules.

getShaderPath¶

• virtual std::string getShaderPath()

Returns the path where compiled shader binaries are expected. Relevant for custom shader loading.

Persistent key–value storage¶

The system exposes a simple cross-platform persistent store backed by NSUserDefaults (iOS/macOS), SharedPreferences (Android), localStorage (Web), and a JSON file (desktop/Linux/Windows).

Getters return the stored value or defaultValue if the key does not exist:

Setters write or update a value:

removeKey deletes a stored entry:

• virtual void removeKey(const char* key)

System& sys = System::instance();

// Save high score
sys.setIntegerForKey("highScore", score);

// Load with default 0
int best = sys.getIntegerForKey("highScore", 0);

System.setIntegerForKey("highScore", score)
local best = System.getIntegerForKey("highScore", 0)

AdMob integration¶

The following methods are available on Android and iOS when the Google AdMob SDK is linked. They are no-ops on other platforms.

AdMobRating¶

• General — Suitable for all audiences.
• ParentalGuidance — Parental guidance suggested.
• Teen — Suitable for teens.
• MatureAudience — Mature content.

CrazyGames integration¶

Methods for the CrazyGames web SDK. Only active on HTML5 builds.