version 1.1

Main.java -> GiftAPI.java
This commit is contained in:
ScriptCat 2025-07-30 10:49:46 +03:00
parent 31af80f62e
commit 1bb8d01a67

View File

@ -9,56 +9,57 @@ GiftAPI
Использование
-------------
1. Скачайте релиз или соберите плагин сами.
2. Переместите в папку КОРНЕВАЯ-ПАПКА-СЕРВЕРА/plugins.
2. Переместите в папку `КОРНЕВАЯ-ПАПКА-СЕРВЕРА/plugins`.
3. Скопируйте в рут папку вашего плагина.
4. В вашей IDE импортируете giftapi.jar.
4. В вашей IDE импортируете `giftapi.jar`.
5. *Используйте пример использования и документация для использования API*
6. Соберите ваш плагин в JAR.
7. Скопируйте получившися JAR файл в КОРНЕВАЯ-ПАПКА-СЕРВЕРА/plugins.
3. Запустите сервер или введите команду /reload.
7. Скопируйте получившися JAR файл в `КОРНЕВАЯ-ПАПКА-СЕРВЕРА/plugins`.
3. Запустите сервер или введите команду `/reload`.
Документация
------------
1. 'add(player, item)'
- Описание: добавляет предмет в кастомные инвентарь игрока.
- Параметры:
- 'player' (Player): игрок которому нужно добавить предмет.
- 'item' (ItemStack): предмет который должен быть сохранен в инвентарь.
### `add(player, item)`
- **Описание**: добавляет предмет в кастомные инвентарь игрока.
- **Параметры**:
- `player` (`Player`): игрок которому нужно добавить предмет.
- `item` (`ItemStack`): предмет который должен быть сохранен в инвентарь.
2. 'remove(player, item)'
- Описание: удаляет предмет из кастомного инвентаря игрока.
- Параметры:
- 'player' (Player): игрок которому нужно удалить предмет.
- 'item' (ItemStack): предмет который должен быть удалён из инвентаря.
### `remove(player, item)`
- **Описание**: удаляет предмет из кастомного инвентаря игрока.
- **Параметры**:
- `player` (`Player`): игрок которому нужно удалить предмет.
- `item` (`ItemStack`): предмет который должен быть удалён из инвентаря.
3. 'openGUI()'
- Описание: открывает кастомный инвентарь игрока.
- Параметры:
- 'player' (Player): игрок которому нужно открыть кастомный инвентарь.
### `openGUI()`
- **Описание**: открывает кастомный инвентарь игрока.
- **Параметры**:
- `player` (`Player`): игрок которому нужно открыть кастомный инвентарь.
Пример Использования
--------------------
...
```import tokarotik.giftapi.GiftAPI;
import tokarotik.giftapi.GiftAPI;
...
// get plugin
// Get plugin instance
Plugin plugin = Bukkit.getPluginManager().getPlugin("GiftAPI");
if (plugin != null && plugin.isEnabled() && plugin instanceof GiftAPI) {
// set up api
// Set up API
GiftAPI giftAPI = (GiftAPI) plugin;
// find first online player
// Get the first online player
Player player = Bukkit.getOnlinePlayers()[0];
// create item stick
// Create an item (stick)
ItemStack item = new ItemStack(Material.STICK);
// add to player stick
// Add item to player's custom inventory
giftAPI.add(player, item);
// open inventory
// Open the custom inventory GUI
giftAPI.openGUI(player);
}
```
Требования
----------