docs: Added ItemGround class
This commit is contained in:
3
docs/classes/item/ItemGround.md
Normal file
3
docs/classes/item/ItemGround.md
Normal file
@@ -0,0 +1,3 @@
|
||||
# `class` ItemGround
|
||||
---
|
||||
::: g2o.items.ItemGround
|
||||
29
g2o/items.py
29
g2o/items.py
@@ -1,13 +1,42 @@
|
||||
import sqg2o
|
||||
|
||||
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):
|
||||
return super().__init__()
|
||||
|
||||
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()
|
||||
|
||||
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()
|
||||
|
||||
@property
|
||||
|
||||
@@ -18,6 +18,8 @@ nav:
|
||||
- How to use: index.md
|
||||
- QnA: qna.md
|
||||
- Classes:
|
||||
- Item:
|
||||
- ItemGround: classes/item/ItemGround.md
|
||||
- Network:
|
||||
- Packet: classes/network/Packet.md
|
||||
- Constants:
|
||||
@@ -56,6 +58,7 @@ nav:
|
||||
- onPlayerCommand: defaultEvents/player/onPlayerCommand.md
|
||||
- onPlayerDead: defaultEvents/player/onPlayerDead.md
|
||||
- onPlayerDisconnect: defaultEvents/player/onPlayerDisconnect.md
|
||||
- onPlayerDropItem: defaultEvents/player/onPlayerDropItem.md
|
||||
- onPlayerEnterWorld: defaultEvents/player/onPlayerEnterWorld.md
|
||||
- onPlayerEquipAmulet: defaultEvents/player/onPlayerEquipAmulet.md
|
||||
- onPlayerEquipArmor: defaultEvents/player/onPlayerEquipArmor.md
|
||||
@@ -74,6 +77,7 @@ nav:
|
||||
- onPlayerShoot: defaultEvents/player/onPlayerShoot.md
|
||||
- onPlayerSpellCast: defaultEvents/player/onPlayerSpellCast.md
|
||||
- onPlayerSpellSetup: defaultEvents/player/onPlayerSpellSetup.md
|
||||
- onPlayerTakeItem: defaultEvents/player/onPlayerTakeItem.md
|
||||
- onPlayerTeleport: defaultEvents/player/onPlayerTeleport.md
|
||||
- onPlayerToggleFaceAni: defaultEvents/player/onPlayerToggleFaceAni.md
|
||||
- Functions:
|
||||
|
||||
Reference in New Issue
Block a user