docs: Added ItemGround class

This commit is contained in:
AURUMVORXX
2024-11-06 11:18:38 +03:00
parent 5f2273c448
commit fa24d77ea6
3 changed files with 36 additions and 0 deletions

View File

@@ -0,0 +1,3 @@
# `class` ItemGround
---
::: g2o.items.ItemGround

View File

@@ -1,13 +1,42 @@
import sqg2o import sqg2o
class ItemGround(sqg2o.ItemGround): class ItemGround(sqg2o.ItemGround):
"""
This class represents item on the ground.
Original: [ItemGround](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-classes/item/ItemGround//)
## `int` id *(read-only)*
Represents the unique id of the item ground.
## `string` instance *(read-only)*
Represents the item instance of the item ground.
## `int` amount *(read-only)*
Represents the item amount of item ground.
## `string` world *(read-only)*
Represents the item ground world (.ZEN file path).
## `int` virtualWorld
Represents the virtual world of item ground.
"""
def __init__(self): def __init__(self):
return super().__init__() return super().__init__()
def getPosition() -> tuple: def getPosition() -> tuple:
"""
This method will get the item ground position on the world.
**Returns `tuple(float, float, float)`:**
`X-Y-Z` item ground position on the world.
"""
return super().getPosition() return super().getPosition()
def getRotation() -> tuple: def getRotation() -> tuple:
"""
This method will get the item ground rotation on the world.
**Returns `tuple(float, float, float)`:**
`X-Y-Z` item ground roration on the world.
"""
return super().getRotation() return super().getRotation()
@property @property

View File

@@ -18,6 +18,8 @@ nav:
- How to use: index.md - How to use: index.md
- QnA: qna.md - QnA: qna.md
- Classes: - Classes:
- Item:
- ItemGround: classes/item/ItemGround.md
- Network: - Network:
- Packet: classes/network/Packet.md - Packet: classes/network/Packet.md
- Constants: - Constants:
@@ -56,6 +58,7 @@ nav:
- onPlayerCommand: defaultEvents/player/onPlayerCommand.md - onPlayerCommand: defaultEvents/player/onPlayerCommand.md
- onPlayerDead: defaultEvents/player/onPlayerDead.md - onPlayerDead: defaultEvents/player/onPlayerDead.md
- onPlayerDisconnect: defaultEvents/player/onPlayerDisconnect.md - onPlayerDisconnect: defaultEvents/player/onPlayerDisconnect.md
- onPlayerDropItem: defaultEvents/player/onPlayerDropItem.md
- onPlayerEnterWorld: defaultEvents/player/onPlayerEnterWorld.md - onPlayerEnterWorld: defaultEvents/player/onPlayerEnterWorld.md
- onPlayerEquipAmulet: defaultEvents/player/onPlayerEquipAmulet.md - onPlayerEquipAmulet: defaultEvents/player/onPlayerEquipAmulet.md
- onPlayerEquipArmor: defaultEvents/player/onPlayerEquipArmor.md - onPlayerEquipArmor: defaultEvents/player/onPlayerEquipArmor.md
@@ -74,6 +77,7 @@ nav:
- onPlayerShoot: defaultEvents/player/onPlayerShoot.md - onPlayerShoot: defaultEvents/player/onPlayerShoot.md
- onPlayerSpellCast: defaultEvents/player/onPlayerSpellCast.md - onPlayerSpellCast: defaultEvents/player/onPlayerSpellCast.md
- onPlayerSpellSetup: defaultEvents/player/onPlayerSpellSetup.md - onPlayerSpellSetup: defaultEvents/player/onPlayerSpellSetup.md
- onPlayerTakeItem: defaultEvents/player/onPlayerTakeItem.md
- onPlayerTeleport: defaultEvents/player/onPlayerTeleport.md - onPlayerTeleport: defaultEvents/player/onPlayerTeleport.md
- onPlayerToggleFaceAni: defaultEvents/player/onPlayerToggleFaceAni.md - onPlayerToggleFaceAni: defaultEvents/player/onPlayerToggleFaceAni.md
- Functions: - Functions: