Skip to main content

Dora SSR API Reference

Welcome to the Dora SSR API Reference! This documentation provides detailed information about the APIs and functionality available within the Dora SSR game engine. Use the guide below to navigate through different topics and explore the capabilities of the engine.

Basic Functionality​

This category provides general functions and services of the engine.

Audio Management​

This category provides features for managing and playing game music and sound effects.

Assets Management​

This category offers the ability to manage various game assets, including files and data.

Input Management​

This category provides part of the game's input processing capabilities. The rest input handling, such as tap/touch events, can be registered and handled in node events.

Data Structure​

This category provides a range of data structures and types.

Scene Management​

This category is for managing game scene trees.

Tree Management​

This category provides the management of the root nodes and cameras of the game scene.

Tree Nodes​

This category provides the management of game scene nodes and node events.

Event Management​

This category is for managing game events.

Global Events​

This subcategory handles global-level events, such as application and operating system events.

Node Events​

This subcategory handles scene node-level events.

Graphics Rendering​

This category is about functions for rendering game graphics.

Render Nodes​

This category provides some basic and general game graphics rendering nodes..

Render Objects​

This category provides some rendering controlling objects.

Animation Models​

This subcategory provides functionality for creating and manipulating 2D animation models.

Node Actions​

This category is for creating and managing actions that can be performed on scene nodes.

Physics Simulation​

This category provides functionality for creating and managing physical object simulations.

3D Rendering and Physics​

This category provides 3D scene, rendering, lighting, and physics APIs.

ECS Framework​

This category provides the functionality of the Entity Component System (ECS).

Platformer Game Framework​

This category provides a basic development framework for 2D platform games.

Coroutine Management​

This category provides convenient creation and management of coroutines.

Machine Learning Algorithms​

This category provides some basic machine learning algorithms, including the C4.5 decision tree algorithm and the Q-learning reinforcement learning algorithm.

Dialogue System​

This category provides the functionality for loading and executing complex game dialogues.

Networking Service​

This category provides the functionality for networking service.

Misc Functions​

This category provides other miscellaneous features provided by the engine.