docs: Added docs about onPlayer** events
This commit is contained in:
18
docs/defaultEvents/player/onPlayerTeleport.md
Normal file
18
docs/defaultEvents/player/onPlayerTeleport.md
Normal file
@@ -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'])
|
||||
```
|
||||
Reference in New Issue
Block a user