feat: Added python binding to all functions

+ added docs to all functions
This commit is contained in:
AURUMVORXX
2024-11-09 20:16:25 +03:00
parent c561368b4f
commit ae0889e927
162 changed files with 2725 additions and 51 deletions

View File

@@ -1,12 +1,12 @@
# `event` onPlayerEquipAmulet
This event is triggered when player equips or unequips amulet. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips amulet. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipAmulet](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipAmulet/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips a amulet.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,12 +1,12 @@
# `event` onPlayerEquipAmulet
This event is triggered when player equips or unequips armor. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips armor. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipArmor](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipArmor/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips an armor.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,12 +1,12 @@
# `event` onPlayerEquipBelt
This event is triggered when player equips or unequips belt. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips belt. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipBelt](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipBelt/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips a belt.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,5 +1,5 @@
# `event` onPlayerEquipHandItem
This event is triggered when game adds item to player hand, e.g: when player opens or consumes any item. When item is removed from hand, `null` is returned instead.
This event is triggered when game adds item to player hand, e.g: when player opens or consumes any item. When item is removed from hand, empty `str` is returned instead.
Original: [onPlayerEquipHandItem](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipHandItem/)
@@ -7,7 +7,7 @@ Original: [onPlayerEquipHandItem](https://gothicmultiplayerteam.gitlab.io/docs/0
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who gets an item to his hand.
* `int` **hand**: the id of the hand in which player holds item. For more information see [Hand](../../constants/hand.md).
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,12 +1,12 @@
# `event` onPlayerEquipHelmet
This event is triggered when player equips or unequips helmet. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips helmet. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipHelmet](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipHelmet/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips a helmet.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,12 +1,12 @@
# `event` onPlayerEquipMeleeWeapon
This event is triggered when player equips or unequips melee weapon. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips melee weapon. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipMeleeWeapon](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipMeleeWeapon/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips an melee weapon.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,12 +1,12 @@
# `event` onPlayerEquipRangedWeapon
This event is triggered when player equips or unequips ranged weapon. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips ranged weapon. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipRangedWeapon](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipRangedWeapon/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips an ranged weapon.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,5 +1,5 @@
# `event` onPlayerEquipRing
This event is triggered when player equips or unequips ring. When item is unequiped, `null` item id is returned instead.
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/)
@@ -7,7 +7,7 @@ Original: [onPlayerEquipRing](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0
* `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` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,12 +1,12 @@
# `event` onPlayerEquipShield
This event is triggered when player equips or unequips shield. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips shield. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipShield](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipShield/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips a shield.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python

View File

@@ -1,5 +1,5 @@
# `event` onPlayerEquipSpell
This event is triggered when player equips or unequips scroll or rune. When item is unequiped, `null` is returned instead.
This event is triggered when player equips or unequips scroll or rune. When item is unequiped, empty `str` is returned instead.
Original: [onPlayerEquipSpell](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipSpell/)
@@ -7,7 +7,7 @@ Original: [onPlayerEquipSpell](https://gothicmultiplayerteam.gitlab.io/docs/0.3.
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who equips a spell.
* `int` **slotId**: the slot id that the player puts the spell on in range `<0, 6>`.
* `str` **str | null**: instance: the item instance from Daedalus scripts.
* `str` **instance**: the item instance from Daedalus scripts.
## Usage
```python