SuperMartijn642's Config Lib

SuperMartijn642's Config Lib pozwala zdefiniować konfigurację raz, a następnie automatycznie zarządza przeładowywaniem wartości między wczytywaniem światów, synchronizacją wartości z klientami oraz generowaniem wartości tylko dla klienta lub serwera.

Tworzenie konfiguracji:

Konfigurację tworzy się za pomocą ModConfigBuilder.

Wystarczy utworzyć nową instancję za pomocą #ModConfigBuilder().

   ModConfigBuilder builder = new ModConfigBuilder();

Wartość można dodać do konfiguracji za pomocą ModConfigBuilder#define, która przyjmuje nazwę i wartość domyślną.

Dla wartości całkowitych i zmiennoprzecinkowych wymagane są również wartości minimalna i maksymalna.

Testowy blok kodu;

ModConfigBuilder#define zwraca Supplier, który należy przechować, aby później pobrać wartość z konfiguracji.

   Supplier<Boolean> booleanValue = builder.define( "booleanValue", true );

   Supplier<Integer> integerValue = builder.define( "integerValue", 5, 0, 10 );

   Supplier<Double> doubleValue = builder.define( "doubleValue", 0.5, 0, 1);

   Supplier<ExampleEnum> enumValue = builder.define( "enumValue", ExampleEnum.VALUE_1 );

Komentarz do wartości można dodać, wywołując ModConfigBuilder#comment(String) przed zdefiniowaniem wartości.

   Supplier<Boolean> valueWithComment = builder.comment( "to jest komentarz dla 'valueWithComment'" ).define( "valueWithComment ", true );

Domyślnie wartości są przeładowywane przy wczytywaniu świata.

Można to zmienić tak, aby wartość była przeładowywana tylko przy uruchomieniu Minecrafta, wywołując ModConfigBuilder#gameRestart() przed zdefiniowaniem wartości.

   Supplier<Boolean> notReloadedValue = builder.comment( "ta wartość nie będzie przeładowywana" ).define( "notReloadedValue", true );

Wartości w konfiguracjach COMMON lub SERVER są domyślnie synchronizowane z klientami. Aby temu zapobiec, użyj ModConfigBuilder#dontSync().

   Supplier<Boolean> notSynchronizedValue = builder.comment( "ta wartość nie będzie synchronizowana" ).define( "notSynchronizedValue", true );

Wartości można również umieszczać w kategoriach.

ModConfigBuilder#push(String) dodaje kategorię, a ModConfigBuilder#pop() ją usuwa.

   builder.push( "special" );

   Supplier<Boolean> specialValue = builder.comment( "ta wartość znajduje się w kategorii 'special'" ).define( "specialValue", true );

   builder.pop();

Komentarz do aktywnej kategorii można dodać za pomocą ModConfigBuilder#categoryComment(String).

   builder.push( "client" ).categoryComment( "to jest komentarz dla kategorii 'client'" );

Po zdefiniowaniu wszystkich wartości należy wywołać ModConfigBuilder#build(), aby sfinalizować konfigurację.

   builder.build();

Teraz wartości w twojej konfiguracji będą automatycznie przeładowywane i synchronizowane, a wartości można pobierać za pomocą przechowywanych instancji Supplier.

Działa to dla wszystkich dostępnych wersji, w tym Minecraft 1.12, 1.14, 1.15 i 1.16.

Przykładowy mod:

Konkretny przykład użycia Config Lib znajdziesz w przykładowym modzie.