gamecircle.Init()

Type Function
Library gamecircle.*
Return value None
Revision Release 2024.3703
Keywords gamecircle, initialization, init

Overview

This function needs to be called soon after loading the GameCircle plugin with "require". This is what tells GameCircle which features are going to be used, both for internal purposes as well as showing the correct set of icons on the GameCircle overlay. This is so the user can know which features are active.

Syntax

gamecircle.Init(achievements, leaderboards, whispersync)
achievements (required)

Boolean. Set to true if you app will use GameCircle achievements. Otherwise, set to false.

leaderboards (required)

Boolean. Set to true if you app will use GameCircle leaderboards. Otherwise, set to false.

whispersync (required)

Boolean. Set to true if you app will use GameCircle whispersync. Otherwise, set to false.

Examples

This example code is telling the GameCircle plugin that we intend to use the achievement and whispersync features, but not leaderboards.

local gamecircle = require("plugin.gamecircle")  
gamecircle.Init(true, false, true)