Add games made with ALPACA to docs

pinguin999 · pinguin999 · commit 4d8fc15db2b6 · 2024-04-23T22:10:04.000+02:00
Lua all callbacks are now optional, no pass nedded anymore
diff --git a/lua-docs/docs/dialogs.md b/lua-docs/docs/dialogs.md
@@ -6,21 +6,19 @@ Examples for start dialogs:
 
 ```lua
 -- Dialog without callback
-PlayDialog("armchair", pass)
+PlayDialog("armchair")
 ```
 
 ```lua
 -- Dialog with callback.
--- The takeBanana function is called after the dialog is played.
-function takeBanana()
-    PlayAudio("pick-up-item.ogg")
-    AddToInventory()
-    SetSkin("inventory")
-    SetHidden()
-end
-
+-- The second function is called after the dialog is played.
 function takeBananaDialog()
-    PlayDialog("banana", takeBanana)
+    PlayDialog("banana", function ()
+        PlayAudio("pick-up-item.ogg")
+        AddToInventory()
+        SetSkin("inventory")
+        SetHidden()
+    end)
 end
 ```
 
diff --git a/lua-docs/docs/index.md b/lua-docs/docs/index.md
@@ -122,7 +122,7 @@ print("bark")
 
 ```lua
 print("bark")
-PlayAnimation(0, "bark", false, pass)
+PlayAnimation(0, "bark", false)
 ```
 
 Now we will start with the **Lua scripting**, the way logic is defined in an ALPACA game. A full list of functions can be found in the [Lua API](lua.md) documentation. For the quick intro you want the player to go to the item and interact with it. To be able to go somewhere you have to define a [Point](http://esotericsoftware.com/spine-points) in Spine, so let's add the Point to our item and save it again. *I have named the Point in the example "game center" and will also use this name in this tutorial's script*.
@@ -132,16 +132,12 @@ Most Lua Function like `GoToPoint` have two versions: GoToPoint and GoToPointOn
 ```lua
 print("banana_clicked")
 
-function respawn()
-    print("respawn")
-    PlayAnimationOn("Player", 0, "idle", true, pass)
-end
-
-function play_death()
-    PlayAnimationOn("Player", 0, "death", false, respawn)
-end
-
-GoToPointOn("banana", "center", play_death)
+GoToPointOn("banana", "center", function ()
+    PlayAnimationOn("Player", 0, "death", false, function respawn()
+        print("respawn")
+        PlayAnimationOn("Player", 0, "idle", true)
+    end)
+end)
 ```
 
 For a full overview about all Lua functions see the [Lua documentation](lua.md)
diff --git a/lua-docs/docs/made_with.md b/lua-docs/docs/made_with.md
@@ -0,0 +1,22 @@
+# List of ALPACA Projects
+
+## Games made with ALPACA
+
+### Cure for the woods
+
+Windows and Browser version at [itch.io](https://brain-connected.itch.io/cure-for-the-woods)
+![Cure for the woods](https://img.itch.zone/aW1nLzExMjQ4OTg2LnBuZw==/original/UWYMbM.png)
+
+## Kids Books made with ALPACA
+
+### Drache Puck und die Wut
+
+![Drache Puck und die Wut](https://is1-ssl.mzstatic.com/image/thumb/PurpleSource221/v4/ae/4d/d4/ae4dd467-5751-79f8-ff65-26b778eef429/8830b91f-afa8-49b0-9d6a-ba720882d40f_page0.png/626x0w.webp)
+
+<div class="video-wrapper">
+  <iframe width="1280" height="720" src="https://www.youtube.com/watch?v=T5yvy9YEyro" frameborder="0" allowfullscreen></iframe>
+</div>
+
+- [Trailer](https://www.youtube.com/watch?v=T5yvy9YEyro)
+- [Android](https://play.google.com/store/apps/details?id=com.alpaca.game)
+- [iOS](https://apps.apple.com/us/app/drache-puck-und-die-wut/id6477598064)
diff --git a/lua-docs/docs/scene.md b/lua-docs/docs/scene.md
@@ -110,8 +110,7 @@ Therefor ALPACA expects a Spine point near each door with next scenes name.
 After changing the scene, the player will be placed at the Spine point with last scenes name.
 
 ```lua
-function door()
+GoToPoint("scene_corridor_right", function ()
     LoadScene("scene_corridor_right")
-end
-GoToPoint("scene_corridor_right", door)
+end)
 ```
diff --git a/lua-docs/mkdocs.yml b/lua-docs/mkdocs.yml
@@ -12,3 +12,4 @@ nav:
   - "Dialogs": dialogs.md
   - "Spine": spine.md
   - "Assets": asset_pipeline.md
+  - "Made with ALPACA": made_with.md
diff --git a/src/lua.cpp b/src/lua.cpp
@@ -76,10 +76,13 @@ void Game::setupLuaFunctions()
 	/// bool loop: Should the animation be looped at the end.
 	/// function callback: called on the end of the animation, also on looped animations.
 	lua_state->set_function("PlayAnimation",
-							[this](int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, sol::function callback)
+							[this](int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, std::optional<sol::function> callback)
 							{
+								if (!callback) {
+									callback = (*lua_state)["pass"];
+								}
 								std::shared_ptr<SpineObject> obj = (*lua_state)["this"];
-								obj->playAnimation(trackIndex, newAnimation, loop, callback);
+								obj->playAnimation(trackIndex, newAnimation, loop, callback.value());
 								std::string lua_object = getLuaPath(obj->getId());
 								lua_state->script(lua_object + ".animation = \"" + newAnimation + "\"");
 								if (loop)
@@ -98,10 +101,13 @@ void Game::setupLuaFunctions()
 	/// bool loop: Should the animation be looped at the end.
 	/// function callback: called on the end of the animation, also on looped animations.
 	lua_state->set_function("AddAnimation",
-							[this](int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, float delay, sol::function callback)
+							[this](int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, float delay, std::optional<sol::function> callback)
 							{
+								if (!callback) {
+									callback = (*lua_state)["pass"];
+								}
 								std::shared_ptr<SpineObject> obj = (*lua_state)["this"];
-								obj->addAnimation(trackIndex, newAnimation, loop, delay, callback);
+								obj->addAnimation(trackIndex, newAnimation, loop, delay, callback.value());
 								std::string lua_object = getLuaPath(obj->getId());
 								lua_state->script(lua_object + ".animation = \"" + newAnimation + "\"");
 								if (loop)
@@ -121,12 +127,15 @@ void Game::setupLuaFunctions()
 	/// bool loop: Should the animation be looped at the end.
 	/// function callback: called on the end of the animation, also on looped animations.
 	lua_state->set_function("PlayAnimationOn",
-							[this](const LuaSpineObject &object, int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, sol::function callback)
+							[this](const LuaSpineObject &object, int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, std::optional<sol::function> callback)
 							{
+								if (!callback) {
+									callback = (*lua_state)["pass"];
+								}
 								std::shared_ptr<SpineObject> obj = getObjectById(object);
 								if (obj)
 								{
-									obj->playAnimation(trackIndex, newAnimation, loop, callback);
+									obj->playAnimation(trackIndex, newAnimation, loop, callback.value());
 									std::string lua_object = getLuaPath(obj->getId());
 									lua_state->script(lua_object + ".animation = \"" + newAnimation + "\"");
 									if (loop)
@@ -147,12 +156,15 @@ void Game::setupLuaFunctions()
 	/// bool loop: Should the animation be looped at the end.
 	/// function callback: called on the end of the animation, also on looped animations.
 	lua_state->set_function("AddAnimationOn",
-							[this](const LuaSpineObject &object, int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, float delay, sol::function callback)
+							[this](const LuaSpineObject &object, int trackIndex, const LuaSpineAnimation &newAnimation, bool loop, float delay, std::optional<sol::function> callback)
 							{
+								if (!callback) {
+									callback = (*lua_state)["pass"];
+								}
 								std::shared_ptr<SpineObject> obj = getObjectById(object);
 								if (obj)
 								{
-									obj->addAnimation(trackIndex, newAnimation, loop, delay, callback);
+									obj->addAnimation(trackIndex, newAnimation, loop, delay, callback.value());
 									std::string lua_object = getLuaPath(obj->getId());
 									lua_state->script(lua_object + ".animation = \"" + newAnimation + "\"");
 									if (loop)
@@ -196,8 +208,11 @@ void Game::setupLuaFunctions()
 	/// Plays a dialog by name
 	/// string dialogName: Name of the skin that will be set.
 	lua_state->set_function("PlayDialog",
-							[this](const LuaDialog &dialogName, sol::function callback)
+							[this](const LuaDialog &dialogName, std::optional<sol::function> callback)
 							{
+								if (!callback) {
+									callback = (*lua_state)["pass"];
+								}
 								float x = 0;
 								float y = 0;
 								std::shared_ptr<SpineObject> obj = (*lua_state)["this"];
@@ -208,7 +223,7 @@ void Game::setupLuaFunctions()
 									spPointAttachment *point = SUB_CAST(spPointAttachment, att);
 									spPointAttachment_computeWorldPosition(point, slot->bone, &x, &y);
 								}
-								getDialogManager()->play(dialogName, jngl::Vec2(x, -y) + obj->getPosition(), callback);
+								getDialogManager()->play(dialogName, jngl::Vec2(x, -y) + obj->getPosition(), callback.value());
 							});
 
 	/// Adds the current item to the inventory.
@@ -386,13 +401,16 @@ void Game::setupLuaFunctions()
 	/// string point_name: Name of the point the player should go to
 	/// function callback: Function that will becalled when the layer reaches the position
 	lua_state->set_function("GoToPoint",
-							[this](const LuaSpinePoint &point_name, sol::function callback)
+							[this](const LuaSpinePoint &point_name, std::optional<sol::function> callback)
 							{
+								if (!callback) {
+									callback = (*lua_state)["pass"];
+								}
 								std::shared_ptr<SpineObject> obj = (*lua_state)["this"];
 								auto position = obj->getPoint(point_name);
 								if (!position)
 									return;
-								std::static_pointer_cast<InteractableObject>(obj)->goToPosition(*position, callback);
+								std::static_pointer_cast<InteractableObject>(obj)->goToPosition(*position, callback.value());
 								// TODO Write Players position to Lua
 							});
 
@@ -401,15 +419,18 @@ void Game::setupLuaFunctions()
 	/// string point_name: Name of the point the player should go to
 	/// function callback: Function that will becalled when the layer reaches the position
 	lua_state->set_function("GoToPointOn",
-							[this](const LuaSpineObject &object, const LuaSpinePoint &point_name, sol::function callback)
+							[this](const LuaSpineObject &object, const LuaSpinePoint &point_name, std::optional<sol::function> callback)
 							{
+								if (!callback) {
+									callback = (*lua_state)["pass"];
+								}
 								std::shared_ptr<SpineObject> obj = getObjectById(object);
 								if (obj)
 								{
 									auto position = obj->getPoint(point_name);
 									if (!position)
 										return;
-									std::static_pointer_cast<InteractableObject>(obj)->goToPosition(*position, callback);
+									std::static_pointer_cast<InteractableObject>(obj)->goToPosition(*position, callback.value());
 									// TODO Write Players position to Lua
 								}
 							});
