Localization

localization module for Sigcraft

각종 메시지와 GUI 메시지들을 담당하는 모듈입니다.

Usage

Yaml Format

기본 파일 이름은 localization.yml 입니다.

locale: ko-KR # 필수
message:
  TEST_MESSAGE: "테스트 메시지" # 키 값은 대문자여야 합니다.
gui:
  TEST:
    title: "Test gui"
    row: 3

    BUTTON:
      material: DIAMOND
      slot: 10
      name: "테스트 버튼"
      desc:
        - "테스트 설명"
        - "추가 설명"

초기화 (로드)

import com.signition.siglib.localeBundle.api.McLocalizationController;

public class Client {
  public static void main(String[] args) {
    McLocalizationController.loadDefault(SimplePlugin.getInstance());
  }
}

플러그인 활성화 시 해당 코드 추가가 필요합니다.

기본 파일의 이름은 localization.yml 이므로 해당 파일을 로드 합니다.

기본 사용법

public class Client {
  public static void main(String[] args) {
    McLocaleBundle localeBundle = McLocalizationController
        .getDefaultBundle(SimplePlugin.getInstance());

    String message = localeBundle.getMessage("TEST_MESSAGE");
    LocaleGuiButton guiButton = localeBundle.getGui("TEST").get("BUTTON");
    guiButton.getName();
    guiButton.getDesc();
  }
}

LocaleAdapter

public interface LocaleAdapterClient extends LocaleAdapter {
  @Override
  default McLocaleBundle getLocalization() {
    return McLocalizationController.getDefaultBundle(SimplePlugin.getInstance());
  }
}

public class Client implements LocaleAdapterClient {
  public void work() {
    String message = getMessage("TEST_MESSAGE");
    
    LocaleGuiButton guiButton = getGui("TEST").get("BUTTON");
  }
}

LocaleAdapterClient는 각 플러그인 마다 따로 만들어지는 것을 전제로 하고 있습니다.

특정 파일 로드

기본 값인 localization.yml 이 아닌 다른 파일에서 Localization을 로드 하고자 하는 경우 다음의 방법을 사용하세요.

McLocalizationController.load(SimplePlugin.getInstance(), "rpg_localization.yml");

리로드의 경우에도 위와 같은 코드를 사용합니다.

로드 된 LocaleBundle에 대한 접근은 아래와 같이 할 수 있습니다.

McLocalizationController
    .get(SimplePlugin.getInstance())
    .getLocaleBundle("rpg_localization.yml");

Caution

• LocaleAdapterClient를 만들 때, JavaPlugin 인수에 다른 플러그인의 인스턴스가 들어가지 않도록 주의하세요. 정상적으로 파일을 인식하지 못할 수 있습니다.

• LocaleGuiComponent를 상속하는 데이터 및 메시지, GUI의 키 값은 대문자(SCREAMING_SNAKE_CASE) 여야만 합니다.