Configuration class¶

Using the Configuration class, you can retrieve (get) or change (set) configuration values during app runtime. For example, when retrieving app server information, use the getServerId() method, and when changing it, use the setServerId() method.

As an example of using the Configuration class, you can change the user's zone settings during app execution with the Configuration class.

using hive;  

Configuration.setZone(ZoneType.REAL);

#include <HIVE_SDK_Plugin/HIVE_CPP.h>    
using namespace std;    
using namespace hive;      

Configuration::setZone(ZoneType::REAL);

import com.hive.Configuration    

Configuration.zone = Configuration.ZoneType.REAL

import com.hive.Configuration;    

Configuration.INSTANCE.setZone(Configuration.ZoneType.REAL);

import HIVEService    

ConfigurationInterface.setZone(.real)

#import <HIVEService/HIVEService-Swift.h>    

[HIVEConfiguration setZone: HIVEZoneTypeReal];

Usage scenarios of the configuration class¶

If you need to change the SDK settings while the app is running, here are the cases.

Before SDK initialization¶

Before initializing the SDK, reflect the game server or game language in the settings.

After SDK initialization and before the server maintenance popup¶

This is the case where the user selects a game server before displaying the server maintenance popup after initializing the SDK. After initializing the SDK, the game server selection UI is exposed, and the selected game server by the user is reflected in the settings. After executing this process, the server maintenance popup is displayed.

Example: Game Server Selection UI

After entering the game¶

If a user changes the game language or game server in the game settings after entering the game, they can configure the UI for changing the game server or game language in the game settings or other menus while playing the game. If the user changes the server or language using that UI, this information must also be reflected in the settings.

Example: Game Language Selection UI

Other situations¶

Changes the previously set values due to various situations such as changes in game information depending on game planning and other circumstances.

Example of using the Configuration class¶

Here is an additional guide on using the Configuration class.

Theme settings¶

You can expose the dark theme using Configuration.setHiveTheme.

using hive;

Configuration.setHiveTheme(HiveThemeType.hiveLight);
Configuration.setHiveTheme(HiveThemeType.hiveDark);

#include <HIVE_SDK_Plugin/HIVE_CPP.h>
using namespace std;
using namespace hive;

Configuration::setHiveTheme(HiveThemeType::hiveLight);
Configuration::setHiveTheme(HiveThemeType::hiveDark);

import com.hive.Configuration

Configuration.hiveTheme = HiveTheme.hiveLight
Configuration.hiveTheme = HiveTheme.hiveDark

import com.hive.Configuration;

Configuration.INSTANCE.setHiveTheme(Configuration.HiveTheme.HiveLight);
Configuration.INSTANCE.setHiveTheme(Configuration.HiveTheme.HiveDark);

#import <HIVEService/HIVEService-Swift.h>

[HIVEConfiguration setHiveTheme: HIVEThemeTypeHiveLight];
[HIVEConfiguration setHiveTheme: HIVEThemeTypeHiveDark];

import HIVEService

ConfigurationInterface.setHiveTheme(.hiveLight)
ConfigurationInterface.setHiveTheme(.hiveDark)

Configuration class and hive_config.xml file¶

Changing the settings (runtime settings) with the methods in the Configuration class overrides the values set in hive_config.xml (build time settings). In other words, the values set by the Configuration class take higher priority. However, the values set by the Configuration class are prioritized within the SDK, and the existing values in the hive_config.xml file are not changed.

For example, even if you set zone to sandbox in the above zone configuration in hive_config.xml, after changing this value to real with the Configuration class and initializing the SDK, the SDK will operate based on real. However, the zone in hive_config.xml will still remain as sandbox.

Configuration class for retrievable settings¶

The configuration class method allows you to retrieve values (get) for the settings that are only available as listed below.

Changeable settings with the Configuration class¶

The items that can be changed (set) with the Configuration class methods are as follows. Mandatory items must be entered, while optional items can be entered as needed. If optional items are not entered, they will operate with the default values of the SDK. Even if it is a mandatory item, if it has already been entered in hive_config.xml and does not need to be changed at runtime, there is no need to change it with the Configuration class.

Unsupported items¶

The following are the methods of the Configuration class that are no longer supported.