Merge branch 'master' of https://github.com/lonkaars/crepe into wouter/events-poc

3 files changed, 53 insertions, 22 deletions

diff --git a/src/example/audio_internal.cpp b/src/example/audio_internal.cpp
index 1199e2d..f35ad9d 100644
--- a/src/example/audio_internal.cpp
+++ b/src/example/audio_internal.cpp
@@ -5,26 +5,40 @@
 
 #include <crepe/Sound.h>
 #include <crepe/util/log.h>
+#include <crepe/api/Config.h>
 
-#include <chrono>
 #include <thread>
 
 using namespace crepe;
+using namespace crepe::api;
 using namespace std;
 using namespace std::chrono_literals;
 using std::make_unique;
 
-int main() {
-	dbg_trace();
+// Unrelated stuff that is not part of this POC
+int _ = [] () {
+	// Show dbg_trace() output
+	auto & cfg = api::Config::get_instance();
+	cfg.log.level = util::LogLevel::TRACE;
+
+	return 0; // satisfy compiler
+}();
+
 
+
+int main() {
+	// Load a background track (Ogg Vorbis)
 	auto bgm = Sound("../mwe/audio/bgm.ogg");
+	// Load three short samples (WAV)
 	auto sfx1 = Sound("../mwe/audio/sfx1.wav");
 	auto sfx2 = Sound("../mwe/audio/sfx2.wav");
 	auto sfx3 = Sound("../mwe/audio/sfx3.wav");
 
+	// Start the background track
 	bgm.play();
 
-	// play each sample sequentially
+	// Play each sample sequentially while pausing and resuming the background
+	// track
 	this_thread::sleep_for(500ms);
 	sfx1.play();
 	this_thread::sleep_for(500ms);
@@ -35,11 +49,12 @@ int main() {
 	bgm.play();
 	this_thread::sleep_for(500ms);
 
-	// play all samples simultaniously
+	// Play all samples simultaniously
 	sfx1.play();
 	sfx2.play();
 	sfx3.play();
 	this_thread::sleep_for(1000ms);
 
-	return 0;
+	// Stop all audio and exit
+	return EXIT_SUCCESS;
 }
diff --git a/src/example/log.cpp b/src/example/log.cpp
index 3bc6d80..04ab9cd 100644
--- a/src/example/log.cpp
+++ b/src/example/log.cpp
@@ -9,16 +9,21 @@
 using namespace crepe;
 using namespace crepe::util;
 
-int main() {
-	auto & cfg = api::Config::get_instance();
+// unrelated setup code
+int _ = [] () {
 	// make sure all log messages get printed
+	auto & cfg = api::Config::get_instance();
 	cfg.log.level = util::LogLevel::TRACE;
 
+	return 0; // satisfy compiler
+} ();
+
+int main() {
 	dbg_trace();
-	dbg_logf("cfg.log.color is equal to %d", cfg.log.color);
-	logf(LogLevel::INFO, "info message!");
-	logf(LogLevel::WARNING, "very scary warning");
-	logf(LogLevel::ERROR, "fatal error!!!");
+	dbg_logf("test printf parameters: %d", 3);
+	logf(LogLevel::INFO, "info message");
+	logf(LogLevel::WARNING, "warning");
+	logf(LogLevel::ERROR, "error");
 
 	return 0;
 }
diff --git a/src/example/script.cpp b/src/example/script.cpp
index 43f1c22..cda9591 100644
--- a/src/example/script.cpp
+++ b/src/example/script.cpp
@@ -17,27 +17,38 @@ using namespace crepe;
 using namespace crepe::api;
 using namespace std;
 
+// Unrelated stuff that is not part of this POC
+int _ = [] () {
+	// Show dbg_trace() output
+	auto & cfg = api::Config::get_instance();
+	cfg.log.level = util::LogLevel::TRACE;
+
+	return 0; // satisfy compiler
+}();
+
+
+
+// User-defined script:
 class MyScript : public Script {
 	void update() {
+		// Retrieve component from the same GameObject this script is on
 		Transform & test = get_component<Transform>();
 		dbg_logf("Transform(%.2f, %.2f)", test.position.x, test.position.y);
 	}
 };
 
 int main() {
-	auto & cfg = api::Config::get_instance();
-	cfg.log.level = util::LogLevel::TRACE;
-
+	// Create game object with Transform and BehaviorScript components
 	auto obj = GameObject(0, "name", "tag", 0);
-	Point point = {
-		.x = 1.2,
-		.y = 3.4,
-	};
-	obj.add_component<Transform>(point, 0, 0);
+	obj.add_component<Transform>(Point { .x = 1.2, .y = 3.4, }, 0, 0);
 	obj.add_component<BehaviorScript>().set_script<MyScript>();
 
+	// Get ScriptSystem singleton instance (this would normally be done from the
+	// game loop)
 	auto & sys = ScriptSystem::get_instance();
-	sys.update(); // -> MyScript::update
+	// Update all scripts. This should result in MyScript::update being called
+	sys.update();
 
-	return 0;
+	return EXIT_SUCCESS;
 }
+