Updated documentations

Author: Gesee-y

docs/3-BasicApp.md

@@ -31,7 +31,7 @@ julia> app = CruiseApp()
 You can now define a game loop using the `@gameloop` macro:
 
 ```julia
-julia> @gameloop max_fps=60 app begin
+julia> @gameloop max_fps=60 begin
            println("delta seconds: $(LOOP_VAR.delta_seconds)")
            # Simulate a 10-second delay before shutting down
            LOOP_VAR.frame_idx > 600 && shutdown!()

docs/API.md

@@ -3,6 +3,7 @@
 ```
 CruiseApp
 @gameloop
+@gamelogic
 awake!
 update!
 shutdown!
@@ -17,6 +18,8 @@ add_system!
 add_dependency!
 remove_system!
 remove_dependency!
+enable_system
+disable_system
 merge_plugin!
 getdep
 isinitialized

docs/Plugins/index.md

@@ -130,6 +130,19 @@ end
 
 Errors during update! are caught automatically and set the node status to PLUGIN_ERR.
 
+---
+
+## Enabling/Disabling systems
+
+A system can be made active or inactive with the functions
+
+```
+enable_system(plugin, sys_id, awake=true) # awake is whether or not `awake!` should be called on the system
+disable_system(plugin, sys_id, shut=false) # shut is whether or not `shutdown!` should be called on the system
+```
+
+A disabled system will no more run but still be in the graph and can be reactivated.
+The benefits of this is that we can add or remove logic without modifying the graph and recomputing the topological order.
 
 ---
 

docs/events.md

@@ -32,7 +32,7 @@ Now we will connect a function to it that will update our health bar object when
 
 ```julia
 connect(HP) do hp
-    HB.current = ho
+    HB.current = hp
 end
 ```
 

docs/examples/basic_app.jl

@@ -2,8 +2,8 @@ using Cruise
 
 app = CruiseApp()
 
-@gameloop max_fps=60 app begin
-   println("delta seconds: $(LOOP_VAR.delta_seconds)")
+@gameloop max_fps=60 begin
+   println("delta seconds: $(LOOP_VAR_REF[].delta_seconds)")
    # Simulate a 10-second delay before shutting down
    LOOP_VAR.frame_idx > 600 && shutdown!()
 end

docs/examples/basic_drawing.jl

@@ -1,28 +1,19 @@
 using Cruise
-using ODPlugin
-using HZPlugin
+using Cruise.ODPlugin
+using Cruise.HZPlugin
+
+using SDLOutdoors, SDLHorizons
 
 app = CruiseApp()
-Close = Ref(false)
 
-merge_plugin!(app, ODPLUGIN, ODPlugin.PHASE)
-merge_plugin!(app, HZPLUGIN, HZPlugin.PHASE)
+merge_plugin!(app, ODPLUGIN)
+merge_plugin!(app, HZPLUGIN)
 
 win = CreateWindow(SDLStyle, "My First Window", 640, 480)
-winptr = GetStyle(win).window
-
-RegisterBackend(SDLRender, winptr, 640, 480)
-
-Outdoors.connect(NOTIF_QUIT_EVENT) do
-	Close[] = true
-end
+backend = InitBackend(SDLRender, GetStyle(win).window, 640, 480)
 
 @gameloop max_fps=60 begin
-    backend = GetBackend(winptr)
-    if !isnothing(backend)
-
-        DrawPoint2D(backend, iRGBA(0, 50, 30, 8), Vec2f(50, 50))
-        DrawLine2D(backend, iRGBA(0, 50, 30, 8), Vec2f(100, 100), Vec2f(150, 150))
-    end
-    Close[] && shutdown!()
+    DrawPoint2D(backend, iRGBA(0, 50, 30, 8), Vec2f(50, 50))
+    DrawLine2D(backend, iRGBA(0, 50, 30, 8), Vec2f(100, 100), Vec2f(150, 150))
+    app.ShouldClose && shutdown!()
 end

docs/examples/creating_window.jl

@@ -1,17 +1,13 @@
 using Cruise
-using ODPlugin
+using Cruise.ODPlugin
+using SDLOutdoors
 
 app = CruiseApp()
-Close = Ref(false)
 
-merge_plugin!(app, ODPLUGIN, ODPlugin.PHASE)
+merge_plugin!(app, ODPLUGIN)
 
 win = CreateWindow(SDLStyle, "My First Window", 640, 480)
 
-Outdoors.connect(NOTIF_QUIT_EVENT) do
-	Close[] = true
-end
-
 @gameloop max_fps=60 begin
-   Close[] && shutdown!()
+   app.ShouldClose && shutdown!()
 end

docs/examples/drawing_image.jl

@@ -1,33 +1,28 @@
 using Cruise
-using ODPlugin
-using HZPlugin
+using Cruise.ODPlugin
+using Cruise.HZPlugin
+
+using SDLOutdoors, SDLHorizons
 
 app = CruiseApp()
-Close = Ref(false)
 
-merge_plugin!(app, ODPLUGIN, ODPlugin.PHASE)
-merge_plugin!(app, HZPLUGIN, HZPlugin.PHASE)
+merge_plugin!(app, ODPLUGIN)
+merge_plugin!(app, HZPLUGIN)
 
 win = CreateWindow(SDLStyle, "My First Window", 640, 480)
 winptr = GetStyle(win).window
-
 backend = CreateBackend(SDLRender, winptr, 640, 480)
 
-Outdoors.connect(NOTIF_QUIT_EVENT) do
-	Close[] = true
-end
-
 img = @crate "assets|001.png"::ImageCrate
 
-added = false
 pos = Vec2f(0,0)
 texture = Texture(backend, img)
 
 @gameloop max_fps=60 begin
 
-    Main.pos.x += IsKeyPressed(win, "RIGHT") - IsKeyPressed(win, "LEFT")
-    Main.pos.y += IsKeyPressed(win, "DOWN") - IsKeyPressed(win, "UP")
+    pos.x += IsKeyPressed(win, "RIGHT") - IsKeyPressed(win, "LEFT")
+    pos.y += IsKeyPressed(win, "DOWN") - IsKeyPressed(win, "UP")
 
     DrawTexture2D(backend, Main.texture, Rect2Df(pos...,1,1))
-    Close[] && shutdown!()
+    app.ShouldClose && shutdown!()
 end

docs/examples/pauser.jl

@@ -1,7 +1,7 @@
 module PausePlugin
 
 using Cruise
-using ODPlugin, ..TimerPlugin
+using Cruise.ODPlugin, ..TimerPlugin
 
 const PAUSEPLUGIN = CRPlugin()
 

docs/gamearch.md

@@ -11,7 +11,6 @@ Each plugin can access the data of his dependencies, their states and more.
 This itself form dataflow based architecture when each plugin passes data to the dependent ones.
 For example, when the Physics plugin updates object positions,
 the Renderer plugin automatically gets the new data through the DAG.
-No boilerplate. No manual sync. Just data flowing between systems.
 
 But that's not everything about it.
 You can make plugins for different types of architectures.