docs: Updated docs for 2.0.0 version
This commit is contained in:
30
docs/defaultEvents/general/onBan.md
Normal file
30
docs/defaultEvents/general/onBan.md
Normal file
@@ -0,0 +1,30 @@
|
||||
# `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 pyg2o as g2o
|
||||
from datetime import datetime
|
||||
|
||||
@g2o.event('onBan')
|
||||
async def onBan(banInfo):
|
||||
print(f'Player {banInfo['name']} has been banned.')
|
||||
if ('timestamp' in banInfo):
|
||||
banExpires = datetime.fromtimestamp(banInfo['timestamp'])
|
||||
print(f'Ban expires at {banExpires}')
|
||||
```
|
||||
17
docs/defaultEvents/general/onExit.md
Normal file
17
docs/defaultEvents/general/onExit.md
Normal file
@@ -0,0 +1,17 @@
|
||||
# `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 pyg2o as g2o
|
||||
|
||||
@g2o.event('onExit')
|
||||
async def onExitEvt():
|
||||
print('Bye')
|
||||
```
|
||||
16
docs/defaultEvents/general/onInit.md
Normal file
16
docs/defaultEvents/general/onInit.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# `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 pyg2o as g2o
|
||||
|
||||
@g2o.event('onInit')
|
||||
async def onInitEventHandler():
|
||||
print('Called onInit event')
|
||||
```
|
||||
16
docs/defaultEvents/general/onTick.md
Normal file
16
docs/defaultEvents/general/onTick.md
Normal file
@@ -0,0 +1,16 @@
|
||||
# `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 pyg2o as g2o
|
||||
|
||||
@g2o.event('onTick')
|
||||
async def onTickEvt():
|
||||
print('Tock')
|
||||
```
|
||||
19
docs/defaultEvents/general/onTime.md
Normal file
19
docs/defaultEvents/general/onTime.md
Normal file
@@ -0,0 +1,19 @@
|
||||
# `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 pyg2o as g2o
|
||||
|
||||
@g2o.event('onTime')
|
||||
async def onTickEvt(day, hour, min):
|
||||
print(f'Current time: Day {day}, Hour {hour}, Min {mins}')
|
||||
```
|
||||
26
docs/defaultEvents/general/onUnban.md
Normal file
26
docs/defaultEvents/general/onUnban.md
Normal file
@@ -0,0 +1,26 @@
|
||||
# `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 pyg2o as g2o
|
||||
|
||||
@g2o.event('onUnban')
|
||||
async def onUnban(banInfo):
|
||||
print(f'Player {banInfo['name']} has been unbanned.')
|
||||
```
|
||||
Reference in New Issue
Block a user