docs: Updated docs for 2.0.0 version
This commit is contained in:
19
docs/defaultEvents/player/onPlayerEquipRing.md
Normal file
19
docs/defaultEvents/player/onPlayerEquipRing.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# `event` onPlayerEquipRing
|
||||
This event is triggered when player equips or unequips ring. When item is unequiped, empty `str` is returned instead.
|
||||
|
||||
Original: [onPlayerEquipRing](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipRing/)
|
||||
|
||||
## Parameters
|
||||
* `dict` **kwargs**:
|
||||
* `int` **playerid**: the id of the player who equips a ring.
|
||||
* `int` **hand**: the hand id that the player is putting the ring on. For more information see [Hand](../../constants/hand.md).
|
||||
* `str` **instance**: the item instance from Daedalus scripts.
|
||||
|
||||
## Usage
|
||||
```python
|
||||
import pyg2o as g2o
|
||||
|
||||
@g2o.event('onPlayerEquipRing')
|
||||
async def onEquip(playerid, hand, instance):
|
||||
print(f'Player {playerid} equipped {instance}')
|
||||
```
|
||||
Reference in New Issue
Block a user