From 11fd12bf57e8ab28131983724273956db25f1ab1 Mon Sep 17 00:00:00 2001
From: AURUMVORXX <aurumvorax.enthroned@gmail.com>
Date: Thu, 7 Nov 2024 12:03:34 +0300
Subject: [PATCH] docs: Added docs for toggleEvent and removeEvent functions

---
 docs/classes/item/ItemGround.md |  2 +-
 docs/comparing.md               |  6 ++--
 docs/events/removeEvent.md      |  2 ++
 docs/events/toggleEvent.md      |  2 ++
 g2o/events.py                   | 50 +++++++++++++++++++++++++++++++++
 mkdocs.yml                      |  8 ++++--
 6 files changed, 64 insertions(+), 6 deletions(-)
 create mode 100644 docs/events/removeEvent.md
 create mode 100644 docs/events/toggleEvent.md

diff --git a/docs/classes/item/ItemGround.md b/docs/classes/item/ItemGround.md
index aa85949..f2716ad 100644
--- a/docs/classes/item/ItemGround.md
+++ b/docs/classes/item/ItemGround.md
@@ -1,3 +1,3 @@
-# `class` ItemGround
+# `static class` ItemGround
 ---
 ::: g2o.classes.items.ItemGround
\ No newline at end of file
diff --git a/docs/comparing.md b/docs/comparing.md
index ab01c24..89065f8 100644
--- a/docs/comparing.md
+++ b/docs/comparing.md
@@ -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)
-```
\ No newline at end of file
+```
+---
+* `eventValue` has been removed (RIP)
\ No newline at end of file
diff --git a/docs/events/removeEvent.md b/docs/events/removeEvent.md
new file mode 100644
index 0000000..355756a
--- /dev/null
+++ b/docs/events/removeEvent.md
@@ -0,0 +1,2 @@
+# `function` removeEvent
+::: g2o.events.removeEvent
\ No newline at end of file
diff --git a/docs/events/toggleEvent.md b/docs/events/toggleEvent.md
new file mode 100644
index 0000000..3f04a0f
--- /dev/null
+++ b/docs/events/toggleEvent.md
@@ -0,0 +1,2 @@
+# `function` toggleEvent
+::: g2o.events.toggleEvent
\ No newline at end of file
diff --git a/g2o/events.py b/g2o/events.py
index 2767aed..d19305b 100644
--- a/g2o/events.py
+++ b/g2o/events.py
@@ -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)
 
diff --git a/mkdocs.yml b/mkdocs.yml
index 2030467..bb85a48 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -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: