Pocketmine-MP非公式日本語wiki

以下のUse文が必要です。

use pocketmine\Player;

$player = $this->getServer()->getPlayer("プレイヤー名");

(注) $eventにはeventオブジェクトが入っている状態です。

$player = $event->getPlayer();

(注) $eventにはeventオブジェクトが入っている状態です。

$player = $event->getEntity();

Entityオブジェクトから取得して、getNameなどをする場合は必ずPlayerオブジェクトか確認しないとクラッシュします。

if ($player instanceof Player){
 //プレイヤーだった場合の処理
}

コマンド処理の場合、すでに$senderに送信したプレイヤーのデータが入っています。
ただし、コンソールなどから実行した場合もありますので、必ずプレイヤーオブジェクトか確認してください。

if ($sender instanceof Player){
 // プレイヤーだった場合
}else{
 // プレイヤーオブジェクトではない場合
}

以下のUse文が必要です

use pocketmine\command\ConsoleCommandSender;

if ($sender instanceof ConsoleCommandSender){
 // コンソールだった場合
}else{
 // コンソールではない場合
}

if ($player instanceof Player) {//プレイヤーオブジェクトかの条件分岐
    //プレイヤー
}else{
    //プレイヤーではない
}

$sender->sendMessage("メッセージ");

$player->sendPopup("メッセージ");

$player->sendTip("メッセージ");

$this->getServer()->broadcastMessage("メッセージ");

$this->getServer()->broadcastPopup("メッセージ");

$this->getServer()->broadcastTip("メッセージ");

$player->getServer()->getNameBans()->addBan($player, "理由", null, "BANした人の名前"); //名前BAN
$player->getServer()->getIPBans()->addBan(IPアドレス, "理由", null, "BANした人の名前");//IPBAN
$player->getServer()->getNameBans()->remove($player);//名前BAN解除
$player->getServer()->getIPBans()->remove($player);//IPBAN解除

$player->kick("理由", true);//trueをfalseにすることで"Kicked by admin."と表示されなくなります
$player->close("", "理由");//kickの使用を推奨します。
(1番目の引数を$player->getLeaveMessage()にすることで、プレイヤーの退出がブロードキャストされます)

use文

use pocketmine\math\Vector3;

Code

$pos = new Vector3(x座標, y座標, z座標);
$player->setSpawn($pos);

$player->getName();//ユーザー名
$player->getAddress();//ipアドレス
$player->loginData["clientId"];//クライアントID
$player->getGamemode();//ゲームモード 0=サバイバル, 1=クリエイティブ, 2,アドベンチャー,3 スペクテイター
$player->getLevel();//プレイヤーのいるワールド(レベル)のオブジェクト
$player->getX();//X座標、getXのXを変更すればY、Z座標も取得可能
$player->x;//getX()と使い方は同じですがこっちの方が軽いです
$player->getDirection();//方向 0=南,1=西,2=北,3=東
$player->getHealth();//プレイヤーの現在の体力
$player->getMaxHealth();//プレイヤーの最大体力
$player->getDisplayName();//チャットをした時に表示される名前を取得
$player->getNameTag();//プレイヤーの上に表示される名前を取得
$player->isOnFire();//プレイヤーが燃えているか取得(燃えていればtrue)
$player->isSneaking();//プレイヤーがスニークしているか取得(スニーク中であればtrue)
$player->isSprinting();//プレイヤーが走っているか取得(走っていればtrue)
player->isOp();//プレイヤーがopかどうか取得(opならtrue)

$player->setGamemode(0);//ゲームモード 0=サバイバル, 1=クリエイティブ, 2,アドベンチャー,3 スペクテイター
$player->setHealth(10);//プレイヤーの体力を変更
$player->setMaxHealth(30);//最大体力を変更
$player->kill();//プレイヤーを殺す
$player->attack(1, $event);//1番目の引数にダメージ数を、2番目にEntityDamageEventが必要です(EntityDamageEventについては省略)
$player->setOnFire(10);//プレイヤーを燃やす(秒数)
$player->setOp(true);//権限を付与する(引数をfalseにすることで剥奪できます)
$player->setWhitelisted(true);//プレイヤーをホワイトリストに追加(引数をfalseにすることで削除できます)
$player->setAllowFlight(true);//クリエイティブモードのような飛行できるように(引数をfalseでクリエイティブでも飛べなくなります)
$player->setAutoJump(true);//オートジャンプができるように(引数をfalseでオートジャンプができなくなる)
$player->setNameTag("名前");//プレイヤーの上に表示される名前を変更
$player->setDisplayName("名前");//チャットをした時に表示される名前を変更
$player->save();//プレイヤー情報をセーブ

以下のコードが必要です。

use pocketmine\event\entity\EntityDamageEvent;

$ev = new EntityDamageEvent($entity, EntityDamageEvent::CAUSE_MAGIC, 1);//EntityDamageEvent::CAUSE_MAGICを変えることでダメージの種類を、1を変えることでダメージの強さが変更できます
$entity->attack($ev->getFinalDamage(), $ev);

以下のコードが必要です。

use pocketmine\event\entity\EntityDeathEvent;
use pocketmine\item\Item;
//こちらの方も使えます
use pocketmine\event\player\PlayerDeathEvent;

プレイヤーが死んでドロップ(持っていた)したアイテムを取得

$event->getDrops();

プレイヤーが死んでドロップするアイテムを指定

$itema = Item::get(アイテムID, メタデータ, 数);
$itemb = Item::get(アイテムID, メタデータ, 数);
//違うアイテムIDでも変数を増やせば出せます
$item = array($itema, $itemb);//指定したアイテムを配列に格納
$event->setDrops($item);//指定アイテムをドロップ

以下のコードが必要です。

use pocketmine\event\entity\EntityRegainHealthEvent;

$he = new EntityRegainHealthEvent($player, 回復量, EntityRegainHealthEvent::CAUSE_EATING);
$player->heal(回復量, $he);

以下のコードが必要です。

use pocketmine\item\Item;

$item = Item::get(アイテムid, メタデータ, 数);//itemオブジェクトの生成
$player->getInventory()->addItem($item);//アイテムを追加
$player->getInventory()->removeItem($item);//アイテムを消去

$player->getInventory()->clearAll();//アイテムをすべて消去(装備されている防具も消されます)
コードを使う場合はuse pocketmine\inventory\PlayerInventory;が必要(srcによる)

if($player->getInventory()->contains($item)){//特定のアイテムが指定した数以上あるか
    //ある
}else{
    //ない
}
if($player->getInventory()->canAddItem($item)){//アイテムを追加できるかどうか
    //できる
}else{
    //できない
}

以下のコードが必要です。

use pocketmine\item\Item;

$player->getInventory()->setArmorItem(0,Item::get(298,0,1));//ヘルメット
$player->getInventory()->setArmorItem(1,Item::get(299,0,1));//チェストプレート
$player->getInventory()->setArmorItem(2,Item::get(300,0,1));//レギンス
$player->getInventory()->setArmorItem(3,Item::get(301,0,1));//ブーツ
$player->getInventory()->sendArmorContents($player);//防具の変更を反映

以下のコードが必要です。

use pocketmine\math\Vector3;

$vector = new Vector3(x座標, y座標, z座標);//座標を指定
$player->setSpawn($vector);//スポーンをセット

以下のコードが必要です。

use pocketmine\Server;

$players = Server::getInstance()->getOnlinePlayers();
foreach ($players as $player) {
    //処理
}

以下のコードが必要です。

use pocketmine\math\Vector3;

$vector = new Vector3(x座標, y座標, z座標);//座標を指定
$player->teleport($vector);

ワールド(Level)を指定したい場合は座標指定にPositionクラスを指定して下さい

use pokcetmine\level\Position;

$pos = new Position(x座標, y座標, z座標, Levelオブジェクト);//座標を指定
$player->teleport($pos);

EffectIdや効果などはステータス効果に載っています。
※一部対応していないエフェクトがありますので、ご注意下さい。
以下のコードが必要です。

use pocketmine\entity\Effect;

$effect = Effect::getEffect(1);//effectID
$effect->setDuration(30*20);//効果の時間*20
$effect->setAmplifier(0);//効果の強さ
$effect->setVisible(true);//パーティクルを表示するかどうか
$player->addEffect($effect);

1行で書く場合

$player->addEffect(Effect::getEffect(1)->setDuration(30*20)->setAmplifier(0)->setVisible(true));

※EffectIDの指定はEffectクラスのオブジェクト定数で指定することを推奨します。(今後EffectIDが変わる可能性があるため)
例:

Effect::SPEED

$player->removeEffect(1);//指定したEffectIDのエフェクトを除去
$player->removeAllEffects();//すべてのエフェクトを除去

if($player->hasEffect(1)){
 //付与されている場合
}else{
 //されていない場合
}

以下のコードが必要です。

use pocketmine\math\Vector3;

$MotionJ = new Vector3(0,0,0);
$jump = 0.8;//高さ
$MotionJ->y = $jump;
$player->setMotion($MotionJ);//ジャンプ

$MotionA = new Vector3(0,0,0);
$dir=$player->getDirection();//向いている方向
$move = 3;//動かしたいブロック数
if($dir === 0){$MotionA->x=$move;}//南
if($dir === 1){$MotionA->z=$move;}//西
if($dir === 2){$MotionA->x=-$move;}//北
if($dir === 3){$MotionA->z=-$move;}//東
$player->setMotion($MotionA);//動かす

以下のコードが必要です。

use pocketmine\level\Level;
use pocketmine\block\Block;
use pocketmine\math\Vector3;

※$level変数に必ずLevelオブジェクトを入れておいてください

デフォルトで使用されているワールドのレベルオブジェクト取得

$level = $this->getServer()->getDefaultLevel();//Levelオブジェクトの取得

Playerオブジェクトから取得

$level = $player->getLevel();//Levelオブジェクトの取得

ワールド名から取得
以下のコードが必要です。

use pocketmine\use pocketmine\Server;

if(Server::getInstance()->isLevelLoaded("ワールド名")){//レベルオブジェクトかを条件分岐
    $level = Server::getInstance()->getLevelByName("ワールド名");//Levelオブジェクトの取得
}

$this->getServer()->loadLevel("ワールド名");

$this->getServer()->unloadLevel($level);

※ワールド名ではなくレベルオブジェクトを渡してください。
　以前書かれていた情報ではmust be an instance of pocketmine\level\Level, string givenになってしまいます。

$level->save();

Server::getInstance()->generateLevel("ワールド名");

$x = $block->getX();//X座標
$y = $block->getY();//Y座標
$z = $block->getZ();//Z座標

//getX()と同じですがこっちの方が軽いです
$x = $block->x;//X座標
$y = $block->y;//Y座標
$z = $block->z;//Z座標

$block = $level->getBlock($vector); //Blockオブジェクトの取得
$block->getID(); //ブロックID
$block->getMetadata(); //メタ値
$block->getName(); //ブロック名

破壊したい際はブロックidを0にして空気ブロックと置き換えてください

$block = Block::get(ブロックid,メタ値);//Blockオブジェクトの生成
$vector = new Vector3(x座標, y座標, z座標);
$level->setBlock($vector, $block);

以下のコードが必要です。

use pocketmine\item\Item;

$item = Item::get(アイテムid, メタデータ, 数);//itemオブジェクトの生成
$vector = new Vector3(x座標, y座標, z座標);//座標を指定
$level->dropItem($vector,$item);//アイテムをドロップする

以下のコードが必要です。

use pocketmine\level\Explosion;
use pocketmine\level\Position;

$explosion = new Explosion(new Position(x座標, y座標, z座標, $level), 3); //Explosionオブジェクトの生成
$explosion->explode();

以下のコードが必要です。

use pocketmine\tile\Sign;

$pos = new Vector3(X座標, Y座標, Z座標);//座標をセット
$sign = $level->getTile($pos);//Tileオブジェクト取得
if($sign instanceof Sign){//Signオブジェクトかの判定
    $text = $sign->getText();//テキストを取得
}

以下のコードが必要です。

use pocketmine\tile\Sign;

$pos = new Vector3(X座標, Y座標, Z座標);//座標をセット
$sign = $level->getTile($pos);//Tileオブジェクトを取得
if($sign instanceof Sign){//Signオブジェクトかの判定
	$sign->setText("Text1", "Text2", "Text3", "Text4");//文字をセット
	$sign->saveNBT();//データ(NBT)を保存
}

以下のコードが必要です。

use pocketmine\tile\Tile;
use pocketmine\tile\Chest as TileChest;

$pos = new Vector3(X座標, Y座標, Z座標);//座標をセット
$chest = $level->getTile($pos);//Tileオブジェクトを取得
if($chest instanceof TileChest){//TileChestオブジェクトかの判定

	$chest->getInventory()->getItem(1);//特定のスロットのアイテムを取得
        //$itemにはitemオブジェクトを入れておいてください
        $chest->getInventory()->setItem(1, $item);//特定のスロットにアイテムを入れる
        $chest->getInventory()->getContents();//すべてのアイテムを取得
        //$itemにはitemオブジェクトを配列に入れたものを入れてください
        $chest->getInventory()->setContents($item);//アイテムを上書き
	$chest->saveNBT();//データ(NBT)を保存
}

以下のコードが必要です。

use pocketmine\level\sound\(サウンド名)Sound;

$pos = new Vector3(X座標, Y座標, Z座標);//再生する座標
$sound = new <サウンド名>Sound($pos);//サウンドオブジェクトの生成
$level->addSound($sound);//サウンドを再生

以下のコードが必要です。

use pocketmine\level\particle\(パーティクル名)Particle;

$pos = new Vector3(X座標, Y座標, Z座標);//座標
//パーティクルオブジェクトの生成//※一部パーティクルで必要な引数が違う場合があります。クラスなどを参考にして合わせて下さい。
$particle = new <パーティクル名>Particle($pos);
$count = 20;//回数
for($i = 0;$i < $count; ++$i){
    $level->addParticle($particle);
}

以下のコードが必要です。

use pocketmine\utils\Random;

$particle = new <パーティクル名>Particle(new Vector3(X座標, Y座標, Z座標));
$xd = 3 * 100;//調整
$yd = 3 * 100;
$zd = 3 * 100;
$random = new Random((int) (microtime(true) * 1000) + mt_rand());
$count = 25;//回数
for($i = 0; $i < $count; ++$i){
	$particle->setComponents(
		$particle->x + $random->nextSignedFloat() * $xd,
		$particle->y + $random->nextSignedFloat() * $yd,
		$$particle->z + $random->nextSignedFloat() * $zd
	);
	$level->addParticle($particle);
}

以下のすべてのコードに以下のコードを必要なので記載しておいてください。

use pocketmine\utils\Config;

if(!file_exists($this->getDataFolder())){//configを入れるフォルダが有るかチェック
    mkdir($this->getDataFolder(), 0744, true);//なければフォルダを作成
}
//引数1:configファイルまでの場所とconfigファイル名,引数2:configファイルのフォーマット
//引数3:configファイルに入れるデータ
$this->config = new Config($this->getDataFolder() . "config.yml", Config::YAML,
array(
        'test' => 'data',
        'データ名(キー)' => '値'
));

よく分からない方はYAMLのままでいいです

new Config($this->getDataFolder() . "config.properties", Config::PROPERTIES);
new Config($this->getDataFolder() . "config.cnf", Config::CNF);
new Config($this->getDataFolder() . "config.json", Config::JSON);
new Config($this->getDataFolder() . "config.yaml", Config::YAML);
new Config($this->getDataFolder() . "config.serialize", Config::SERIALIZED);
new Config($this->getDataFolder() . "config.enum", Config::ENUM);

$this->config->set("データ名", "値");//値と名前を設定
$this->config->save();//設定を保存

$this->config->get("データ名");//データ名から取得

if($this->config->exists("データ名")){
    //ある
}else{
    //ない
}

plugin.ymlがあるフォルダにresourcesと言うフォルダを作っておく
そこにconfig.ymlファイルを置いておいてください
※resourcesフォルダのconfig.ymlファイルに何も記載されてない場合エラーがでます。
※test:0　でもいいので データ名:値 を書いといてください

$this->saveDefaultConfig();//resourcesにあるconfig.ymlファイルをデータフォルダに入れて保存
$this->reloadConfig();//作成されたファイルを再読み込み
if(!file_exists($this->getDataFolder())){//configファイルを入れるフォルダがあるかを確認
    @mkdir($this->getDataFolder(), 0744, true);//なければフォルダを作成
}
//$this->config変数にConfigオブジェクトを入れておく
$this->config = new Config($this->getDataFolder() . "config.yml", Config::YAML);

※config.yml以外を使用したい場合は以下のコードのようにしてください
※ファイル名にパスなどの記載は要りません。

$this->saveResource("(ファイル名)", false);
$this->reloadConfig();

配列ですべてのデータが返ってきます。

$data = $this->config->getAll();
//キーが欲しい場合は以下のようにしてください(通常は使用しません)
$data = $this->config->getAll(true);

以下のコードが必要です。

use pocketmine\command\Command;
use pocketmine\command\CommandSender;

plugin.ymlファイルに以下のようなコードを追加して置いてください
また説明などを日本語にする場合は文字コードをUTF-8N(BOMなし)で保存してください
plugin.yml

commands:
  testcmd://コマンドこの場合 /testcmdになります
    description: "テスト用のコマンド"//コマンドの説明
    usage: "/testcmd"//使用方法

こちらもplugin.ymlを使います

commands:
  testcmd://コマンド名
    description: "テスト用コマンド"//コマンドの説明
    usage: "/testcmd"//使用方法
    permission: "testcmd.command"//仮名前
permissions:
  testcmd.command://仮名前を入力
    default: op//testcmdをOPのみ使用できるように設定

コマンドを追加して置いてください
以下のコードを使用するとプレイヤーに [testcmd] テスト と言うメッセージが送信されます。
$senderにはコマンドを実行したプレイヤーのオブジェクトが入っています。

public function onCommand(CommandSender $sender, Command $command, $label, array $args) {
	switch (strtolower($command->getName())) {//コマンド名で条件分岐
		case "testcmd"://testcmdコマンドだったら以下の処理
			$sender->sendMessage("[testcmd] テスト");//プレイヤーにメッセージを送信
			return true;//処理を終了
			break;
	}
	//条件に一致しなかった場合処理を終了する
	//plugin.ymlに記載した使用方法がプレイヤーにメッセージとして送信されます。
	return false;
}

$args(配列)にはパラメーターが入っています。
$args[0]にすることでtestの部分を取得できます。
また$args[1]にすると、293の部分も取得できます。
例 /give test 293

public function onCommand(CommandSender $sender, Command $command, $label, array $args) {
	switch (strtolower($command->getName())) {//コマンド名で条件分岐
		case "testcmd"://testcmdコマンドだったら以下の処理
			//$args[0]に値があるかの条件分岐ない場合はここで処理を中断します。
			if(!isset($args[0])) return false;//値がないのに呼び出すと例外になるため例外回避
			$sender->sendMessage("[testcmd] パラメーター1:" . $args[0] . "");//プレイヤーにメッセージを送信
			return true;//処理を終了
			break;
	}
	//条件に一致しなかった場合処理を終了する
	//plugin.ymlに記載した使用方法がプレイヤーにメッセージとして送信されます。
	return false;
}

use pocketmine\item\enchantment\Enchanement;

以上のuseが必要です。

$enchant = Enchantment::getEnchantment(エンチャントID);
$enchant->setLevel(レベル);
$item->addEnchantment($enchant);

$item = Item::get(313,0,1);
$enchant = Enchantment::getEnchantment(7);
$enchant->setLevel(2);
$item->addEnchantment($enchant);
$player->getInventory()->sendArmorContents($player);

$this->getServer()->shutdown();

$this->getServer()->reload();

$this->getServer()->getMotd();//サーバー名を取得
$this->getServer()->getServerName();//getMotd()と同じ
$this->getServer()->getPort();//サーバーのポートを取得
$this->getServer()->hasWhitelist();//ホワイトリストがオンかオフか
$this->getServer()->getSpawnRadius();//ブロック破壊範囲を取得
$this->getServer()->getMaxPlayers();//サーバーに入れる最大人数を取得
$this->getServer()->getAllowFlight();//フライトが許可されているか
$this->getServer()->getGamemode();//デフォルトのゲームモードを取得
$this->getServer()->getDefaultGamemode();//getGamemode()と同じ
$this->getServer()->getForceGamemode();//ログイン時にデフォルトゲームモードに設定がオンかオフか
$this->getServer()->isHardcore();//死んだらBANがオンかオフか
$this->getServer()->getDifficulty();//ゲーム難易度を取得
$this->getServer()->getLevelType();//ワールドのタイプを取得

ops.txtに名前を追加

$this->getServer()->addOp($name);

ops.txtから名前を消去

$this->getServer()->removeOp($name);

white-list.txtに名前を追加

$this->getServer()->addWhitelist($name);

white-list.txtから名前を消去

$this->getServer()->removeWhitelist($name);

white-list.txtをリロードする

$this->getServer()->reloadWhitelist();

恐らく使わないと思いますが、一応。

$id = 0;//entityIdを入れておく
$level = $this->getServer()->getDefaultLevel();//デフォルトのLevelオブジェクトの取得
$entity = $level->getEntity($id);//entityオブジェクト取得

$X = $player->getX(); //X座標を取得
$Y = $player->getY(); //Y座標を取得
$Z = $player->getZ(); //Z座標を取得
 /*$X $Y $Z のままで表示すると小数点がすごい数になるので整数にします (intval関数で整数に変換)*/
$X1 = intval($X);
$Y2 = intval($Y);
$Z3 = intval($Z); 

※NIGHTMARE_3832さんのsrcに限ります。

//$itemにはItemオブジェクトを入れておく
$name = "string";//表示するアイテム名を入れる
$item->setCustomName($name);

srcの一部から取得した情報です。
間違っていたら申し訳ありません。

$this->getServer()->addWhitelist($name);

$this->getServer()->removeWhitelist($name);

$this->getServer()->isWhitelisted($name);

$this->getServer()->setConfigBool("white-list", true);

$this->getServer()->setConfigBool("white-list", false);

$this->getServer()->reloadWhitelist();