docs: Added docs about onPlayer** events
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, `null` item id 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 **TBD**.
|
||||
* `str` **str | null**: instance: the item instance from Daedalus scripts.
|
||||
|
||||
## Usage
|
||||
```python
|
||||
import g2o
|
||||
|
||||
@g2o.event('onPlayerEquipRing')
|
||||
def onEquip(**kwargs):
|
||||
print(f'Player {kwargs['playerid']} has {kwargs['instance']}, used hand with id {kwargs['hand']}')
|
||||
```
|
||||
Reference in New Issue
Block a user