Game > Gamebase > Android SDK 사용 가이드 > ETC
Additional Features
Gamebase에서 지원하는 부가 기능을 설명합니다.
Display Language
- Gamebase에서 표시하는 언어를 기기에 설정된 언어가 아닌 다른 언어로 변경할 수 있습니다.
- Gamebase는 클라이언트에 포함되어 있는 메시지를 표시하거나 서버에서 받은 메시지를 표시합니다.
- DisplayLanguage를 설정하면 사용자가 설정한 언어코드(ISO-639)에 적합한 언어로 메시지를 표시합니다.
- 원하는 언어셋을 추가할 수 있습니다. 추가할 수 있는 언어코드는 다음과 같습니다.
[참고]
Gamebase의 클라이언트 메시지는 영어(en), 한글(ko)만 포함합니다.
Gamebase에서 지원하는 언어코드의 종류
| Code | Name |
|---|---|
| de | German |
| en | English |
| es | Spanish |
| fi | Finish |
| fr | French |
| id | Indonesian |
| it | Italian |
| ja | Japanese |
| ko | Korean |
| pt | Portuguese |
| ru | Russian |
| th | Thai |
| vi | Vietnamese |
| ms | Malay |
| zh-CN | Chinese-Simplified |
| zh-TW | Chinese-Traditional |
해당 언어코드는 DisplayLanguage 클래스에 정의되어 있습니다.
[주의]Gamebase에서 지원하는 언어코드는 대소문자를 구분합니다. 'EN'이나 'zh-cn'과 같이 설정하면 문제가 발생할 수 있습니다.
package com.toast.android.gamebase.base.ui;
public class DisplayLanguage {
public static class Code {
public static final String German = "de";
public static final String English = "en";
public static final String Spanish = "es";
public static final String Finish = "fi";
public static final String French = "fr";
public static final String Indonesian = "id";
public static final String Italian = "it";
public static final String Japanese = "ja";
public static final String Korean = "ko";
public static final String Portuguese = "pt";
public static final String Russian = "ru";
public static final String Thai = "th";
public static final String Vietnamese = "vi";
public static final String Malay = "ms";
public static final String Chinese_Simplified = "zh-CN";
}
...
}
Gamebase 초기화 시 Display Language 설정
Gamebase 초기화 시 Display Language를 설정할 수 있습니다.
API
+ (GamebaseConfiguration)GamebaseConfiguration.Builder.setDisplayLanguageCode(String displayLanguageCode);
Example
public class MainActivity extends AppCompatActivity {
...
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
String appId = "T0aStC1d";
String appVersion = "1.0.0";
GamebaseConfiguration configuration = new GamebaseConfiguration.Builder(appId, appVersion)
.enableLaunchingStatusPopup(true)
.setDisplayLanguageCode("en")
.build();
Gamebase.initialize(activity, configuration, new GamebaseDataCallback<LaunchingInfo>() {
@Override
public void onCallback(final LaunchingInfo data, GamebaseException exception) {
...
}
});
...
}
...
}
Set Display Language
Gamebase 초기화 시 입력된 Display Language를 변경할 수 있습니다.
API
+ (void)Gamebase.setDisplayLanguageCode(String displayLanguageCode);
Example
public void setDisplayLanguageCodeToEnglishInRuntime() {
Gamebase.setDisplayLanguageCode(DisplayLanguage.Code.English);
}
Get Display Language
현재 적용된 Display Language를 조회할 수 있습니다.
API
+ (String)Gamebase.getDisplayLanguageCode();
Example
public void getDisplayLanguageCodeInRuntime() {
String currentDisplayLanguageCode = Gamebase.getDisplayLanguageCode();
}
신규 언어셋 추가
Gamebase에서 제공하는 기본 언어(ko, en, ja) 외 다른 언어를 사용하려면 gamebase-sdk-base.aar > res > raw에 있는 localizedstring.json 파일에 값을 추가해야 합니다.
localizedstring.json에 정의되어 있는 형식은 아래와 같습니다.
{
"en": {
"common_ok_button": "OK",
"common_cancel_button": "Cancel",
...
"launching_service_closed_title": "Service Closed"
},
"ko": {
"common_ok_button": "확인",
"common_cancel_button": "취소",
...
"launching_service_closed_title": "서비스 종료"
},
"ja": {
"common_ok_button": "確認",
"common_cancel_button": "キャンセル",
...
"launching_service_closed_title": "サービス終了"
},
}
다른 언어셋을 추가해야 할 경우에는 localizedstring.json 파일에 "${언어 코드}":{"key":"value"} 형태로 값을 추가하면 됩니다.
{
"en": {
"common_ok_button": "OK",
"common_cancel_button": "Cancel",
...
"launching_service_closed_title": "Service Closed"
},
"ko": {
"common_ok_button": "확인",
"common_cancel_button": "취소",
...
"launching_service_closed_title": "서비스 종료"
},
"ja": {
"common_ok_button": "確認",
"common_cancel_button": "キャンセル",
...
"launching_service_closed_title": "サービス終了"
},
"${언어코드}": {
"common_ok_button": "...",
...
}
}
위 JSON 형식에서 "${언어코드}":{ } 내부에 key가 누락될 경우에는 기기에 설정된 언어 또는 en이 자동으로 입력됩니다.
Display Language 우선순위
초기화 및 SetDisplayLanguageCode API를 통해 Display Language를 설정할 경우, 최종 적용되는 Display Language는 입력한 값과 다르게 적용될 수 있습니다.
- 입력된 languageCode가 localizedstring.json 파일에 정의되어 있는지 확인합니다.
- Gamebase 초기화 시, 기기에 설정된 언어코드가 localizedstring.json 파일에 정의되어 있는지 확인합니다.(이 값은 초기화 이후, 기기에 설정된 언어를 변경하더라도 유지됩니다.)
- Display Language의 기본값인
en이 자동으로 설정됩니다.
Server Push
- Gamebase 서버에서 클라이언트 기기로 보내는 Server Push Message를 처리할 수 있습니다.
- Gamebase 클라이언트에서 ServerPushEvent Listener를 추가하면 해당 메시지를 사용자가 받아서 처리할 수 있으며, 추가된 ServerPushEvent Listener를 삭제할 수 있습니다.
Server Push Type
현재 Gamebase에서 지원하는 Server Push Type은 다음과 같습니다.
- ServerPushEventMessage.Type.APP_KICKOUT (= "appKickout")
- TOAST Gamebase 콘솔의
Operation > Kickout에서 킥아웃 ServerPush 메시지를 등록하면 Gamebase와 연결된 모든 클라이언트에서APP_KICKOUT메시지를 받게 됩니다.
- TOAST Gamebase 콘솔의
- ServerPushEventMessage.Type.TRANSFER_KICKOUT (= "transferKickout")
- TransferKey 를 통해 게스트 계정 이전이 성공한 경우, TransferKey를 발급받았던 단말기로
TRANSFER_KICKOUT메세지가 전송됩니다.
- TransferKey 를 통해 게스트 계정 이전이 성공한 경우, TransferKey를 발급받았던 단말기로
Add ServerPushEvent
Gamebase Client에 ServerPushEvent를 등록하여 Gamebase Console 및 Gamebase 서버에서 발급된 Push 이벤트를 처리할 수 있습니다.
API
+ (void)Gamebase.addServerPushEvent(ServerPushEvent serverPushEvent);
Example
public class MyServerPushEventManager {
private ServerPushEvent mServerPushEvent = new ServerPushEvent() {
@Override
public void onReceive(ServerPushEventMessage message) {
if (message.type.equals(ServerPushEventMessage.Type.APP_KICKOUT)) {
// Logout
// Go to Main
} else if (message.type.equals(ServerPushEventMessage.Type.TRANSFER_KICKOUT)) {
// Logout
// Go to Main
} else {
...
}
}
};
private void addServerPushEvent() {
Gamebase.addServerPushEvent(mServerPushEvent);
}
...
}
Remove ServerPushEvent
Gamebase에 등록된 ServerPushEvent를 삭제할 수 있습니다.
API
+ (void)Gamebase.removeServerPusEvent(ServerPushEvent serverPushEvent);
+ (void)Gamebase.removeAllServerPusEvent();
Example
public class MyServerPushEventManager {
...
private void removeServerPushEvent() {
Gamebase.removeServerPusEvent(mServerPushEvent);
}
private void removeAllServerPushEvent() {
Gamebase.removeAllServerPushEvent();
}
...
}
Observer
- Gamebase Observer로 Gamebase의 각종 상태 변동 이벤트를 전달받아 처리할 수 있습니다.
- 상태 변동 이벤트 : 네트워크 타입 변동, Launching 상태 변동(점검 등에 의한 상태 변동), Heartbeat 정보 변동(사용자 이용 정지 등에 의한 Heartbeat 정보 변동) 등
Observer Type
현재 Gamebase에서 지원하는 Observer Type은 다음과 같습니다.
- Network 타입 변동
- 네트워크 변동 사항 정보를 받을 수 있습니다. 예를 들어 ObserverMessage.data.get("code") 의 값으로 Network Type을 알 수 있습니다.
- Type: ObserverMessage.Type.NETWORK (= "network")
- Code: NetworkManager에 선언된 상수를 참고합니다.
- NetworkManager.TYPE_NOT: -1
- NetworkManager.TYPE_MOBILE: 0
- NetworkManager.TYPE_WIFI: 1
- NetworkManager.TYPE_ANY: 2
- Launching 상태 변동
- 주기적으로 애플리케이션 상태를 확인하는 Launching Status response에 변동이 있을 때 발생합니다. 예를 들어 점검, 업데이트 권장 등에 의한 이벤트가 있습니다.
- Type: ObserverMessage.Type.LAUNCHING (= "launching")
- Code: LaunchingStatus에 선언된 상수를 참고합니다.
- LaunchingStatus.IN_SERVICE: 200
- LaunchingStatus.RECOMMEND_UPDATE: 201
- LaunchingStatus.IN_SERVICE_BY_QA_WHITE_LIST: 202
- LaunchingStatus.REQUIRE_UPDATE: 300
- LaunchingStatus.BLOCKED_USER: 301
- LaunchingStatus.TERMINATED_SERVICE: 302
- LaunchingStatus.INSPECTING_SERVICE: 303
- LaunchingStatus.INSPECTING_ALL_SERVICES: 304
- LaunchingStatus.INTERNAL_SERVER_ERROR: 500
- Heartbeat 정보 변동
- 주기적으로 Gamebase 서버와 연결을 유지하는 Heartbeat response에 변동이 있을 때 발생합니다. 예를 들어 사용자 이용 정지에 의한 이벤트가 있습니다.
- Type: ObserverMessage.Type.HEARTBEAT (= "heartbeat")
- Code: GamebaseError에 선언된 상수를 참조합니다.
- GamebaseError.INVALID_MEMBER: 6
- GamebaseError.BANNED_MEMBER: 7
Add Observer
Gamebase Client에 Observer를 등록하여 각종 상태 변동 이벤트를 처리할 수 있습니다.
API
+ (void)Gamebase.addObserver(Observer observer);
Example
public class MyObserverManager {
private Observer mGamebaseObserver = new Observer() {
@Override
public void onUpdate(ObserverMessage message) {
String typeOfMessage = message.type;
Map<String, Object> dataMap = message.data;
if (typeOfMessage.equalsIgnoreCase(ObserverMessage.Type.LAUNCHING)) {
int code = Integer.parseInt(dataMap.get("code"));
String messageString = (String) dataMap.get("message");
Log.d(TAG, "Update launching status to " + code + ", " + messageString);
// You can check the changed launching status in here.
switch (code) {
case LaunchingStatus.IN_SERVICE:
...
break;
case LaunchingStatus.RECOMMEND_UPDATE:
...
break;
case ...
break;
...
}
} else if (typeOfMessage.equalsIgnoreCase(ObserverMessage.Type.HEARTBEAT)) {
int code = Integer.parseInt(dataMap.get("code"));
Log.d(TAG, "Heartbeat changing : " + dataMap);
switch (code) {
case GamebaseError.INVALID_MEMBER:
// You can check the invalid user session in here.
...
break;
case GamebaseError.BANNED_MEMBER:
// You can check the banned user session in here.
...
break;
}
} else if (typeOfMessage.equalsIgnoreCase(ObserverMessage.Type.NETWORK)) {
int code = Integer.parseInt(dataMap.get("code"));
Log.d(TAG, "Network changing : " + dataMap);
// You can check the changed network status in here.
if (code == NetworkManager.TYPE_NOT) {
...
} else {
...
}
} else {
...
}
}
};
private void addObserver() {
Gamebase.addObserver(mGamebaseObserver);
}
...
}
Remove Observer
Gamebase에 등록된 Observer를 삭제할 수 있습니다.
API
+ (void)Gamebase.removeObserver(Observer observer);
+ (void)Gamebase.removeAllObserver();
Example
public class MyObserverManager {
...
private void removeObserver() {
Gamebase.removeObserver(mGamebaseObserver);
}
private void removeAllObserver() {
Gamebase.removeAllObserver();
}
...
}