docs(event): begin the event doc

KomodoPlatform · Oct 15, 2019 · b4753da · b4753da
1 parent ffc9196
commit b4753da
Show file tree

Hide file tree

Showing 6 changed files with 51 additions and 2 deletions.
diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt
@@ -64,6 +64,7 @@ add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
         ${CMAKE_CURRENT_SOURCE_DIR}/source/api/core.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/api/config.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/api/ecs.rst
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/api/event.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/modules/core.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/modules/config.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/modules/modules.rst
@@ -82,6 +83,7 @@ add_custom_command(OUTPUT ${SPHINX_INDEX_FILE}
         ${CMAKE_CURRENT_SOURCE_DIR}/source/modules/math.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/tutorials.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/ecs.rst
+        ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/event.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/getting_started.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/basic_setup.rst
         ${CMAKE_CURRENT_SOURCE_DIR}/source/tutorials/quick_and_dirty.rst

diff --git a/docs/source/api/api_index.rst b/docs/source/api/api_index.rst
@@ -8,4 +8,5 @@ Antara Gaming API documentation
 
    config
    core
-   ecs
+   ecs
+   event
diff --git a/docs/source/api/event.rst b/docs/source/api/event.rst
@@ -0,0 +1,2 @@
+antara::gaming::event
+=====================
diff --git a/docs/source/modules/event.rst b/docs/source/modules/event.rst
@@ -2,3 +2,44 @@
 
 antara::event module documentation
 ==================================
+
+This module contains all the utility events you can find in a game, below the list of events provided by the SDK for you:
+
+.. list-table:: Modules Tables
+   :header-rows: 1
+   :align: center
+
+   * - Name
+     - Description
+   * - key_pressed
+     - This event is triggered when you press a key on your keyboard, (it's blocking)
+   * - key_released
+     - This event is triggered when you release a key on your keyboard, (it's blocking)
+   * - quit_game
+     - Exit the current game with a given return value of the program
+   * - window_resized
+     - This internally managed event is fired when the window is resize
+   * - mouse_moved
+     - This event is triggered when you move the mouse
+   * - mouse_button_pressed
+     - This event is triggered when you press a button of your mouse or trackpad
+   * - mouse_button_released
+     - This event is triggered when you release a button of your mouse or trackpad
+
+How do the events works ?
+--------------------------
+
+Internally we use the EnTT_ library which has an event dispatcher, The documentation can be found here_.
+
+.. _EnTT: https://github.com/skypjack/entt
+.. _here: https://github.com/skypjack/entt/wiki/Crash-Course:-events,-signals-and-everything-in-between#event-dispatcher
+
+Tutorial Related to Events in Antara SDK
+-----------------------------------------
+
+:doc:`Click here to access events tutorials<../tutorials/event>`
+
+API antara::event
+-------------------------
+
+:doc:`Click here to access antara::event API<../api/event>`
diff --git a/docs/source/tutorials/event.rst b/docs/source/tutorials/event.rst
@@ -0,0 +1,2 @@
+Tutorial: Antara Gaming Events
+===============================
diff --git a/docs/source/tutorials/tutorials.rst b/docs/source/tutorials/tutorials.rst
@@ -8,4 +8,5 @@ Antara Gaming Tutorials
 
    getting_started
    quick_and_dirty
-   ecs
+   ecs
+   event
-Original file line number
+Diff line change
@@ Expand Up / @@ -8,4 +8,5 @@ Antara Gaming API documentation @@
        config
        core
-       ecs
+       ecs
+       event
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		Tutorial: Antara Gaming Events
		===============================