Skip to content
This repository has been archived by the owner on Sep 21, 2022. It is now read-only.

Initialization and process

Ahmed Castro edited this page Sep 28, 2018 · 8 revisions

init

init(environment:Int, game_id:Int, api_key:String):Void

SDK documentation: modioInit

API documentation: n/a

Initializes mod.io SDK on your project to access API functionality. This will setup a .modio/ directory as mod.io working directory in your project's path.

Name Type Description
environment u32 Server Environment.
game_id u32 Your game unique identifier.
api_key const std::string& Your game unique API key, grab this from the mod.io website.

process

process():Void

SDK documentation: modioProcess

API documentation: n/a

This function handles transfers and callbacks in an non-blocking way. We recommend calling it regularly when performance is not critical, for example in menus or modding tools. Be mindful this function may impact the frame rate and online latency, we recommend not calling it in-game or better yet you could let your players decide.

Clone this wiki locally