Compare commits
14 Commits
dev/module
...
v1.11
| Author | SHA1 | Date | |
|---|---|---|---|
|
0b74f104f2
|
|||
|
6e54a16067
|
|||
|
d34e418dcc
|
|||
|
bcca590741
|
|||
|
2fc1bf36c1
|
|||
|
eb5396b891
|
|||
|
e12d005a25
|
|||
|
6e50fc278e
|
|||
|
c8866af418
|
|||
|
359dbba09a
|
|||
|
e4b1b40104
|
|||
|
73f044ab8b
|
|||
|
32b868df22
|
|||
|
3a66dffa10
|
@@ -1,6 +1,6 @@
|
||||
# GHAST TOOLS
|
||||
|
||||

|
||||

|
||||

|
||||
|
||||
Набор вспомогательных инструментов для Bukkit API.
|
||||
@@ -654,7 +654,7 @@ repositories {
|
||||
```
|
||||
|
||||
```groovy
|
||||
implementation group: 'ghast', name: 'ghast-tools', version: '1.11-SNAPSHOT'
|
||||
implementation group: 'ghast', name: 'ghast-tools', version: '1.11'
|
||||
```
|
||||
|
||||
### Maven
|
||||
@@ -673,7 +673,7 @@ implementation group: 'ghast', name: 'ghast-tools', version: '1.11-SNAPSHOT'
|
||||
<dependency>
|
||||
<groupId>ghast</groupId>
|
||||
<artifactId>ghast-tools</artifactId>
|
||||
<version>1.11-SNAPSHOT</version>
|
||||
<version>1.11</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
98
build.gradle
98
build.gradle
@@ -1,35 +1,79 @@
|
||||
subprojects {
|
||||
apply plugin: 'java'
|
||||
apply plugin: LibsPlugin
|
||||
apply plugin: LogicPlugin
|
||||
plugins {
|
||||
id 'java'
|
||||
}
|
||||
|
||||
def publishScript = rootDir.toPath().resolve('publish.gradle').toFile()
|
||||
if (publishScript.exists()) {
|
||||
apply from: publishScript
|
||||
}
|
||||
def publishScript = file(rootProject.getProjectDir().getPath() + '/publish.gradle')
|
||||
if (publishScript.exists()) {
|
||||
apply from: publishScript.path
|
||||
}
|
||||
|
||||
project.group = projectGroup
|
||||
if (project.hasProperty('moduleVersion')) {
|
||||
project.version = project.property('moduleVersion')
|
||||
}
|
||||
if (project.hasProperty('moduleName')) {
|
||||
jar.archiveBaseName.set(project.property('moduleName') as String)
|
||||
}
|
||||
project.group = projectGroup
|
||||
project.version = projectVersion
|
||||
|
||||
repositories {
|
||||
mavenLocal()
|
||||
mavenCentral()
|
||||
}
|
||||
repositories {
|
||||
mavenLocal()
|
||||
mavenCentral()
|
||||
maven { url 'https://hub.spigotmc.org/nexus/content/groups/public' }
|
||||
maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly libs.lombok
|
||||
annotationProcessor libs.lombok
|
||||
ext {
|
||||
junitVersion = '5.5.2'
|
||||
|
||||
testImplementation libs.test.junit5
|
||||
testImplementation libs.test.mock
|
||||
}
|
||||
libs = [
|
||||
bukkit: [lib: 'org.bukkit:bukkit:1.12.2-R0.1-SNAPSHOT', exclude: [
|
||||
'com.google.code.gson:gson',
|
||||
'com.googlecode.json-simple:json-simple',
|
||||
'commons-lang:commons-lang',
|
||||
'org.yaml:snakeyaml'
|
||||
]],
|
||||
commons_text: 'org.apache.commons:commons-text:1.9',
|
||||
lombok: 'org.projectlombok:lombok:1.18.12',
|
||||
reflection_object: 'ru.dmitriymx:reflection-object:1.2',
|
||||
test: [
|
||||
junit5: [
|
||||
"org.junit.jupiter:junit-jupiter-api:$junitVersion",
|
||||
"org.junit.jupiter:junit-jupiter-engine:$junitVersion"
|
||||
],
|
||||
mock: ['org.mockito:mockito-core:1.10.19'],
|
||||
h2db: 'com.h2database:h2:1.4.200'
|
||||
]
|
||||
|
||||
test {
|
||||
useJUnitPlatform()
|
||||
]
|
||||
}
|
||||
|
||||
def compileOnly2(library) {
|
||||
dependencies.compileOnly library.lib, {
|
||||
library.exclude.each { String excludeLibStr ->
|
||||
String[] excludeLib = excludeLibStr.split(':')
|
||||
exclude group: excludeLib[0], module: excludeLib[1]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
def testImplementation2(library) {
|
||||
dependencies.testImplementation library.lib, {
|
||||
library.exclude.each { String excludeLibStr ->
|
||||
String[] excludeLib = excludeLibStr.split(':')
|
||||
exclude group: excludeLib[0], module: excludeLib[1]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly libs.lombok
|
||||
annotationProcessor libs.lombok
|
||||
|
||||
compileOnly2 libs.bukkit
|
||||
implementation libs.commons_text
|
||||
implementation libs.reflection_object
|
||||
|
||||
testImplementation libs.test.junit5
|
||||
testImplementation libs.test.mock
|
||||
testImplementation2 libs.bukkit
|
||||
testImplementation libs.test.h2db
|
||||
}
|
||||
|
||||
test {
|
||||
useJUnitPlatform()
|
||||
}
|
||||
@@ -1,71 +0,0 @@
|
||||
import org.gradle.api.Action
|
||||
import org.gradle.api.Plugin
|
||||
import org.gradle.api.Project
|
||||
import org.gradle.api.artifacts.repositories.MavenArtifactRepository
|
||||
|
||||
class LibsPlugin implements Plugin<Project> {
|
||||
|
||||
@Override
|
||||
void apply(Project project) {
|
||||
project.extensions.create('libs', LibsExtention)
|
||||
project.extensions.create('repos', ReposExtention)
|
||||
}
|
||||
}
|
||||
|
||||
class ReposExtention {
|
||||
|
||||
final def mavenSpigotMC = createSimpleMavenRepo('SpigotMC repository', 'https://hub.spigotmc.org/nexus/content/groups/public')
|
||||
final def mavenDmxMcProject = createSimpleMavenRepo('DmitriyMX MC Project repository', 'https://dmx-mc-project.gitlab.io/maven-repository/')
|
||||
|
||||
private static Action<MavenArtifactRepository> createSimpleMavenRepo(String name, String url) {
|
||||
return new Action<MavenArtifactRepository>() {
|
||||
@Override
|
||||
void execute(MavenArtifactRepository mavenArtifactRepository) {
|
||||
mavenArtifactRepository.setName(name)
|
||||
mavenArtifactRepository.setUrl(url)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
class LibsExtention {
|
||||
private def junit_version = '5.5.2'
|
||||
|
||||
final def commons_text = 'org.apache.commons:commons-text:1.9'
|
||||
final def lombok = 'org.projectlombok:lombok:1.18.12'
|
||||
|
||||
final def bukkit = filter([
|
||||
lib : 'org.bukkit:bukkit:1.12.2-R0.1-SNAPSHOT',
|
||||
exclude: [
|
||||
'com.google.code.gson:gson',
|
||||
'com.googlecode.json-simple:json-simple',
|
||||
'commons-lang:commons-lang',
|
||||
'org.yaml:snakeyaml'
|
||||
]])
|
||||
|
||||
final def test = [
|
||||
junit5: [
|
||||
"org.junit.jupiter:junit-jupiter-api:$junit_version",
|
||||
"org.junit.jupiter:junit-jupiter-engine:$junit_version"
|
||||
],
|
||||
mock : ['org.mockito:mockito-core:1.10.19'],
|
||||
h2db : 'com.h2database:h2:1.4.200'
|
||||
]
|
||||
|
||||
private static def filter(library) {
|
||||
Object[] result = new Object[2]
|
||||
result[0] = library.lib
|
||||
result[1] = {
|
||||
library.exclude.each { String excludeLibStr ->
|
||||
String[] excludeLib = excludeLibStr.split(':', 2)
|
||||
if (excludeLib.length == 2) {
|
||||
exclude group: excludeLib[0], module: excludeLib[1]
|
||||
} else {
|
||||
exclude group: excludeLib[0]
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return result
|
||||
}
|
||||
}
|
||||
@@ -1,67 +0,0 @@
|
||||
import org.gradle.api.DefaultTask
|
||||
import org.gradle.api.Plugin
|
||||
import org.gradle.api.Project
|
||||
import org.gradle.api.tasks.TaskAction
|
||||
|
||||
import java.nio.charset.StandardCharsets
|
||||
import java.nio.file.Path
|
||||
|
||||
class LogicPlugin implements Plugin<Project> {
|
||||
|
||||
@Override
|
||||
void apply(Project project) {
|
||||
project.tasks.register('incrementVersion', IncrementVersion)
|
||||
}
|
||||
}
|
||||
|
||||
class IncrementVersion extends DefaultTask {
|
||||
|
||||
@TaskAction
|
||||
def incrementVersion() {
|
||||
String nextVer
|
||||
if (project.hasProperty('nextVersion')) {
|
||||
nextVer = project.property('nextVersion')
|
||||
} else {
|
||||
nextVer = nextVersion()
|
||||
}
|
||||
|
||||
incrementReadmeVersion(nextVer)
|
||||
incrementGradlePropsVersion(nextVer)
|
||||
}
|
||||
|
||||
private void incrementReadmeVersion(String nextVersion) {
|
||||
String nextVersion2 = nextVersion.replaceAll(/-/, '--')
|
||||
|
||||
Reader reader = this.getClass().getResource('README.SRC.MD').toURI().toURL().newReader()
|
||||
File readmeFile = project.file(project.getRootDir().toPath().resolve('README.MD'))
|
||||
|
||||
readmeFile.withWriter { wr ->
|
||||
reader.eachLine { line ->
|
||||
wr << line.replaceAll('@VERSION@', nextVersion)
|
||||
.replaceAll('@VERSION2@', nextVersion2)
|
||||
wr << "\n"
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
private void incrementGradlePropsVersion(String nextVersion) {
|
||||
Path gradlePropertiesPath = project.projectDir.toPath().resolve('gradle.properties');
|
||||
|
||||
Properties gradleProperties = new Properties()
|
||||
gradleProperties.load(gradlePropertiesPath.newReader())
|
||||
gradleProperties.setProperty('moduleVersion', nextVersion)
|
||||
|
||||
gradlePropertiesPath.withWriter(StandardCharsets.UTF_8.name(), { wr ->
|
||||
gradleProperties.each {
|
||||
wr << "${it.key}=${it.value}"
|
||||
wr << "\n"
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
private String nextVersion() {
|
||||
def matcher = project.property('moduleVersion') =~ /^(.*\d+\.)(\d+)(-.+)?$/
|
||||
matcher.find()
|
||||
return matcher.group(1) + (matcher.group(2).toInteger() + 1) + (matcher.group(3) == null ? '' : matcher.group(3))
|
||||
}
|
||||
}
|
||||
@@ -1,636 +0,0 @@
|
||||
# GHAST TOOLS
|
||||
|
||||

|
||||

|
||||
|
||||
Набор вспомогательных инструментов для Bukkit API.
|
||||
_Основан на версии Bukkit API 1.12._
|
||||
|
||||
## Содержание
|
||||
|
||||
1. [Перед использованием](#перед-использованием)
|
||||
2. [GhastTools](#ghasttools)
|
||||
3. [AssetsManager](#assetsmanager)
|
||||
4. [BuildHelper](#buildhelper)
|
||||
5. [CommandManager](#commandmanager)
|
||||
6. [EffectsHelper](#effectshelper)
|
||||
7. [EventContext](#eventcontext)
|
||||
8. [JdbcTemplate](#jdbctemplate)
|
||||
9. [ScheduleManager](#schedulemanager)
|
||||
10. [ScheduleTask](#scheduletask)
|
||||
11. [I18n](#i18n)
|
||||
12. [XLog](#xlog)
|
||||
13. [Подключение](#подключение)
|
||||
1. [Gradle](#gradle)
|
||||
2. [Maven](#maven)
|
||||
|
||||
---
|
||||
|
||||
## Перед использованием
|
||||
|
||||
Перед началом использования, необходимо в вашем Bukkit-плагине прописать подобный код:
|
||||
|
||||
```java
|
||||
void onLoad() {
|
||||
GhastTools.setPlugin(this);
|
||||
}
|
||||
```
|
||||
|
||||
Это необходимо сделать, т.к. весь инструментарий основан на статических (static) методах.
|
||||
|
||||
Все методы данного набора инструментов объеденены в классы, выполняющие роль группировщиков.
|
||||
|
||||
## GhastTools
|
||||
|
||||
Методы общего назначения или без определённой группировки.
|
||||
|
||||
### loadConfig
|
||||
|
||||
Загрузка файла настроек плагина - `config.yml`.
|
||||
|
||||
```java
|
||||
YamlConfiguration config = GhastTools.loadConfig();
|
||||
```
|
||||
|
||||
По-умолчанию "гаст" пытается файл найти в папке плагина - `getDataFolder()`.
|
||||
Если файла там нет, то выгружает встроенный (имеющийся в `.jar` файле плагина) в эту папку и загружает его.
|
||||
|
||||
```java
|
||||
YamlConfiguration config = GhastTools.loadConfig(false);
|
||||
```
|
||||
|
||||
Если передать параметр `false`, то при отсутствии файла `config.yml` в папке плагина,
|
||||
будет загруден исключительно встроенный файл настроек.
|
||||
|
||||
## AssetsManager
|
||||
|
||||
Методы по работе с файлами плагина (_"ассетами"_).
|
||||
|
||||
У каждой группы методов один и тот же набор входных параметров:
|
||||
|
||||
- `resourceName` - наименование и путь к файлу в папке плагина
|
||||
- `defaultResourceName` - наименование и путь к файлу в плагине.
|
||||
_Опционально. По-умолчанию равнен `resourceName`_
|
||||
- `saveDefault` - необходимость скопировать содержимое файла из `defaultResourceName` в файл `resourceName`.
|
||||
_Опционально. По-умолчанию равен `true`_
|
||||
|
||||
Правила поиска файлов так же одинаков для каждой группы:
|
||||
|
||||
- В начале файл ищется в папке плагина
|
||||
- Если файл отсутствует в папке плагина, то...
|
||||
- если `defaultResourceName` не равен `null`...
|
||||
- если `saveDefault` равен `true`, то файл из плагина будет выгружен в папку плагина и от туда загружен в память.
|
||||
- если `saveDefault` равен `false`, то данные будут взяты из файлв в плагине.
|
||||
- если `defaultResourceName` равен `null`, то будет брошено исключение `AssetsException` с описанием ошибки вида "Файл X не найден".
|
||||
|
||||
### getAsInputStream
|
||||
|
||||
```java
|
||||
InputStream inputStream = AssetsManager.getAsInputStream("translate.ru.yml", "translate.yml", false);
|
||||
```
|
||||
|
||||
### getAsReader
|
||||
|
||||
```java
|
||||
Reader reader = AssetsManager.getAsReader("translate.ru.yml", "translate.yml", false);
|
||||
```
|
||||
|
||||
### getAsString
|
||||
|
||||
```java
|
||||
String string = AssetsManager.getAsString("readme.txt", "readme.txt", StandardCharsets.UTF_8, false);
|
||||
```
|
||||
|
||||
У этой группы есть дополнительный _опциональный_ параметр - `charset` - в котором указывается кодиривка получаемой строки.
|
||||
_По-умолчанию равен `StandardCharsets.UTF_8`_
|
||||
|
||||
## BuildHelper
|
||||
|
||||
Набор методов облегчающих размецение объектов на карте.
|
||||
|
||||
### placeSkull
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
Skull skull = BuildHelper.placeSkull(location, BlockFace.NORTH)
|
||||
```
|
||||
|
||||
### placeSignWall
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
Sign signWall = BuildHelper.placeSignWall(location, BlockFace.NORTH)
|
||||
```
|
||||
|
||||
## CommandManager
|
||||
|
||||
Регистрация команд.
|
||||
|
||||
Имеется два варианта использования: упрощённый
|
||||
|
||||
```java
|
||||
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
и подробный:
|
||||
|
||||
```java
|
||||
CommandManager.create("start")
|
||||
.useOnlyPlayer()
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"))
|
||||
.register();
|
||||
```
|
||||
|
||||
### register
|
||||
|
||||
Упрощенная регистрация команды. Указывается лишь название команды и исполнитель.
|
||||
|
||||
```java
|
||||
CommandManager.register("start", (sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Конструктор для подробного варианта регистрации команды.
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start");
|
||||
```
|
||||
|
||||
### executer
|
||||
|
||||
Указание исполнителя для команды
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"));
|
||||
```
|
||||
|
||||
### onError
|
||||
|
||||
Обработчик исключений
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.onError((sender, commandName, args, exception) -> {
|
||||
sender.sendMessage(ChatColor.RED + "Произошла ошибка при выполнении команды '" + commandName + "'.");
|
||||
exception.printStackTrace();
|
||||
});
|
||||
```
|
||||
|
||||
### useOnlyPlayer
|
||||
|
||||
Указание, что данную команду могут использовать только Игроки.
|
||||
Опционально можно указать сообщение, которое будет выводиться в консоль.
|
||||
_Отменяет действие указателя `useOnlyConsole`_
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.useOnlyPlayer("Команду могут использовать только игроки");
|
||||
```
|
||||
|
||||
### useOnlyConsole
|
||||
|
||||
Указание, что данную команду можно использовать только в консоле.
|
||||
Опционально можно указать сообщение, которое будет выводиться Игроку.
|
||||
_Отменяет действие указателя `useOnlyPlayer`_
|
||||
|
||||
```java
|
||||
CommandManager.Builder builder = CommandManager.create("start")
|
||||
.useOnlyConsole(ChatColor.RED + "Команду можно использовать только в консоли");
|
||||
```
|
||||
|
||||
### register
|
||||
|
||||
Регистрация описанной в Конструкторе команды.
|
||||
|
||||
```java
|
||||
CommandManager.create("start")
|
||||
.useOnlyPlayer()
|
||||
.executer((sender, args) -> sender.sendMessage("hello!"))
|
||||
.register();
|
||||
```
|
||||
|
||||
## EffectsHelper
|
||||
|
||||
Набор методов для работы с эффектами.
|
||||
|
||||
### playSound
|
||||
|
||||
Воспроизвести звук.
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
EffectsHelper.playSound(location, Sound.AMBIENT_CAVE, 1.0f);
|
||||
```
|
||||
|
||||
### particle
|
||||
|
||||
Создание частиц.
|
||||
|
||||
```java
|
||||
Location location = ...;
|
||||
EffectsHelper.particle(location, Particle.REDSTONE, 1.0d, 1.0d, 1.0d, 1.0d, 5);
|
||||
```
|
||||
|
||||
## EventContext
|
||||
|
||||
Регистрация группы обработчиков событий, объединённых общим условием выполнения.
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
.onEvent(PlayerJoinEvent.class, event -> { event.getPlayer().kickPlayer("Max players"); });
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Создание контекста событий.
|
||||
|
||||
```java
|
||||
EventContext eventContext = EventContext.create();
|
||||
```
|
||||
|
||||
### filter
|
||||
|
||||
Условие, при котором будут срабатывать обработчики событий в данном контексте.
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
```
|
||||
|
||||
### onEvent
|
||||
|
||||
Указание события и его обработчика.
|
||||
_Обработчик события регистрируется сразу же._
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.filter(() -> Bukkit.getOnlinePlayers().size() > 10)
|
||||
.onEvent(PlayerJoinEvent.class, event -> event.getPlayer().kickPlayer("Max players"));
|
||||
```
|
||||
|
||||
### cancelEvent
|
||||
|
||||
Отменить событие.
|
||||
_Обработчик события регистрируется сразу же._
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.cancelEvent(BlockPlaceEvent.class);
|
||||
```
|
||||
|
||||
эквивалентен коду:
|
||||
|
||||
```java
|
||||
EventContext.create()
|
||||
.onEvent(BlockPlaceEvent.class, event -> event.setCancelled(true))
|
||||
```
|
||||
|
||||
## JdbcTemplate
|
||||
|
||||
Инструмент для упрощения работы с SQL базами данных, работающими через JDBC.
|
||||
|
||||
Для начала потребуется создать объект `DataSource`
|
||||
|
||||
```java
|
||||
// На примере MySQL
|
||||
MysqlDataSource dataSource = new MysqlDataSource();
|
||||
dataSource.setServerName("localhost");
|
||||
dataSource.setPort(3306);
|
||||
dataSource.setCharacterEncoding(StandardCharsets.UTF_8.name());
|
||||
dataSource.setDatabaseName("MyDataBase");
|
||||
dataSource.setUser("root");
|
||||
dataSource.setPassword("secret");
|
||||
```
|
||||
|
||||
После чего создать `JdbcTemplate`
|
||||
|
||||
```java
|
||||
JdbcTemplate jdbcTemplate = new JdbcTemplate(dataSource);
|
||||
```
|
||||
|
||||
### execute
|
||||
|
||||
Выполнение SQL запроса без последующей обработки результатов выполнения.
|
||||
|
||||
```java
|
||||
jdbcTemplate.execute("CREATE TABLE my_table (id int, name varchar(16));");
|
||||
```
|
||||
|
||||
### query
|
||||
|
||||
Выполнение SQL запроса и обработка его результатов.
|
||||
Может возвращать любой тип объектов.
|
||||
|
||||
```java
|
||||
String name = jdbcTemplate.query("SELECT name FROM my_table LIMIT 0,1", resultSet -> {
|
||||
if (resultSet.next()) {
|
||||
return resultSet.getString("name");
|
||||
} else {
|
||||
return null;
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
```java
|
||||
List<String> names = jdbcTemplate.query("SELECT name FROM my_table", resultSet -> {
|
||||
if (resultSet.next()) {
|
||||
List<String> list = new ArrayList<>();
|
||||
do {
|
||||
list.add(resultSet.getString("name"));
|
||||
} while (resultSet.next());
|
||||
return list;
|
||||
} else {
|
||||
return Collections.emptyList();
|
||||
}
|
||||
});
|
||||
```
|
||||
|
||||
### queryOne
|
||||
|
||||
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
|
||||
Возвращает `Optional`.
|
||||
|
||||
```java
|
||||
Optional<String> optName = jdbcTemplate.queryOne("SELECT name FROM my_table WHERE name LIKE 'dmitriymx'", rs -> rs.getString("name"));
|
||||
```
|
||||
|
||||
### queryList
|
||||
|
||||
Выполнение SQL запроса и обработка результата как списка данных.
|
||||
Возвращает `List`.
|
||||
|
||||
```java
|
||||
List<String> names = jdbcTemplate.queryList("SELECT name FROM my_table", (resultSet, rowNum) -> resultSet.getString("name"));
|
||||
```
|
||||
|
||||
### queryForMap
|
||||
|
||||
Выполнение SQL запроса с расчетом, что результат будет единичным либо не будет вовсе.
|
||||
Возвращает `Map<String, Object>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
|
||||
|
||||
```java
|
||||
Map<String, Object> map = jdbcTemplate.queryForMap("SELECT * FROM my_table LIMIT 0,1;");
|
||||
```
|
||||
|
||||
### queryForMapList
|
||||
|
||||
Выполнение SQL запроса и обработка результата как списка данных.
|
||||
Возвращает `List<Map<String, Object>>`, где ключ — это наименование колонок таблицы, а значения — это значения в ячейках таблицы.
|
||||
|
||||
```java
|
||||
List<Map<String, Object>> mapList = jdbcTemplate.queryForMapList("SELECT * FROM my_table");
|
||||
```
|
||||
|
||||
### update
|
||||
|
||||
Выполнение SQL запроса где будет происходить обновление данных в таблице.
|
||||
Под "обновлением" подразумеваются любые изменения в таблице: `UPDATE`, `DELETE`, `INSERT`.
|
||||
Возвращает число строк, которые были _по факту обновлены_ в таблице.
|
||||
|
||||
```java
|
||||
int rows = jdbcTemplate.update("DELETE FROM my_table WHERE name LIKE 'dmitriymx';");
|
||||
```
|
||||
|
||||
## ScheduleManager
|
||||
|
||||
Набор методов для создания параллельных задач, выполняющихся один раз или по рассписанию.
|
||||
|
||||
### createTask
|
||||
|
||||
Создание конструктора задачи.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask();
|
||||
```
|
||||
|
||||
### useBukkitScheduler
|
||||
|
||||
Если задача будет взаимодействоватьс **Bukkit API** или необходима привязка задачи к _тикам_,
|
||||
то необходимо использовать данный указатель.
|
||||
|
||||
В ином случае, указатель не нужен.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.useBukkitScheduler();
|
||||
```
|
||||
|
||||
### after
|
||||
|
||||
Указание, что задачу нужно выполнить не сразу, а с некоторой задержкой перед запуском.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.after(5, TimeUnit.MINUTES);
|
||||
```
|
||||
|
||||
### every
|
||||
|
||||
Указание, что задачу нужно повторять через указанное время.
|
||||
|
||||
```java
|
||||
ScheduleManager.Builder builder = ScheduleManager.createTask()
|
||||
.every(5, TimeUnit.MINUTES);
|
||||
```
|
||||
|
||||
### create
|
||||
|
||||
Создание описанной задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ScheduleManager.createTask()
|
||||
.every(1, TimeUnit.SECONDS)
|
||||
.create(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
|
||||
```
|
||||
|
||||
_Задача будет только создана. Для её выполнения нужно вызвать `scheduleTask.start()`._
|
||||
|
||||
### execute
|
||||
|
||||
Создание и выполнение описанной задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ScheduleManager.createTask()
|
||||
.every(1, TimeUnit.SECONDS)
|
||||
.execute(() -> Bukkit.getServer().getLogger().info("TimeMS: " + System.currentTimeMillis()));
|
||||
```
|
||||
|
||||
## ScheduleTask
|
||||
|
||||
Вспомогательный объект, созданный через `ScheduleManager`. Позволяет управлять созданной задачей.
|
||||
|
||||
### start
|
||||
|
||||
Запускает задачу, если она еще не запущена.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
scheduleTask.start();
|
||||
```
|
||||
|
||||
### isCanceled
|
||||
|
||||
Возвращает состояние задачи. Если `true`, значит задача была или _отменена/остоновлена_ или была завершена.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
boolean status = scheduleTask.isCanceled();
|
||||
```
|
||||
|
||||
### cancel
|
||||
|
||||
Отменяет/Остонавливает выполнение задачи.
|
||||
|
||||
```java
|
||||
ScheduleTask scheduleTask = ...;
|
||||
scheduleTask.cancel();
|
||||
```
|
||||
|
||||
## I18n
|
||||
|
||||
Инструмент для работы с мультиязыковыми сообщениями или просто сообщениями, которые храняться в отдельном файле.
|
||||
|
||||
Позволяет использовать шаблонизированные сообщения вида `Привет, {player}!`.
|
||||
|
||||
### loadMessages
|
||||
|
||||
Загрузка сообщений в инструмент.
|
||||
|
||||
Передать можно как "мапу" с перечислением ключ-сообщение, так и `Reader` на файл в формате `key=message` (как у `Properties`).
|
||||
|
||||
```java
|
||||
Map<String, String> messagesMap = ...;
|
||||
I18n.loadMessages(messagesMap);
|
||||
```
|
||||
|
||||
```java
|
||||
Reader reader = AssetsManager.getAsReader("messages.properties");
|
||||
I18n.loadMessages(reader);
|
||||
```
|
||||
|
||||
В первом параметре можно указать код языка, для которого загружаются сообщения. По-умолчанию будет "en".
|
||||
|
||||
```java
|
||||
Map<String, String> enMessagesMap = ...;
|
||||
Map<String, String> ruMessagesMap = ...;
|
||||
|
||||
I18n.loadMessages("en", enMessagesMap);
|
||||
I18n.loadMessages("ru", ruMessagesMap);
|
||||
```
|
||||
|
||||
```java
|
||||
Reader readerEn = AssetsManager.getAsReader("messages.properties");
|
||||
Reader readerRu = AssetsManager.getAsReader("messages.ru.properties");
|
||||
|
||||
I18n.loadMessages("en", readerEn);
|
||||
I18n.loadMessages("ru", readerRu);
|
||||
```
|
||||
|
||||
### get
|
||||
|
||||
Получение сообщения по его ключу.
|
||||
|
||||
```java
|
||||
String msg = I18n.get("player.join.msg");
|
||||
```
|
||||
|
||||
Если следующим сообщением указать `Map<String, Object>`, то можно будет воспользоваться шаблонизатором.
|
||||
|
||||
```java
|
||||
Map<String, String> messagesMap = new HashMap<>();
|
||||
messagesMap.put("player.join.msg", "Привет, {player}!");
|
||||
|
||||
I18n.loadMessages(messagesMap);
|
||||
|
||||
Map<String, String> params = new HashMap<>();
|
||||
params.put("player", event.getPlayer().getName());
|
||||
|
||||
String msg = I18n.get("player.join.msg", params);
|
||||
```
|
||||
|
||||
Однако можно создавать `Map<String, String> params` явно, а воспользоваться [paramBuilder()](#parambuilder)
|
||||
|
||||
```java
|
||||
String msg = I18n.get("player.join.msg", I18n.paramBuilder()
|
||||
.add("player", event.getPlayer().getName())
|
||||
.build());
|
||||
```
|
||||
|
||||
Можно первым параметром указать код языка.
|
||||
|
||||
```java
|
||||
String msg = I18n.get("ru", "player.join.msg");
|
||||
```
|
||||
|
||||
### paramBuilder
|
||||
|
||||
Инструмент для параметизирования шаблонов сообщений.
|
||||
|
||||
```java
|
||||
Map<String, Object> params = I18n.paramBuilder()
|
||||
.add("player", event.getPlayer().getName())
|
||||
.build();
|
||||
String msg = I18n.get("player.join.msg", params);
|
||||
```
|
||||
|
||||
## XLog
|
||||
|
||||
Замена стандартному `getLogger()`, который использует `java.utils.Logger` и не всегда удобен для логирования.
|
||||
|
||||
Имеет 4 уровня логирования: `debug`, `info`, `warning`, `error`.
|
||||
|
||||
Сообщения могут быть шаблонизированными. Синтаксис шаблонов — `java.text.MessageFormat`.
|
||||
|
||||
Примеры:
|
||||
|
||||
```java
|
||||
XLog.info("Hello");
|
||||
XLog.info("Player {0} join game", event.getPlayer().getName());
|
||||
|
||||
XLog.error("ERROR!", exception);
|
||||
XLog.error("ERROR: {0}", exception.getMessage());
|
||||
// Для экранирования "{" нужно перед ней поставить "'".
|
||||
// А для использования "'" нужно их дублировать.
|
||||
XLog.error("ERROR ''{0}'' in Event '{{1}'}: {2}", exception.getClass(), event.getClass(), exception.getMessage());
|
||||
XLog.error("ERROR: {0}", exception.getMessage(), exception);
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Подключение
|
||||
|
||||
### Gradle
|
||||
|
||||
```groovy
|
||||
repositories {
|
||||
maven { url 'https://dmx-mc-project.gitlab.io/maven-repository/' }
|
||||
}
|
||||
```
|
||||
|
||||
```groovy
|
||||
implementation group: 'ghast', name: 'ghast-tools', version: '@VERSION@'
|
||||
```
|
||||
|
||||
### Maven
|
||||
|
||||
```xml
|
||||
<repositories>
|
||||
<repository>
|
||||
<id>dmx-mc-project</id>
|
||||
<url>https://dmx-mc-project.gitlab.io/maven-repository/</url>
|
||||
</repository>
|
||||
</repositories>
|
||||
```
|
||||
|
||||
```xml
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>ghast</groupId>
|
||||
<artifactId>ghast-tools</artifactId>
|
||||
<version>@VERSION@</version>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
```
|
||||
@@ -1 +1,3 @@
|
||||
projectGroup=ghast
|
||||
projectGroup=ghast
|
||||
projectName=ghast-tools
|
||||
projectVersion=1.11
|
||||
@@ -1,3 +0,0 @@
|
||||
dependencies {
|
||||
compileOnly libs.bukkit
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
moduleName=phantom-classes
|
||||
moduleVersion=1.0-SNAPSHOT
|
||||
@@ -1,16 +0,0 @@
|
||||
package com.mojang.authlib;
|
||||
|
||||
import com.mojang.authlib.properties.PropertyMap;
|
||||
|
||||
import java.util.UUID;
|
||||
|
||||
public class GameProfile {
|
||||
|
||||
public GameProfile(UUID id, String name) {
|
||||
|
||||
}
|
||||
|
||||
public PropertyMap getProperties() {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
package com.mojang.authlib.properties;
|
||||
|
||||
public class Property {
|
||||
|
||||
public Property(String value, String name) {
|
||||
|
||||
}
|
||||
}
|
||||
@@ -1,12 +0,0 @@
|
||||
package com.mojang.authlib.properties;
|
||||
|
||||
import com.google.common.collect.ForwardingMultimap;
|
||||
import com.google.common.collect.Multimap;
|
||||
|
||||
public class PropertyMap extends ForwardingMultimap<String, Property> {
|
||||
|
||||
@Override
|
||||
protected Multimap<String, Property> delegate() {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -1,7 +0,0 @@
|
||||
package net.minecraft.server.v1_12_R1;
|
||||
|
||||
public class BlockPosition {
|
||||
|
||||
public BlockPosition(double x, double y, double z) {
|
||||
}
|
||||
}
|
||||
@@ -1,5 +0,0 @@
|
||||
package net.minecraft.server.v1_12_R1;
|
||||
|
||||
public class TileEntity {
|
||||
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
package net.minecraft.server.v1_12_R1;
|
||||
|
||||
import com.mojang.authlib.GameProfile;
|
||||
|
||||
public class TileEntitySkull extends TileEntity {
|
||||
|
||||
public void setGameProfile(GameProfile gameprofile) {
|
||||
|
||||
}
|
||||
}
|
||||
@@ -1,8 +0,0 @@
|
||||
package net.minecraft.server.v1_12_R1;
|
||||
|
||||
public class WorldServer {
|
||||
|
||||
public TileEntity getTileEntity(BlockPosition pos) {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
package org.bukkit.craftbukkit.v1_12_R1;
|
||||
|
||||
import org.bukkit.command.SimpleCommandMap;
|
||||
|
||||
public class CraftServer {
|
||||
|
||||
public SimpleCommandMap getCommandMap() {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -1,10 +0,0 @@
|
||||
package org.bukkit.craftbukkit.v1_12_R1;
|
||||
|
||||
import net.minecraft.server.v1_12_R1.WorldServer;
|
||||
|
||||
public class CraftWorld {
|
||||
|
||||
public WorldServer getHandle() {
|
||||
return null;
|
||||
}
|
||||
}
|
||||
@@ -1,2 +1,2 @@
|
||||
include 'phantom-classes'
|
||||
include 'tools'
|
||||
rootProject.name = projectName
|
||||
|
||||
|
||||
@@ -1,10 +1,6 @@
|
||||
package ghast;
|
||||
|
||||
import com.mojang.authlib.GameProfile;
|
||||
import com.mojang.authlib.properties.Property;
|
||||
import lombok.experimental.UtilityClass;
|
||||
import net.minecraft.server.v1_12_R1.BlockPosition;
|
||||
import net.minecraft.server.v1_12_R1.TileEntitySkull;
|
||||
import org.bukkit.Location;
|
||||
import org.bukkit.Material;
|
||||
import org.bukkit.SkullType;
|
||||
@@ -12,7 +8,8 @@ import org.bukkit.block.Block;
|
||||
import org.bukkit.block.BlockFace;
|
||||
import org.bukkit.block.Sign;
|
||||
import org.bukkit.block.Skull;
|
||||
import org.bukkit.craftbukkit.v1_12_R1.CraftWorld;
|
||||
import ru.dmitriymx.reflection.ReflectionClass;
|
||||
import ru.dmitriymx.reflection.ReflectionObject;
|
||||
|
||||
import java.nio.charset.StandardCharsets;
|
||||
import java.util.Base64;
|
||||
@@ -22,6 +19,9 @@ import java.util.UUID;
|
||||
@SuppressWarnings("unused")
|
||||
public class BuildHelper {
|
||||
|
||||
private final Class<?> CLASS_BLOCKPOSITION = getClassForName("net.minecraft.server.v1_12_R1.BlockPosition");
|
||||
private final Class<?> CLASS_GAMEPROFILE = getClassForName("com.mojang.authlib.GameProfile");
|
||||
|
||||
/**
|
||||
* Установка черепа.
|
||||
* <p>
|
||||
@@ -95,10 +95,17 @@ public class BuildHelper {
|
||||
* @param skinUrl URL на текстуру
|
||||
*/
|
||||
public static void setPlayerHeadSkin(Skull skull, String skinUrl) {
|
||||
((TileEntitySkull) (((CraftWorld) skull.getWorld())
|
||||
.getHandle()
|
||||
.getTileEntity(new BlockPosition(skull.getX(), skull.getY(), skull.getZ()))))
|
||||
.setGameProfile(generateTexturedPlayerProfile(skinUrl));
|
||||
//TODO заменить рефлексию на "фантомные" классы
|
||||
ReflectionObject refobjBlockPosition = new ReflectionClass(CLASS_BLOCKPOSITION)
|
||||
.constructor(double.class, double.class, double.class)
|
||||
.newInstance(skull.getX(), skull.getY(), skull.getZ());
|
||||
|
||||
new ReflectionObject(skull.getWorld())
|
||||
.method("getHandle").invoke()
|
||||
.method("getTileEntity", CLASS_BLOCKPOSITION)
|
||||
.invoke(refobjBlockPosition.getOriginalObject())
|
||||
.method("setGameProfile", CLASS_GAMEPROFILE)
|
||||
.invoke(getRefObjPlayerProfile(skinUrl).getOriginalObject());
|
||||
}
|
||||
|
||||
public Sign placeSignWall(Location location, BlockFace face) {
|
||||
@@ -112,12 +119,29 @@ public class BuildHelper {
|
||||
return sign;
|
||||
}
|
||||
|
||||
private GameProfile generateTexturedPlayerProfile(String skinUrl) {
|
||||
GameProfile gameProfile = new GameProfile(UUID.randomUUID(), null);
|
||||
private ReflectionObject getRefObjPlayerProfile(String url){
|
||||
ReflectionObject refobjProperty = new ReflectionClass(
|
||||
getClassForName("com.mojang.authlib.properties.Property"))
|
||||
.constructor(String.class, String.class)
|
||||
.newInstance("textures", Base64.getEncoder()
|
||||
.encodeToString(("{textures:{SKIN:{url:\"" + url + "\"}}}").getBytes(StandardCharsets.UTF_8)));
|
||||
|
||||
gameProfile.getProperties().put("textures",
|
||||
new Property("textures", Base64.getEncoder().encodeToString(
|
||||
("{textures:{SKIN:{url:\"" + skinUrl + "\"}}}").getBytes(StandardCharsets.UTF_8))));
|
||||
return gameProfile;
|
||||
ReflectionObject refobjGameProfile = new ReflectionClass(CLASS_GAMEPROFILE)
|
||||
.constructor(UUID.class, String.class)
|
||||
.newInstance(UUID.randomUUID(), null);
|
||||
refobjGameProfile
|
||||
.method("getProperties").invoke()
|
||||
.method("put", Object.class, Object.class)
|
||||
.invoke("textures", refobjProperty.getOriginalObject());
|
||||
|
||||
return refobjGameProfile;
|
||||
}
|
||||
|
||||
private Class<?> getClassForName(String className) {
|
||||
try {
|
||||
return Class.forName(className);
|
||||
} catch (Exception e) {
|
||||
throw new RuntimeException(e);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -4,7 +4,8 @@ import lombok.AccessLevel;
|
||||
import lombok.RequiredArgsConstructor;
|
||||
import lombok.experimental.UtilityClass;
|
||||
import org.bukkit.Bukkit;
|
||||
import org.bukkit.craftbukkit.v1_12_R1.CraftServer;
|
||||
import org.bukkit.command.Command;
|
||||
import ru.dmitriymx.reflection.ReflectionObject;
|
||||
|
||||
@UtilityClass
|
||||
@SuppressWarnings("unused")
|
||||
@@ -58,10 +59,13 @@ public class CommandManager {
|
||||
}
|
||||
|
||||
public void register() {
|
||||
((CraftServer) Bukkit.getServer()).getCommandMap().register(
|
||||
name,
|
||||
new CommandWrapper(name, this.onlyPlayer, this.deniedMessage, this.executer, this.errorConsumer)
|
||||
);
|
||||
//TODO для Paper такие "извращения" не требуются. Нужно продумать.
|
||||
new ReflectionObject(Bukkit.getServer())
|
||||
.method("getCommandMap").invoke()
|
||||
.method("register", String.class, Command.class).invoke(
|
||||
name, new CommandWrapper(name, this.onlyPlayer, this.deniedMessage,
|
||||
this.executer, this.errorConsumer)
|
||||
);
|
||||
}
|
||||
}
|
||||
}
|
||||
@@ -1,13 +0,0 @@
|
||||
repositories {
|
||||
maven repos.mavenSpigotMC
|
||||
maven repos.mavenDmxMcProject
|
||||
}
|
||||
|
||||
dependencies {
|
||||
compileOnly project(':phantom-classes')
|
||||
compileOnly libs.bukkit
|
||||
implementation libs.commons_text
|
||||
|
||||
testImplementation libs.bukkit
|
||||
testImplementation libs.test.h2db
|
||||
}
|
||||
@@ -1,2 +0,0 @@
|
||||
moduleName=ghast-tools
|
||||
moduleVersion=1.11-SNAPSHOT
|
||||
Reference in New Issue
Block a user