【Bukkit】【Spigot】めっちゃ便利!インベントリをファイルに保存して活用する方法【プラグイン開発】

簡単にインベントリをファイルに保存する方法です。

拡張インベントリを作るときに便利だと思います!

組み込み型なので自作プラグインに埋め込んでください!

 

※お借りしたコード

https://jyn.jp/ – CustomConfig 

 

1.完成例

完成して実際に動かしたものの動画があります!

 

2.制作環境について

IDE Eclipse 

Java java7

Spigot 1.14.4

 

3.保存形式

YAMLにて保存しました

 

4.コード

とってもシンプルです。

※プラグインの無効化時にクリーン処理を挟んでください。 InventorySQL.clean();

※プレイヤーが退出したときにクリーン処理を挟んでください。 InventorySQL.clean(Player#getUniqueId());

※インベントリをそのまま保存しておくとメモリリークが心配なので毎回作成していますが、必要に応じて変更してください。

※ファイル名、フォルダを追加する場合は必要に応じて引数を変更してください。


import java.util.ArrayList;
import java.util.Arrays;
import java.util.HashMap;
import java.util.List;
import java.util.UUID;

import org.bukkit.Bukkit;
import org.bukkit.configuration.file.FileConfiguration;
import org.bukkit.entity.Player;
import org.bukkit.inventory.Inventory;
import org.bukkit.inventory.ItemStack;

import CustomConfig;

public class InventorySQL{
private static HashMap<UUID, InventorySQL> datas = new HashMap<>();
public static InventorySQL getData(UUID key) {
if (!datas.containsKey(key)) {
return new InventorySQL(key);
}
return datas.get(key);
}

public static void clean() {
for (UUID key : datas.keySet()) {
clean(key);
}
}
public static void clean(UUID key) {
if (datas.containsKey(key)) {
datas.get(key).save();
datas.remove(key);
}
}

private UUID key;
private ItemStack[] contents;
public InventorySQL(UUID key) {
this.key = key;

reload();


datas.put(key, this);
}

public void reload() {
contents = new ItemStack[9 * 6];
try {
CustomConfig CC = new CustomConfig(key.toString() + ".inv.yml");
FileConfiguration config = CC.getConfig();

if (config.contains("inventory")) {
List<?> list = config.getList("inventory");
int max = list.size();
for (int cur = 0; cur < max; cur++) {
Object obj = list.get(cur);
if (obj instanceof ItemStack) {
contents[cur] = (ItemStack) obj;
}
}
}
} catch (Exception e) {
e.printStackTrace();
}
}

public void open(Player p) {
Inventory inv = Bukkit.createInventory(null, 9 * 6, "§eBackPack");
inv.setContents(contents);
p.openInventory(inv);
}

public void closeInventory(Player p, Inventory inv) {
contents = inv.getContents();
}

public void save() {
CustomConfig CC = new CustomConfig(key.toString() + ".inv.yml");
FileConfiguration config = CC.getConfig();

/**
* Save as list type
*/
List<ItemStack> list = new ArrayList<>(Arrays.asList(contents));

config.set("inventory", list);
CC.saveConfig();
}
}

 

今回はやりませんでしたが、Blob形式に変換できればSQLにも保存できると思います。

 

機能を追加できるようにする

ミニゲームなどのゲームに追加で機能をつけれるようにする方法

 

/**
 * 本来ならGetter、Setterをつけるべき箇所につけていないのでご注意を。
 */
//Extension class
public class Extension{
  // 拡張機能をまとめる
  public static HashMap<String, ExtensionItem> Items = new HashMap<>();
  public static void reg(ExtensionItem item){
    // 拡張機能を追加するメゾットです
    item.onEnable();
    Items.put(item.getName(), item);
  }
}

// ExtensionItemInterFace
// 拡張機能の基盤です
public interface ExtensionItemInterFace{
  public String getName();
  public String getVersion();
  public String getDescription();
  public void onEnable();
  public void onDisable();
  public JavaPlugin getInstance();
}

// ExtensionItem
// 基盤を使いやすく(必要なものだけを設定するようにしたもの)です
public class ExtensionItem implements ExtensionItemInterFace{
  @Override
  public String getName(){
    // 拡張機能の名前
    return "Extension";
  }
  @Override
  public String getVersion(){
    // 拡張機能のバージョン
    return "1.0.0";
  }
  @Override
  public String getDescription(){
    // 拡張機能の説明
    return "Extension";
  }
  @Override
  public void onEnable(){
    // 有効にしたとき
  }
  @Override
  public void onDisable(){
    // 無効にしたとき
  }
  @Override
  public JavaPlugin getInstance(){
    // メインクラスを取得する関数
    return /* Main Class Static Instance */ null;
  }
}

// TestExtension
// 拡張機能の例
public class TestExtension extends ExtensionItem{
  // 名前の変更
  @Override
  public String getName(){ return "Test"; }
  @Override
  public void onEnable(){
    // 有効になったときに文字列を出力する
    System.out.printIn("This is a test xD Hello, World!");
  }
}

// Main Class onEnable
public void onEnable(){
  // 拡張機能をなんらかの形で追加する
  Extension.reg(new TestExtension());
}

 

超シンプルなミニゲームの基盤の作り方

基盤中の基盤。

ここに改良を加えていくことで、一つのミニゲームが完成します。

これからミニゲーム作りをする人の参考になれば幸いです(。-ω-)zzz. . . (。゚ω゚) ハッ!

 

onEnableで以下を設定

// 新規Arena作成
// 複数Arenaにするなら改良が必要
Arena arena = new Arena();
// イベントリスナーを登録する
Bukkit.getPluginManager().registerEvents(arena, this);
// タイマーに登録する(一秒ごとに実行される)
Bukkit.getScheduler().runTaskTimer(this, arena, 0L, 20L);

Arena Class

public class Arena implements Runnable, Listener{
  // Arena にいるプレイヤーリスト
  // Join Quit リスナーと合わせて使う
  private ArrayList<UUID> Players = new ArrayList<>();

  @Override
  public void run(){
    // Arena での処理
    // スコアボードの更新やタイマーなど
    // プレイヤーがいなければ、停止、いれば開始などの処理
  }

  // 時間は コンフィグから取得したものをスタチックで宣言する
  // 読み込み時に別に宣言した時間に反映させる
  public static int INT_GAME_TIME = 300;
  public int CRT_GAME_TIME = 300;
  public Arena(){
    CRT_GAME_TIME = INT_GAME_TIME;
  }
  
  @EventHandler
  public void onJoin(PlayerJoinEvent event){
    Player p = event.getPlayer();
    UUID key = p.getUniqueId();
    Players.add(key);
  }
  @EventHandler
  public void onJoin(PlayerJoinEvent event){
    Player p = event.getPlayer();
    UUID key = p.getUniqueId();
    if (Players.cotains(key)){
      Players.remove(key);
    }
  }
}