docs: Added onPlayerUseCheat and NPC related events

This commit is contained in:
AURUMVORXX
2024-11-06 11:49:08 +03:00
parent d54bd06fef
commit f6fd5893a4
7 changed files with 126 additions and 0 deletions

View File

@@ -0,0 +1,21 @@
# `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']}.')
```

View File

@@ -0,0 +1,20 @@
# `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']}.')
```

View File

@@ -0,0 +1,20 @@
# `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.')
```

View File

@@ -0,0 +1,18 @@
# `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.')
```

View File

@@ -0,0 +1,18 @@
# `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.')
```