py2hackCraft2 1.0.17__tar.gz → 1.0.19__tar.gz

{py2hackcraft2-1.0.17 → py2hackcraft2-1.0.19}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2hackCraft2
-Version: 1.0.17
+Version: 1.0.19
 Summary: These are APIs that connect to the hackCraft2 server from Python to manipulate pets.
 Home-page: https://pypi.org/project/py2hackCraft2/
 Author: Masafumi Terazono

{py2hackcraft2-1.0.17 → py2hackcraft2-1.0.19}/README.md

@@ -10,3 +10,7 @@ build:
 deploy:
     <command>
     twine upload --repository-url https://upload.pypi.org/legacy/ dist/* -u "__token__"
+
+doc:
+    <command>
+    make html

{py2hackcraft2-1.0.17 → py2hackcraft2-1.0.19}/py2hackCraft/modules.py

@@ -154,12 +154,24 @@ class _WebSocketClient:
         self.send(json.dumps(message))
 
 class Coordinates:
+    """
+    座標の基準を表すデータクラス
+    """
     world = ""
     relative = "~"
     local = "^"
 
 @dataclass
 class Location:
+    """
+    座標を表すデータクラス。
+
+    Attributes:
+        x (str): X座標。
+        y (str): Y座標。
+        z (str): Z座標。
+        world (str): ワールド名。
+    """
     x: int
     y: int
     z: int
@@ -167,6 +179,22 @@ class Location:
 
 @dataclass
 class InteractEvent:
+    """
+    クリックイベントを表すデータクラス。
+
+    Attributes:
+        action (str): アクションの名前。
+        player (str): クリックしたプレイヤー名。
+        player_uuid (str): クリックしたプレイヤーの一意の識別子（UUID）。
+        event (str): アイテムに設定されている名前。
+        name (str): ブロックあるいはエンティティーの名前
+        type (str): ブロックあるいはエンティティーの種類。
+        data (int): ブロックのデータ値。
+        world (str): ブロックあるいはエンティティーのいたワールド名。
+        x (int): クリックした場所のワールドにおけるX座標。
+        y (int): クリックした場所のワールドにおけるY座標。
+        z (int): クリックした場所のワールドにおけるZ座標。
+    """
     action: str
     player: str
     player_uuid: str
@@ -588,6 +616,20 @@ class Entity:
         self.client.sendCall(self.uuid, "placeX", [x, y, z, cord, side, block])
         return str_to_bool(self.client.result)
 
+    def placeHere(self, x: int, y: int, z: int, block=None, side=None) -> bool :
+        """
+        自分を中心に指定した座標にブロックを設置する。
+
+        Args:
+            x (int): X座標。
+            y (int): Y座標。
+            z (int): Z座標。
+            block (str): 設置するブロックの種類。
+            side (str): 設置する面。
+        """
+        self.client.sendCall(self.uuid, "placeX", [x, y, z, "^", side, block])
+        return str_to_bool(self.client.result)
+
     def place(self, side=None) -> bool :
         """
         自分の前方にブロックを設置する。
@@ -609,6 +651,31 @@ class Entity:
         self.client.sendCall(self.uuid, "placeDown")
         return str_to_bool(self.client.result, [side])
 
+    def useItemX(self, cord: Coordinates, x: int, y: int, z: int) -> bool :
+        """
+        指定した座標にアイテムを使う
+
+        Args:
+            cord (Coordinates): 座標の種類（'', '^', '~'）。        
+            x (int): X座標。
+            y (int): Y座標。
+            z (int): Z座標。
+        """
+        self.client.sendCall(self.uuid, "useItemX", [x, y, z, cord])
+        return str_to_bool(self.client.result)
+
+    def useItemHere(self, x: int, y: int, z: int) -> bool :
+        """
+        自分を中心に指定した座標にアイテムを使う
+
+        Args:
+            x (int): X座標。
+            y (int): Y座標。
+            z (int): Z座標。
+        """
+        self.client.sendCall(self.uuid, "useItemX", [x, y, z, "^"])
+        return str_to_bool(self.client.result)
+
     def useItem(self) -> bool :
         """
         自分の前方にアイテムを使う
@@ -630,19 +697,6 @@ class Entity:
         self.client.sendCall(self.uuid, "useItemDown")
         return str_to_bool(self.client.result)
 
-    def useItemX(self, cord: Coordinates, x: int, y: int, z: int) -> bool :
-        """
-        指定した座標にアイテムを使う
-
-        Args:
-            cord (Coordinates): 座標の種類（'', '^', '~'）。        
-            x (int): X座標。
-            y (int): Y座標。
-            z (int): Z座標。
-        """
-        self.client.sendCall(self.uuid, "useItemX", [x, y, z, cord])
-        return str_to_bool(self.client.result)
-
     def harvest(self) -> bool :
         """
         自分の位置のブロックを収穫する。
@@ -790,6 +844,21 @@ class Entity:
         block = Block(** json.loads(self.client.result))
         return block
 
+    def inspectHere(self, x: int, y: int, z: int) -> Block :
+        """
+        自分を中心に指定された座標のブロックを調べる。
+
+        Args:
+            x (int): X座標。
+            y (int): Y座標。
+            z (int): Z座標。
+        Returns:
+            Block: 調べたブロックの情報。    
+        """
+        self.client.sendCall(self.uuid, "inspect", [x, y, z, "^"])
+        block = Block(** json.loads(self.client.result))
+        return block
+
     def inspect(self) -> Block :
         """
         自分のいる場所のブロックを調べる。
@@ -868,6 +937,34 @@ class Entity:
         self.client.sendCall(self.uuid, "isBlockedDown")
         return str_to_bool(self.client.result)
 
+
+    def canDig(self) -> bool :
+        """
+        自分の前方のブロックが壊せるかどうか調べる。
+        Returns:
+            bool: 調べた結果。    
+        """
+        self.client.sendCall(self.uuid, "isCanDigFront")
+        return str_to_bool(self.client.result)
+
+    def canDigUp(self) -> bool :
+        """
+        自分の上のブロックが壊せるかどうか調べる。
+        Returns:
+            bool: 調べた結果。    
+        """
+        self.client.sendCall(self.uuid, "isCanDigUp")
+        return str_to_bool(self.client.result)
+
+    def canDigDown(self) -> bool :
+        """
+        自分の下のブロックが壊せるかどうか調べる。
+        Returns:
+            bool: 調べた結果。    
+        """
+        self.client.sendCall(self.uuid, "isCanDigDown")
+        return str_to_bool(self.client.result)
+
     def lookAtTarget(self, uuid) -> bool:
         """
         指定されたエンティティを見る。
@@ -909,7 +1006,7 @@ class Entity:
 
     def setBlock(self, cord: Coordinates, x: int, y: int, z: int, block: str, data: int = 0):
         """
-        指定された座標にブロックを設置する。
+        指定された座標にブロックを設置する。（クリエイティブ）
 
         Args:
             cord (Coordinates): 座標の種類（'', '^', '~'）。

{py2hackcraft2-1.0.17 → py2hackcraft2-1.0.19}/py2hackCraft2.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: py2hackCraft2
-Version: 1.0.17
+Version: 1.0.19
 Summary: These are APIs that connect to the hackCraft2 server from Python to manipulate pets.
 Home-page: https://pypi.org/project/py2hackCraft2/
 Author: Masafumi Terazono

{py2hackcraft2-1.0.17 → py2hackcraft2-1.0.19}/setup.py

@@ -5,7 +5,7 @@ long_description = (this_directory / "py2hackCraft/README.md").read_text()
 
 setup(
     name="py2hackCraft2",
-    version="1.0.17",
+    version="1.0.19",
     packages=find_packages(),
     install_requires=[
         "websocket-client"  # websocketライブラリの追加