merge `master` into `loek/audio`

1 files changed, 22 insertions, 21 deletions

diff --git a/src/crepe/api/BehaviorScript.h b/src/crepe/api/BehaviorScript.h
index 2982358..9d85d4c 100644
--- a/src/crepe/api/BehaviorScript.h
+++ b/src/crepe/api/BehaviorScript.h
@@ -3,6 +3,7 @@
 #include <memory>
 
 #include "../Component.h"
+
 #include "GameObject.h"
 
 namespace crepe {
@@ -14,20 +15,26 @@ class Script;
 /**
  * \brief Script component
  *
- * This class acts as a (component) wrapper around an instance of (a class
- * derivatived from) \c Script. \c BehaviorScript is the only ECS component
- * that stores member function implementations as data.
+ * This class acts as a (component) wrapper around an instance of (a class derivatived from) \c
+ * Script. \c BehaviorScript is the only ECS component that stores member function
+ * implementations as data.
  */
 class BehaviorScript : public Component {
 protected:
+	/**
+	 * \param id Parent \c GameObject id
+	 * \param component_manager Reference to component manager (passed through to \c Script
+	 * instance)
+	 *
+	 * \note Calls to this constructor (should) always pass through \c GameObject::add_component,
+	 * which has an exception for this specific component type. This was done so the user does
+	 * not have to pass references used within \c Script to each \c BehaviorScript instance.
+	 */
 	BehaviorScript(game_object_id_t id, ComponentManager & component_manager);
 	//! Only ComponentManager is allowed to instantiate BehaviorScript
 	friend class ComponentManager;
 
 public:
-	~BehaviorScript() = default;
-
-public:
 	/**
 	 * \brief Set the concrete script of this component
 	 *
@@ -39,29 +46,23 @@ public:
 	BehaviorScript & set_script();
 
 protected:
-	//! ScriptSystem needs direct access to the script instance
-	friend class ScriptSystem;
-	//! Flag to indicate if script->init() has been called already
-	bool initialized = false;
 	//! Script instance
 	std::unique_ptr<Script> script = nullptr;
-	//! Reference to component manager
-	ComponentManager & component_manager;
+	//! ScriptSystem needs direct access to the script instance
+	friend class ScriptSystem;
 
-private:
-	//! Script accesses the component manager directly via its parent
-	// (BehaviorScript) reference
-	friend class Script;
+protected:
+	//! Reference to component manager (passed to Script)
+	ComponentManager & component_manager;
 };
 
 /**
  * \brief Add a BehaviorScript component to this game object
  *
- * The \c BehaviorScript class is the only exception to the ECS harmony, and
- * requires a reference to the component manager passed to its constructor in
- * order to function normally. This is because the \c BehaviorScript (and \c
- * Script) classes are the only component-related classes that store
- * implemented member functions as data.
+ * The \c BehaviorScript class is the only exception to the ECS harmony, and requires a
+ * reference to the component manager passed to its constructor in order to function normally.
+ * This is because the \c BehaviorScript (and \c Script) classes are the only component-related
+ * classes that store implemented member functions as data.
  */
 template <>
 BehaviorScript & GameObject::add_component<BehaviorScript>();