AURUMVORAX/PyG2O
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

refactor: Refactorized whole project structure

Browse Source
This commit is contained in:
AURUMVORXX
2025-01-24 22:36:25 +03:00
parent d50f55086b
commit a479b5f85d
321 changed files with 288 additions and 219 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
docs/defaultEvents/anticheat/onPlayerUseCheat.md
View File

@@ -1,21 +0,0 @@
# `event` onPlayerUseCheat
!!! note
Detecting some type of forbidden tools may take, even a few minutes. Server need time to analyze player data.
This event is triggered when player uses some of forbidden cheat tools.
Original: [onPlayerUseCheat](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/anticheat/onPlayerUseCheat/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who used some type of trainer/cheat.
* `int` **type**: the type of used trainer/cheat. For more information see [AntiCheat constants](../../constants/anticheat.md)
## Usage
```python
import g2o
@g2o.event('onPlayerUseCheat')
def onCheat(**kwargs):
print(f'Player {kwargs['playerid']} used forbidden cheat tool type {kwargs['type']}.')
```

30
docs/defaultEvents/general/onBan.md
View File

@@ -1,30 +0,0 @@
# `event` onBan
> [!TIP] This event can be cancelled
!!! note
If serial/mac/ip/name indexes doesn't exist, then the parameters has not been specified when ban was added.
If timestamp doesn't exist, then ban was permanent.
This event is triggered when new ban is being added.
Original: [onBan](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/general/onBan/)
## Parameters
* `dict` **kwargs**:
* `str` **mac**: MAC address of the banned player.
* `str` **ip**: IP address of the banned player.
* `str` **serial**: serial of the banned player.
* `str` **name**: nickname of the banned player.
* `int` **timestamp**: timestamp when the ban expires.
## Usage
```python
import g2o
from datetime import datetime
@g2o.event('onBan')
def onBan(**kwargs):
print(f'Player {kwargs['name']} has been banned.')
if ('timestamp' in kwargs):
banExpires = datetime.fromtimestamp(kwargs['timestamp'])
print(f'Ban expires at {banExpires}')
```

17
docs/defaultEvents/general/onExit.md
View File

@@ -1,17 +0,0 @@
# `event` onExit
This event is triggered when server is going to shut down.
You can use it, to save some data before closing up, or do something else.
Original: [onExit](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/general/onExit/)
## Parameters
No parameters.
## Usage
```python
import g2o
@g2o.event('onExit')
def onExitEvt(**kwargs):
print('Bye')
```

16
docs/defaultEvents/general/onInit.md
View File

@@ -1,16 +0,0 @@
# `event` onInit
This event is triggered when server successfully starts up.
Original: [onExit](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/general/onInit/)
## Parameters
No parameters.
## Usage
```python
import g2o
@g2o.event('onInit')
def onInitEventHandler(**kwargs):
print('Called onInit event')
```

16
docs/defaultEvents/general/onTick.md
View File

@@ -1,16 +0,0 @@
# `event` onTick
This event is triggered in every server main loop iteration.
Original: [onExit](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/general/onTick/)
## Parameters
No parameters.
## Usage
```python
import g2o
@g2o.event('onTick')
def onTickEvt(**kwargs):
print('Tock')
```

22
docs/defaultEvents/general/onTime.md
View File

@@ -1,22 +0,0 @@
# `event` onTime
This event is triggered each time when game time minute passes.
Original: [onExit](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/general/onTime/)
## Parameters
* `dict` **kwargs**:
* `int` **day**: the current ingame day.
* `int` **hour**: the current ingame hour.
* `int` **min**: the current ingame minutes.
## Usage
```python
import g2o
@g2o.event('onTick')
def onTickEvt(**kwargs):
day = kwargs['day']
hour = kwargs['hour']
mins = kwargs['min']
print(f'Current time: Day {day}, Hour {hour}, Min {mins}')
```

26
docs/defaultEvents/general/onUnban.md
View File

@@ -1,26 +0,0 @@
# `event` onUnban
> [!TIP] This event can be cancelled
!!! note
If serial/mac/ip/name indexes doesn't exist, then the parameters has not been specified when ban was added.
If timestamp doesn't exist, then ban was permanent.
This event is triggered when ban with specified info is being removed.
Original: [onExit](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/general/onUnban/)
## Parameters
* `dict` **kwargs**:
* `str` **mac**: MAC address of the banned player.
* `str` **ip**: IP address of the banned player.
* `str` **serial**: serial of the banned player.
* `str` **name**: nickname of the banned player.
* `int` **timestamp**: timestamp when the ban expires.
## Usage
```python
import g2o
@g2o.event('onUnban')
def onUnban(**kwargs):
print(f'Player {kwargs['name']} has been unbanned.')
```

22
docs/defaultEvents/network/onPacket.md
View File

@@ -1,22 +0,0 @@
# `event` onPacket
This event is triggered when new packet arrives from the client.
Original: [onPacket](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/network/onPacket/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who sent the packet.
* `Packet` **data**: data sended over network from client side.
## Usage
```python
import g2o
@g2o.event('onPacket')
def onPacketEvt(**kwargs):
data = kwargs['data']
message = data.readString()
print(f'Got packet from {kwargs['playerid']} (bytes used {data.bytesUsed})')
print(f'Packet says: {message}')
```

21
docs/defaultEvents/npc/onNpcActionFinished.md
View File

@@ -1,21 +0,0 @@
# `event` onNpcActionFinished
This event is triggered when NPC action was finished.
Original: [onNpcActionFinished](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/npc/onNpcActionFinished/)
## Parameters
* `dict` **kwargs**:
* `int` **npc_id**: the npc identifier.
* `int` **action_type**: the action type.
* `int` **action_id**: the unique action identifier.
* `bool` **result**: the result of finished action.
## Usage
```python
import g2o
@g2o.event('onNpcActionFinished')
def onActionFinished(**kwargs):
print(f'NPC {kwargs['npc_id']} finished action {kwargs['action_type']} with the result {kwargs['result']}.')
```

20
docs/defaultEvents/npc/onNpcActionSent.md
View File

@@ -1,20 +0,0 @@
# `event` onNpcActionSent
This event is triggered when NPC host is changed. Every remote NPC is hosted by one of spawned players in order to get valid position of NPC.
Original: [onNpcActionSent](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/npc/onNpcActionSent/)
## Parameters
* `dict` **kwargs**:
* `int` **npc_id**: the npc identifier.
* `int` **current_id**: the action type.
* `int` **previous_id**: the unique action identifier.
## Usage
```python
import g2o
@g2o.event('onNpcActionSent')
def onActionSent(**kwargs):
print(f'NPC {kwargs['npc_id']} changed host from {kwargs['previous_id']} to {kwargs['current_id']}.')
```

20
docs/defaultEvents/npc/onNpcChangeHostPlayer.md
View File

@@ -1,20 +0,0 @@
# `event` onNpcChangeHostPlayer
This event is triggered when server sends NPC action to streamed players.
Original: [onNpcChangeHostPlayer](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/npc/onNpcChangeHostPlayer/)
## Parameters
* `dict` **kwargs**:
* `int` **npc_id**: the id of the remote npc.
* `int` **current_id**: the id of the current host, can be -1 if there is no current host.
* `int` **previous_id**: the id of the previous host, can be -1 if there was no previous host.
## Usage
```python
import g2o
@g2o.event('onNpcChangeHostPlayer')
def onChangeHostPlayer(**kwargs):
print(f'NPC {kwargs['npc_id']} sent {kwargs['action_type']} to all players.')
```

18
docs/defaultEvents/npc/onNpcCreated.md
View File

@@ -1,18 +0,0 @@
# `event` onNpcCreated
This event is triggered when remote NPC is created.
Original: [onNpcCreated](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/npc/onNpcCreated/)
## Parameters
* `dict` **kwargs**:
* `int` **npc_id**: the id of the newly created remote npc.
## Usage
```python
import g2o
@g2o.event('onNpcCreated')
def onNpcCreate(**kwargs):
print(f'NPC {kwargs['npc_id']} has been created.')
```

18
docs/defaultEvents/npc/onNpcDestroyed.md
View File

@@ -1,18 +0,0 @@
# `event` onNpcDestroyed
This event is triggered when remote NPC is created.
Original: [onNpcDestroyed](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/npc/onNpcDestroyed/)
## Parameters
* `dict` **kwargs**:
* `int` **npc_id**: the id of the destroyed remote npc.
## Usage
```python
import g2o
@g2o.event('onNpcDestroyed')
def onNpcDestroy(**kwargs):
print(f'NPC {kwargs['npc_id']} has been destroyed.')
```

25
docs/defaultEvents/player/onPlayerChangeColor.md
View File

@@ -1,25 +0,0 @@
# `event` onPlayerChangeColor
This event is triggered when player nickname color was changed for all players.
Original: [onPlayerChangeColor](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeColor/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player whose nickname color was changed.
* `int` **r**: the amount of red in the nickname color `(0 - 255)`.
* `int` **g**: the amount of green in the nickname color `(0 - 255)`.
* `int` **b**: the amount of blue in the nickname color `(0 - 255)`.
## Usage
```python
import g2o
@g2o.event('onPlayerChangeColor')
def onChangeColor(**kwargs):
# Slicing out playerid and converting from {r: num, g: num, b: num}
# to (num, num, num)
rgbColor = tuple(list(kwargs.values())[1:])
# Formating rgb into hex color
hexColor = '#%02x%02x%02x' % rgbColor
print(f'Player {kwargs['playerid']} changed his color to {hexColor}')
```

23
docs/defaultEvents/player/onPlayerChangeFocus.md
View File

@@ -1,23 +0,0 @@
# `event` onPlayerChangeFocus
This event is triggered when player targets another player.
Original: [onPlayerChangeFocus](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeFocus/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player which changes the focus.
* `int` **oldFocusId**: the old playerid targeted by the player. Can be `-1` if player wasn't targeting other player.
* `int` **newFocusId**: the new playerid targeted by the player. Can be `-1` if player doesn't target anyone.
## Usage
```python
import g2o
@g2o.event('onPlayerChangeFocus')
def onChangeFocus(**kwargs):
focusId = kwargs['newFocusId']
if focusId != -1:
print(f'Player {kwargs['playerid']} is looking at {focusId}')
else
print(f'Player {kwargs['playerid']} is looking at... who?')
```

19
docs/defaultEvents/player/onPlayerChangeHealth.md
View File

@@ -1,19 +0,0 @@
# `event` onPlayerChangeHealth
This event is triggered when player health changes.
Original: [onPlayerChangeHealth](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeHealth/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player whose health points gets changed.
* `int` **oldHP**: the previous health points of the player.
* `int` **newHP**: the new health points of the player.
## Usage
```python
import g2o
@g2o.event('onPlayerChangeHealth')
def onChangeHealth(**kwargs):
print(f'Player {kwargs['playerid']} changed health: {kwargs['oldHP']} -> {kwargs['newHP']}')
```

19
docs/defaultEvents/player/onPlayerChangeMana.md
View File

@@ -1,19 +0,0 @@
# `event` onPlayerChangeMana
This event is triggered when player mana changes.
Original: [onPlayerChangeMana](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeMana/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player mana points gets changed.
* `int` **oldMP**: the previous mana points of the player.
* `int` **newMP**: the new mana points of the player.
## Usage
```python
import g2o
@g2o.event('onPlayerChangeMana')
def onChangeMana(**kwargs):
print(f'Player {kwargs['playerid']} changed mana: {kwargs['oldMP']} -> {kwargs['newMP']}')
```

19
docs/defaultEvents/player/onPlayerChangeMaxHealth.md
View File

@@ -1,19 +0,0 @@
# `event` onPlayerChangeMaxHealth
This event is triggered when player maximum health changes.
Original: [onPlayerChangeMaxHealth](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeMaxHealth/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player whose maxium health points gets changed.
* `int` **oldMaxHP**: the previous maximum health points of the player.
* `int` **newMaxHP**: the new maximum health points of the player.
## Usage
```python
import g2o
@g2o.event('onPlayerChangeMaxHealth')
def onChangeMaxHealth(**kwargs):
print(f'Player {kwargs['playerid']} changed maximum health: {kwargs['oldMaxHP']} -> {kwargs['newMaxHP']}')
```

19
docs/defaultEvents/player/onPlayerChangeMaxMana.md
View File

@@ -1,19 +0,0 @@
# `event` onPlayerChangeMaxMana
This event is triggered when player maximum mana changes.
Original: [onPlayerChangeMaxMana](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeMaxMana/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player maximum mana points gets changed.
* `int` **oldMaxMP**: the previous maximum mana points of the player.
* `int` **newMaxMP**: the new maximum mana points of the player.
## Usage
```python
import g2o
@g2o.event('onPlayerChangeMaxMana')
def onChangeMaxMana(**kwargs):
print(f'Player {kwargs['playerid']} changed maximum mana: {kwargs['oldMaxMP']} -> {kwargs['newMaxMP']}')
```

19
docs/defaultEvents/player/onPlayerChangeWeaponMode.md
View File

@@ -1,19 +0,0 @@
# `event` onPlayerChangeWeaponMode
This event is triggered when player changes the weapon mode.
Original: [onPlayerChangeWeaponMode](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeWeaponMode/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player which changes the weapon mode.
* `int` **oldWeaponMode**: the old weapon mode which was used by the player. For more information see [Weapon mode](../../constants/weapon-mode.md).
* `int` **newWeaponMode**: the new weapon mode in which player is currently using. For more information see [Weapon mode](../../constants/weapon-mode.md).
## Usage
```python
import g2o
@g2o.event('onPlayerChangeWeaponMode')
def onChangeWM(**kwargs):
print(f'Player {kwargs['playerid']} changed wm: {kwargs['oldWeaponMode']} -> {kwargs['newWeaponMode']}')
```

20
docs/defaultEvents/player/onPlayerChangeWorld.md
View File

@@ -1,20 +0,0 @@
# `event` onPlayerChangeWorld
> [!TIP] This event can be cancelled
This event is triggered when player tries to change his currently played world (ZEN).
Original: [onPlayerChangeWorld](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerChangeWorld/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who tries to change the played world.
* `str` **world**: a filename name of the world.
* `str` **waypoint**: a name of the waypoint that the player will be teleported to.
## Usage
```python
import g2o
@g2o.event('onPlayerChangeWorld')
def onChangeWorld(**kwargs):
print(f'Player {kwargs['playerid']} teleported to {kwargs['world']} at {kwargs['waypoint']}')
```

24
docs/defaultEvents/player/onPlayerCommand.md
View File

@@ -1,24 +0,0 @@
# `event` onPlayerCommand
This event is triggered when a player uses command on the chat.
Command always begins with forward slash `/`.
Original: [onPlayerCommand](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerCommand/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who typed the command.
* `str` **command**: used command name on the chat.
* `str` **params**: command parameters divided by space.
## Usage
```python
import g2o
@g2o.event('onPlayerCommand')
def onCommand(**kwargs):
# Spliting and formating params
params = [eval(x) if not x.isalpha() else x for kwargs['params'].split()]
if kwargs['command'] == 'add' and len(params) == 2:
print('Sum is: ', params[0] + params[1]) # /add 5 10 -> output: Sum is 15
```

21
docs/defaultEvents/player/onPlayerDamage.md
View File

@@ -1,21 +0,0 @@
# `event` onPlayerDamage
> [!TIP] This event can be cancelled
This event is triggered when player receives damage.
Original: [onPlayerDamage](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerDamage/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who died.
* `int` **killerid**: the id of the killer. If killerid is set to `-1`, it means that there was no killer. In this particular case damage source can be fall from a tall object or scripts.
* `DamageDescription` **description**: a structure containing damage information. For more information see [DamageDescription](../../classes/game/DamageDescription.md)
## Usage
```python
import g2o
@g2o.event('onPlayerDamage')
def onDamage(**kwargs):
desc = kwargs['description']
print(f'Ouch! Player {kwargs['playerid']} just received {desc.damage} damage.')
```

18
docs/defaultEvents/player/onPlayerDead.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerDead
This event is triggered when one player kills another player.
Original: [onPlayerDead](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerDead/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who died.
* `int` **killerid**: the id of the player who killed other player. If killerid is set to `-1`, it means that there was no killer.
## Usage
```python
import g2o
@g2o.event('onPlayerDead')
def onDead(**kwargs):
print(kwargs['playerid'], 'killed by', kwargs['killerid'])
```

18
docs/defaultEvents/player/onPlayerDisconnect.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerDisconnect
This event is triggered when a player gets disconnected with the server.
Original: [onPlayerDisconnect](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerDisconnect/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: he id of the player who disconnected from the server.
* `int` **reason**: the reason why player got disconnected. For more information see [Network](../../constants/network.md).
## Usage
```python
import g2o
@g2o.event('onPlayerDisconnect')
def onDC(**kwargs):
print(f'Player {kwargs['playerid']} has left from the server')
```

20
docs/defaultEvents/player/onPlayerDropItem.md
View File

@@ -1,20 +0,0 @@
# `event` onPlayerDropItem
> [!TIP] This event can be cancelled
This event is triggered when player drops an item from his inventory to the ground.
Original: [onPlayerDropItem](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerDropItem/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who tries to drop the item on the ground.
* `ItemGround` **itemGround**: the ground item object which represents the dropped item by the player.
## Usage
```python
import g2o
@g2o.event('onPlayerDropItem')
def onDropItem(**kwargs):
item = itemm['itemGround']
print(f'Player {kwargs['playerid']} dropped {item.instance} x{item.amount}')
```

18
docs/defaultEvents/player/onPlayerEnterWorld.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEnterWorld
This event is triggered when player entered the world (**ZEN**) and was successfully spawned in it.
Original: [onPlayerEnterWorld](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEnterWorld/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who entered the world.
* `str` **world**: an filename name of the world.
## Usage
```python
import g2o
@g2o.event('onPlayerEnterWorld')
def onEnterWorld(**kwargs):
print(f'Player {kwargs['playerid']} entered world {kwargs['world']}')
```

18
docs/defaultEvents/player/onPlayerEquipAmulet.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEquipAmulet
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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipAmulet')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}')
```

18
docs/defaultEvents/player/onPlayerEquipArmor.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEquipAmulet
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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipArmor')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}')
```

18
docs/defaultEvents/player/onPlayerEquipBelt.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEquipBelt
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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipBelt')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}')
```

19
docs/defaultEvents/player/onPlayerEquipHandItem.md
View File

@@ -1,19 +0,0 @@
# `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, empty `str` is returned instead.
Original: [onPlayerEquipHandItem](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerEquipHandItem/)
## Parameters
* `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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipHandItem')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} has {kwargs['instance']}, used hand with id {kwargs['hand']}')
```

18
docs/defaultEvents/player/onPlayerEquipHelmet.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEquipHelmet
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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipHelmet')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}')
```

18
docs/defaultEvents/player/onPlayerEquipMeleeWeapon.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEquipMeleeWeapon
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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipMeleeWeapon')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}')
```

18
docs/defaultEvents/player/onPlayerEquipRangedWeapon.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEquipRangedWeapon
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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipRangedWeapon')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}')
```

19
docs/defaultEvents/player/onPlayerEquipRing.md
View File

@@ -1,19 +0,0 @@
# `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 g2o
@g2o.event('onPlayerEquipRing')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} has {kwargs['instance']}, used hand with id {kwargs['hand']}')
```

18
docs/defaultEvents/player/onPlayerEquipShield.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerEquipShield
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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerEquipShield')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}')
```

19
docs/defaultEvents/player/onPlayerEquipSpell.md
View File

@@ -1,19 +0,0 @@
# `event` onPlayerEquipSpell
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/)
## Parameters
* `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` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerSpell')
def onEquip(**kwargs):
print(f'Player {kwargs['playerid']} equipped spell {kwargs['instance']} at slot {kwargs['slotId']}')
```

17
docs/defaultEvents/player/onPlayerJoin.md
View File

@@ -1,17 +0,0 @@
# `event` onPlayerJoin
This event is triggered when a player successfully joined the server.
Original: [onPlayerJoin](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerJoin/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who joined the server.
## Usage
```python
import g2o
@g2o.event('onPlayerJoin')
def onJoin(**kwargs):
print(kwargs['playerid'], 'joined to the server.')
```

18
docs/defaultEvents/player/onPlayerMessage.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerMessage
This event is triggered when a player types the message on the chat.
Original: [onPlayerMessage](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerMessage/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who typed the message.
* `str` **message**: the message typed by the player.
## Usage
```python
import g2o
@g2o.event('onPlayerMessage')
def onMessage(**kwargs):
print(kwargs['playerid'], 'says', kwargs['message'])
```

19
docs/defaultEvents/player/onPlayerMobInteract.md
View File

@@ -1,19 +0,0 @@
# `event` onPlayerMobInteract
This event is triggered when player interacts with any kind of mob object in the world. In Gothic, mobs are special vobs on the map, that hero can interact with. For example bed, door, chest etc.
Original: [onPlayerMobInteract](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerMobInteract/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: represents previous state of mob. If value is `1`, then mob was used, in any other case value is `0`.
* `int` **from**: represents current state of mob. If value is `1`, then mob is used, in any other case value is `0`.
## Usage
```python
import g2o
@g2o.event('onPlayerMobInteract')
def onMobInteract(**kwargs):
if kwargs['to'] == 1:
print(kwargs['playerid'], 'started interaction with the MOB')
```

17
docs/defaultEvents/player/onPlayerRespawn.md
View File

@@ -1,17 +0,0 @@
# `event` onPlayerRespawn
This event is triggered when a player respawns after death.
Original: [onPlayerRespawn](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerRespawn/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who respawned after death.
## Usage
```python
import g2o
@g2o.event('onPlayerRespawn')
def onRespawn(**kwargs):
print(kwargs['playerid'], 'respawned.')
```

18
docs/defaultEvents/player/onPlayerShoot.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerShoot
This event is triggered when player shoot using ranged weapon.
Original: [onPlayerShoot](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerShoot/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who just shot.
* `str | null` **munition**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerShoot')
def onShoot(**kwargs):
print(kwargs['playerid'], 'made a shot.')
```

23
docs/defaultEvents/player/onPlayerSpellCast.md
View File

@@ -1,23 +0,0 @@
# `event` onPlayerSpellCast
> [!TIP] This event can be cancelled
!!! note
Right now transformation and summon spells are not supported, despite this event will be triggered for them. Cancelling this event willl prevent this action to be synced to other players.
This event is triggered when player is casting some spell.
Original: [onPlayerSpellCast](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerSpellCast/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who casts the spell.
* `str | null` **instance**: the item instance from Daedalus scripts.
* `int` **spellLevel**: the level of charged spell.
## Usage
```python
import g2o
@g2o.event('onPlayerSpellCast')
def onSpellCast(**kwargs):
print(kwargs['player'], 'casted a spell', kwargs['instance'])
```

18
docs/defaultEvents/player/onPlayerSpellSetup.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerSpellSetup
This event is triggered when player prepares the spell.
Original: [onPlayerSpellSetup](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerSpellSetup/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who prepares the spell.
* `str | null` **instance**: the item instance from Daedalus scripts.
## Usage
```python
import g2o
@g2o.event('onPlayerSpellSetup')
def onSpellSetup(**kwargs):
print(kwargs['player'], 'setuped a spell', kwargs['instance'])
```

23
docs/defaultEvents/player/onPlayerTakeItem.md
View File

@@ -1,23 +0,0 @@
# `event` onPlayerTakeItem
> [!TIP] This event can be cancelled
!!! note
Even if this event is triggered it doesn't mean, that player will get item to his inventory. It only means, that the player tried to get the item from the ground. Server is the last decide if the item can be taken from the ground. Canceling this event will prevent the item to be taken from the ground.
This event is triggered when player takes an item from the ground.
Original: [onPlayerTakeItem](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerTakeItem/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who tries to take the ground item.
* `ItemGround` **itemGround**: the ground item object which player tried to to take.
## Usage
```python
import g2o
@g2o.event('onPlayerTakeItem')
def onTakeItem(**kwargs):
item = itemm['itemGround']
print(f'Player {kwargs['playerid']} took {item.instance} x{item.amount}')
```

18
docs/defaultEvents/player/onPlayerTeleport.md
View File

@@ -1,18 +0,0 @@
# `event` onPlayerTeleport
This event is triggered when player gets teleported by the game to the specified vob.
Original: [onPlayerTeleport](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerTeleport/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who gets teleported by the game.
* `str` **vobName**: represents the name of the vob that player gets teleported to.
## Usage
```python
import g2o
@g2o.event('onPlayerTeleport')
def onTeleport(**kwargs):
print(kwargs['player'], 'teleported to', kwargs['vobName'])
```

20
docs/defaultEvents/player/onPlayerToggleFaceAni.md
View File

@@ -1,20 +0,0 @@
# `event` onPlayerTeleport
This event is triggered when player face animation is toggled (played or stopped), due to eating or other activities.
Original: [onPlayerToggleFaceAni](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/server-events/player/onPlayerToggleFaceAni/)
## Parameters
* `dict` **kwargs**:
* `int` **playerid**: the id of the player who gets teleported by the game.
* `str` **aniName**: the face animation name.
* `bool` **toggle**: `true` when player is started playing face animation, otherwise `false`.
## Usage
```python
import g2o
@g2o.event('onPlayerToggleFaceAni')
def onToggleFA(**kwargs):
if kwargs['toggle']:
print(kwargs['player'], 'started face ani',kwargs['aniName'])
```