From 558e607c5f75549f46a6684b62d1b66eed418905 Mon Sep 17 00:00:00 2001 From: AURUMVORXX Date: Mon, 4 Nov 2024 19:09:49 +0300 Subject: [PATCH] docs: Added docs about onPlayer** events --- docs/defaultEvents/{ => general}/onBan.md | 2 + docs/defaultEvents/{ => general}/onExit.md | 2 + docs/defaultEvents/{ => general}/onInit.md | 2 + docs/defaultEvents/{ => general}/onTick.md | 2 + docs/defaultEvents/{ => general}/onTime.md | 2 + docs/defaultEvents/{ => general}/onUnban.md | 2 + .../player/onPlayerChangeColor.md | 25 +++++++++++ .../player/onPlayerChangeFocus.md | 23 ++++++++++ .../player/onPlayerChangeHealth.md | 19 ++++++++ .../player/onPlayerChangeMana.md | 19 ++++++++ .../player/onPlayerChangeMaxHealth.md | 19 ++++++++ .../player/onPlayerChangeMaxMana.md | 19 ++++++++ .../player/onPlayerChangeWeaponMode.md | 19 ++++++++ .../player/onPlayerChangeWorld.md | 19 ++++++++ docs/defaultEvents/player/onPlayerCommand.md | 24 ++++++++++ docs/defaultEvents/player/onPlayerDead.md | 18 ++++++++ .../player/onPlayerDisconnect.md | 18 ++++++++ .../player/onPlayerEnterWorld.md | 18 ++++++++ .../player/onPlayerEquipAmulet.md | 18 ++++++++ .../player/onPlayerEquipArmor.md | 18 ++++++++ .../defaultEvents/player/onPlayerEquipBelt.md | 18 ++++++++ .../player/onPlayerEquipHandItem.md | 19 ++++++++ .../player/onPlayerEquipHelmet.md | 18 ++++++++ .../player/onPlayerEquipMeleeWeapon.md | 18 ++++++++ .../player/onPlayerEquipRangedWeapon.md | 18 ++++++++ .../defaultEvents/player/onPlayerEquipRing.md | 19 ++++++++ .../player/onPlayerEquipShield.md | 18 ++++++++ .../player/onPlayerEquipSpell.md | 19 ++++++++ docs/defaultEvents/player/onPlayerJoin.md | 17 +++++++ docs/defaultEvents/player/onPlayerMessage.md | 18 ++++++++ .../player/onPlayerMobInteract.md | 19 ++++++++ docs/defaultEvents/player/onPlayerRespawn.md | 17 +++++++ docs/defaultEvents/player/onPlayerShoot.md | 18 ++++++++ .../defaultEvents/player/onPlayerSpellCast.md | 21 +++++++++ .../player/onPlayerSpellSetup.md | 18 ++++++++ docs/defaultEvents/player/onPlayerTeleport.md | 18 ++++++++ .../player/onPlayerToggleFaceAni.md | 20 +++++++++ mkdocs.yml | 44 ++++++++++++++++--- 38 files changed, 639 insertions(+), 6 deletions(-) rename docs/defaultEvents/{ => general}/onBan.md (88%) rename docs/defaultEvents/{ => general}/onExit.md (70%) rename docs/defaultEvents/{ => general}/onInit.md (66%) rename docs/defaultEvents/{ => general}/onTick.md (64%) rename docs/defaultEvents/{ => general}/onTime.md (80%) rename docs/defaultEvents/{ => general}/onUnban.md (85%) create mode 100644 docs/defaultEvents/player/onPlayerChangeColor.md create mode 100644 docs/defaultEvents/player/onPlayerChangeFocus.md create mode 100644 docs/defaultEvents/player/onPlayerChangeHealth.md create mode 100644 docs/defaultEvents/player/onPlayerChangeMana.md create mode 100644 docs/defaultEvents/player/onPlayerChangeMaxHealth.md create mode 100644 docs/defaultEvents/player/onPlayerChangeMaxMana.md create mode 100644 docs/defaultEvents/player/onPlayerChangeWeaponMode.md create mode 100644 docs/defaultEvents/player/onPlayerChangeWorld.md create mode 100644 docs/defaultEvents/player/onPlayerCommand.md create mode 100644 docs/defaultEvents/player/onPlayerDead.md create mode 100644 docs/defaultEvents/player/onPlayerDisconnect.md create mode 100644 docs/defaultEvents/player/onPlayerEnterWorld.md create mode 100644 docs/defaultEvents/player/onPlayerEquipAmulet.md create mode 100644 docs/defaultEvents/player/onPlayerEquipArmor.md create mode 100644 docs/defaultEvents/player/onPlayerEquipBelt.md create mode 100644 docs/defaultEvents/player/onPlayerEquipHandItem.md create mode 100644 docs/defaultEvents/player/onPlayerEquipHelmet.md create mode 100644 docs/defaultEvents/player/onPlayerEquipMeleeWeapon.md create mode 100644 docs/defaultEvents/player/onPlayerEquipRangedWeapon.md create mode 100644 docs/defaultEvents/player/onPlayerEquipRing.md create mode 100644 docs/defaultEvents/player/onPlayerEquipShield.md create mode 100644 docs/defaultEvents/player/onPlayerEquipSpell.md create mode 100644 docs/defaultEvents/player/onPlayerJoin.md create mode 100644 docs/defaultEvents/player/onPlayerMessage.md create mode 100644 docs/defaultEvents/player/onPlayerMobInteract.md create mode 100644 docs/defaultEvents/player/onPlayerRespawn.md create mode 100644 docs/defaultEvents/player/onPlayerShoot.md create mode 100644 docs/defaultEvents/player/onPlayerSpellCast.md create mode 100644 docs/defaultEvents/player/onPlayerSpellSetup.md create mode 100644 docs/defaultEvents/player/onPlayerTeleport.md create mode 100644 docs/defaultEvents/player/onPlayerToggleFaceAni.md diff --git a/docs/defaultEvents/onBan.md b/docs/defaultEvents/general/onBan.md similarity index 88% rename from docs/defaultEvents/onBan.md rename to docs/defaultEvents/general/onBan.md index 4593f39..7c8ee99 100644 --- a/docs/defaultEvents/onBan.md +++ b/docs/defaultEvents/general/onBan.md @@ -5,6 +5,8 @@ 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. diff --git a/docs/defaultEvents/onExit.md b/docs/defaultEvents/general/onExit.md similarity index 70% rename from docs/defaultEvents/onExit.md rename to docs/defaultEvents/general/onExit.md index a52b53f..c0690c0 100644 --- a/docs/defaultEvents/onExit.md +++ b/docs/defaultEvents/general/onExit.md @@ -2,6 +2,8 @@ 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. diff --git a/docs/defaultEvents/onInit.md b/docs/defaultEvents/general/onInit.md similarity index 66% rename from docs/defaultEvents/onInit.md rename to docs/defaultEvents/general/onInit.md index 775edd1..1434dad 100644 --- a/docs/defaultEvents/onInit.md +++ b/docs/defaultEvents/general/onInit.md @@ -1,6 +1,8 @@ # `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. diff --git a/docs/defaultEvents/onTick.md b/docs/defaultEvents/general/onTick.md similarity index 64% rename from docs/defaultEvents/onTick.md rename to docs/defaultEvents/general/onTick.md index 9f843ac..f73a90a 100644 --- a/docs/defaultEvents/onTick.md +++ b/docs/defaultEvents/general/onTick.md @@ -1,6 +1,8 @@ # `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. diff --git a/docs/defaultEvents/onTime.md b/docs/defaultEvents/general/onTime.md similarity index 80% rename from docs/defaultEvents/onTime.md rename to docs/defaultEvents/general/onTime.md index fe63a81..4f21a22 100644 --- a/docs/defaultEvents/onTime.md +++ b/docs/defaultEvents/general/onTime.md @@ -1,6 +1,8 @@ # `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. diff --git a/docs/defaultEvents/onUnban.md b/docs/defaultEvents/general/onUnban.md similarity index 85% rename from docs/defaultEvents/onUnban.md rename to docs/defaultEvents/general/onUnban.md index 2b6192f..16644bb 100644 --- a/docs/defaultEvents/onUnban.md +++ b/docs/defaultEvents/general/onUnban.md @@ -5,6 +5,8 @@ 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. diff --git a/docs/defaultEvents/player/onPlayerChangeColor.md b/docs/defaultEvents/player/onPlayerChangeColor.md new file mode 100644 index 0000000..7017fc5 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeColor.md @@ -0,0 +1,25 @@ +# `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}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerChangeFocus.md b/docs/defaultEvents/player/onPlayerChangeFocus.md new file mode 100644 index 0000000..ef6dfbf --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeFocus.md @@ -0,0 +1,23 @@ +# `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?') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerChangeHealth.md b/docs/defaultEvents/player/onPlayerChangeHealth.md new file mode 100644 index 0000000..250bca1 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeHealth.md @@ -0,0 +1,19 @@ +# `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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerChangeMana.md b/docs/defaultEvents/player/onPlayerChangeMana.md new file mode 100644 index 0000000..c53c01d --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeMana.md @@ -0,0 +1,19 @@ +# `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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerChangeMaxHealth.md b/docs/defaultEvents/player/onPlayerChangeMaxHealth.md new file mode 100644 index 0000000..33b8024 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeMaxHealth.md @@ -0,0 +1,19 @@ +# `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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerChangeMaxMana.md b/docs/defaultEvents/player/onPlayerChangeMaxMana.md new file mode 100644 index 0000000..e68ffc0 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeMaxMana.md @@ -0,0 +1,19 @@ +# `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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerChangeWeaponMode.md b/docs/defaultEvents/player/onPlayerChangeWeaponMode.md new file mode 100644 index 0000000..5b71f87 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeWeaponMode.md @@ -0,0 +1,19 @@ +# `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 **TBD**. + * `int` **newWeaponMode**: the new weapon mode in which player is currently using. For more information see **TBD**. + +## Usage +```python +import g2o + +@g2o.event('onPlayerChangeWeaponMode') +def onChangeWM(**kwargs): + print(f'Player {kwargs['playerid']} changed wm: {kwargs['oldWeaponMode']} -> {kwargs['newWeaponMode']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerChangeWorld.md b/docs/defaultEvents/player/onPlayerChangeWorld.md new file mode 100644 index 0000000..83961db --- /dev/null +++ b/docs/defaultEvents/player/onPlayerChangeWorld.md @@ -0,0 +1,19 @@ +# `event` onPlayerChangeWorld +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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerCommand.md b/docs/defaultEvents/player/onPlayerCommand.md new file mode 100644 index 0000000..c1977ff --- /dev/null +++ b/docs/defaultEvents/player/onPlayerCommand.md @@ -0,0 +1,24 @@ +# `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 +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerDead.md b/docs/defaultEvents/player/onPlayerDead.md new file mode 100644 index 0000000..1805ddc --- /dev/null +++ b/docs/defaultEvents/player/onPlayerDead.md @@ -0,0 +1,18 @@ +# `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']) +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerDisconnect.md b/docs/defaultEvents/player/onPlayerDisconnect.md new file mode 100644 index 0000000..2048c8a --- /dev/null +++ b/docs/defaultEvents/player/onPlayerDisconnect.md @@ -0,0 +1,18 @@ +# `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 **TBD**. + +## Usage +```python +import g2o + +@g2o.event('onPlayerDisconnect') +def onChangeDC(**kwargs): + print(f'Player {kwargs['playerid']} has left from the server') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEnterWorld.md b/docs/defaultEvents/player/onPlayerEnterWorld.md new file mode 100644 index 0000000..23c9c09 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEnterWorld.md @@ -0,0 +1,18 @@ +# `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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipAmulet.md b/docs/defaultEvents/player/onPlayerEquipAmulet.md new file mode 100644 index 0000000..6b5f5c8 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipAmulet.md @@ -0,0 +1,18 @@ +# `event` onPlayerEquipAmulet +This event is triggered when player equips or unequips amulet. When item is unequiped, `null` 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerEquipAmulet') +def onEquip(**kwargs): + print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipArmor.md b/docs/defaultEvents/player/onPlayerEquipArmor.md new file mode 100644 index 0000000..1730268 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipArmor.md @@ -0,0 +1,18 @@ +# `event` onPlayerEquipAmulet +This event is triggered when player equips or unequips armor. When item is unequiped, `null` 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerEquipArmor') +def onEquip(**kwargs): + print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipBelt.md b/docs/defaultEvents/player/onPlayerEquipBelt.md new file mode 100644 index 0000000..876b358 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipBelt.md @@ -0,0 +1,18 @@ +# `event` onPlayerEquipBelt +This event is triggered when player equips or unequips belt. When item is unequiped, `null` 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerEquipBelt') +def onEquip(**kwargs): + print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipHandItem.md b/docs/defaultEvents/player/onPlayerEquipHandItem.md new file mode 100644 index 0000000..d5407a8 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipHandItem.md @@ -0,0 +1,19 @@ +# `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. + +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 **TBD**. + * `str` **str | null**: 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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipHelmet.md b/docs/defaultEvents/player/onPlayerEquipHelmet.md new file mode 100644 index 0000000..76ba016 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipHelmet.md @@ -0,0 +1,18 @@ +# `event` onPlayerEquipHelmet +This event is triggered when player equips or unequips helmet. When item is unequiped, `null` 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerEquipHelmet') +def onEquip(**kwargs): + print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipMeleeWeapon.md b/docs/defaultEvents/player/onPlayerEquipMeleeWeapon.md new file mode 100644 index 0000000..9678b34 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipMeleeWeapon.md @@ -0,0 +1,18 @@ +# `event` onPlayerEquipMeleeWeapon +This event is triggered when player equips or unequips melee weapon. When item is unequiped, `null` 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerEquipMeleeWeapon') +def onEquip(**kwargs): + print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipRangedWeapon.md b/docs/defaultEvents/player/onPlayerEquipRangedWeapon.md new file mode 100644 index 0000000..3402707 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipRangedWeapon.md @@ -0,0 +1,18 @@ +# `event` onPlayerEquipRangedWeapon +This event is triggered when player equips or unequips ranged weapon. When item is unequiped, `null` 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerEquipRangedWeapon') +def onEquip(**kwargs): + print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipRing.md b/docs/defaultEvents/player/onPlayerEquipRing.md new file mode 100644 index 0000000..1d8438b --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipRing.md @@ -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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipShield.md b/docs/defaultEvents/player/onPlayerEquipShield.md new file mode 100644 index 0000000..3f7755a --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipShield.md @@ -0,0 +1,18 @@ +# `event` onPlayerEquipShield +This event is triggered when player equips or unequips shield. When item is unequiped, `null` 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerEquipShield') +def onEquip(**kwargs): + print(f'Player {kwargs['playerid']} equipped {kwargs['instance']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerEquipSpell.md b/docs/defaultEvents/player/onPlayerEquipSpell.md new file mode 100644 index 0000000..abf9d36 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerEquipSpell.md @@ -0,0 +1,19 @@ +# `event` onPlayerEquipSpell +This event is triggered when player equips or unequips scroll or rune. When item is unequiped, `null` 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` **str | null**: 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']}') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerJoin.md b/docs/defaultEvents/player/onPlayerJoin.md new file mode 100644 index 0000000..db1ff15 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerJoin.md @@ -0,0 +1,17 @@ +# `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.') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerMessage.md b/docs/defaultEvents/player/onPlayerMessage.md new file mode 100644 index 0000000..a94cf0b --- /dev/null +++ b/docs/defaultEvents/player/onPlayerMessage.md @@ -0,0 +1,18 @@ +# `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']) +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerMobInteract.md b/docs/defaultEvents/player/onPlayerMobInteract.md new file mode 100644 index 0000000..c8e28d1 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerMobInteract.md @@ -0,0 +1,19 @@ +# `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') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerRespawn.md b/docs/defaultEvents/player/onPlayerRespawn.md new file mode 100644 index 0000000..a8f0656 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerRespawn.md @@ -0,0 +1,17 @@ +# `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.') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerShoot.md b/docs/defaultEvents/player/onPlayerShoot.md new file mode 100644 index 0000000..eac507c --- /dev/null +++ b/docs/defaultEvents/player/onPlayerShoot.md @@ -0,0 +1,18 @@ +# `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.') +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerSpellCast.md b/docs/defaultEvents/player/onPlayerSpellCast.md new file mode 100644 index 0000000..aeb5ef7 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerSpellCast.md @@ -0,0 +1,21 @@ +# `event` onPlayerSpellCast +!!! 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. + +## Usage +```python +import g2o + +@g2o.event('onPlayerSpellCast') +def onSpellCast(**kwargs): + print(kwargs['player'], 'casted a spell', kwargs['instance']) +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerSpellSetup.md b/docs/defaultEvents/player/onPlayerSpellSetup.md new file mode 100644 index 0000000..5afaccb --- /dev/null +++ b/docs/defaultEvents/player/onPlayerSpellSetup.md @@ -0,0 +1,18 @@ +# `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']) +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerTeleport.md b/docs/defaultEvents/player/onPlayerTeleport.md new file mode 100644 index 0000000..3a7a91f --- /dev/null +++ b/docs/defaultEvents/player/onPlayerTeleport.md @@ -0,0 +1,18 @@ +# `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']) +``` \ No newline at end of file diff --git a/docs/defaultEvents/player/onPlayerToggleFaceAni.md b/docs/defaultEvents/player/onPlayerToggleFaceAni.md new file mode 100644 index 0000000..702e1b9 --- /dev/null +++ b/docs/defaultEvents/player/onPlayerToggleFaceAni.md @@ -0,0 +1,20 @@ +# `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']) +``` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 71f51a8..9dced9d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -19,12 +19,44 @@ nav: - QnA: qna.md - Events: - General: - - onInit: defaultEvents/onInit.md - - onExit: defaultEvents/onExit.md - - onTick: defaultEvents/onTick.md - - onTime: defaultEvents/onTime.md - - onBan: defaultEvents/onBan.md - - onUnban: defaultEvents/onUnban.md + - onInit: defaultEvents/general/onInit.md + - onExit: defaultEvents/general/onExit.md + - onTick: defaultEvents/general/onTick.md + - onTime: defaultEvents/general/onTime.md + - onBan: defaultEvents/general/onBan.md + - onUnban: defaultEvents/general/onUnban.md + - Player: + - onPlayerChangeColor: defaultEvents/player/onPlayerChangeColor.md + - onPlayerChangeFocus: defaultEvents/player/onPlayerChangeFocus.md + - onPlayerChangeHealth: defaultEvents/player/onPlayerChangeHealth.md + - onPlayerChangeMana: defaultEvents/player/onPlayerChangeMana.md + - onPlayerChangeMaxHealth: defaultEvents/player/onPlayerChangeMaxHealth.md + - onPlayerChangeMaxMana: defaultEvents/player/onPlayerChangeMaxMana.md + - onPlayerChangeWeaponMode: defaultEvents/player/onPlayerChangeWeaponMode.md + - onPlayerChangeWorld: defaultEvents/player/onPlayerChangeWorld.md + - onPlayerCommand: defaultEvents/player/onPlayerCommand.md + - onPlayerDead: defaultEvents/player/onPlayerDead.md + - onPlayerDisconnect: defaultEvents/player/onPlayerDisconnect.md + - onPlayerEnterWorld: defaultEvents/player/onPlayerEnterWorld.md + - onPlayerEquipAmulet: defaultEvents/player/onPlayerEquipAmulet.md + - onPlayerEquipArmor: defaultEvents/player/onPlayerEquipArmor.md + - onPlayerEquipBelt: defaultEvents/player/onPlayerEquipBelt.md + - onPlayerEquipHandItem: defaultEvents/player/onPlayerEquipHandItem.md + - onPlayerEquipHelmet: defaultEvents/player/onPlayerEquipHelmet.md + - onPlayerEquipMeleeWeapon: defaultEvents/player/onPlayerEquipMeleeWeapon.md + - onPlayerEquipRangedWeapon: defaultEvents/player/onPlayerEquipRangedWeapon.md + - onPlayerEquipRing: defaultEvents/player/onPlayerEquipRing.md + - onPlayerEquipShield: defaultEvents/player/onPlayerEquipShield.md + - onPlayerEquipSpell: defaultEvents/player/onPlayerEquipSpell.md + - onPlayerJoin: defaultEvents/player/onPlayerJoin.md + - onPlayerMessage: defaultEvents/player/onPlayerMessage.md + - onPlayerMobInteract: defaultEvents/player/onPlayerMobInteract.md + - onPlayerRespawn: defaultEvents/player/onPlayerRespawn.md + - onPlayerShoot: defaultEvents/player/onPlayerShoot.md + - onPlayerSpellCast: defaultEvents/player/onPlayerSpellCast.md + - onPlayerSpellSetup: defaultEvents/player/onPlayerSpellSetup.md + - onPlayerTeleport: defaultEvents/player/onPlayerTeleport.md + - onPlayerToggleFaceAni: defaultEvents/player/onPlayerToggleFaceAni.md - Functions: - Events: - event: events/event.md