docs: Added docs for toggleEvent and removeEvent functions

This commit is contained in:
AURUMVORXX
2024-11-07 12:03:34 +03:00
parent df9675d67b
commit 11fd12bf57
6 changed files with 64 additions and 6 deletions

View File

@@ -1,3 +1,3 @@
# `class` ItemGround
# `static class` ItemGround
---
::: g2o.classes.items.ItemGround

View File

@@ -42,10 +42,12 @@ def evtTake(**kwargs):
return False
```
---
* `isEventCancelled` replaced with built-in function property `cancelled`, alongside with the `eventName` (if you need it for some reason)
* `isEventCancelled` replaced with built-in function property `cancelled`, alongside with the `eventName`
```python
@g2o.event('onPlayerDropItem')
def evtDrop(**kwargs):
print(evtDrop.cancelled)
print(evtDrop.eventName)
```
```
---
* `eventValue` has been removed (RIP)

View File

@@ -0,0 +1,2 @@
# `function` removeEvent
::: g2o.events.removeEvent

View File

@@ -0,0 +1,2 @@
# `function` toggleEvent
::: g2o.events.toggleEvent

View File

@@ -132,12 +132,62 @@ def removeEventHandler(name : str, func : object):
del eventList[name][index]
def toggleEvent(name : str, toggle : bool):
'''
!!! note
By default every event is toggled `on` (enabled).
This function will toggle event (enable or disable it globally). By toggling event off, you can completely disable certain event from calling it's handlers.
Original: [toggleEvent](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/event/toggleEvent/)
## Declaration
```python
def toggleEvent(name : str, toggle : bool)
```
## Parameters
* `str` **name**: the name of the event
* `bool` **toggle**: `false` if you want to disable the event, otherwise true.
## Usage
```python
import g2o
@g2o.event('onTime')
def onTimeEvt(**kwargs):
print('Calling only once')
g2o.toggleEvent('onTime', false)
```
'''
if not toggle and name not in disabledEventList:
disabledEventList.append(name)
elif toggle and name in disabledEventList:
disabledEventList.remove(name)
def removeEvent(name : str):
'''
!!! warning
Removing an event also cause all event handlers to unregister.
This function will unregister an event with specified name.
Original: [removeEvent](https://gothicmultiplayerteam.gitlab.io/docs/0.3.0/script-reference/shared-functions/event/removeEvent/)
## Declaration
```python
def removeEvent(name : str)
```
## Parameters
* `str` **name**: the name of the event
## Usage
```python
import g2o
@g2o.event('onTime')
def onTimeEvt(**kwargs):
print('Calling only once')
g2o.removeEvent('onTime')
```
'''
if name in eventList:
eventList.pop(name)

View File

@@ -93,11 +93,13 @@ nav:
- onPlayerTeleport: defaultEvents/player/onPlayerTeleport.md
- onPlayerToggleFaceAni: defaultEvents/player/onPlayerToggleFaceAni.md
- Functions:
- Events:
- event: events/event.md
- removeEventHandler: events/removeEventHandler.md
- Events:
- addEvent: events/addEvent.md
- event: events/event.md
- callEvent: events/callEvent.md
- removeEvent: events/removeEvent.md
- removeEventHandler: events/removeEventHandler.md
- toggleEvent: events/toggleEvent.md
- How to build: howtobuild.md
theme: