Changeset 11673 for code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/scriptable_controller_api.h

Timestamp:

Dec 14, 2017, 4:04:14 PM (7 years ago)

Author:

kohlia

Message:

The ScriptableController should work now. A demo level called scriptableControllerTest exists as well.

File:

• code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/scriptable_controller_api.h (modified) (5 diffs)

code/branches/ScriptableController_HS17/src/orxonox/scriptablecontroller/scriptable_controller_api.h

@@ -146 +146 @@
      * @param type Name of the class of the object you want to spawn
      * @param id The newly created ID that can be used to access this object
+     *
+     * IMPORTANT: Do not use this function yet, it only has minimal functionality and is not
+     * really helpful as it is.
      */
     void spawn(std::string type, std::string id);
@@ -196 +199 @@
 
 private:
-    /**
-     * @brief Called by ScriptableController when a pawn is killed
-     * @param id The dead pawn
-     *
-     * Calls the lua callbacks associated with this event.
-     */
-    void pawnKilled(std::string id, Pawn *pawn);
-
-    /**
-     * @brief Called by ScriptableController when a Pawn is hit
-     * @param target_id The hit Pawn
-     * @param source_id The shooting Pawn
-     * @param new_health The new health of the hit Pawn
-     * @param new_shield The new shield health of the hit Pawn
-     */
-    void pawnHit(std::string target_id, std::string source_id, double new_health, double new_shield);
-
     /**
      * @brief Groups everything together that is needed to handle a near-object event
@@ -260 +246 @@
     };
 
-
     lua_State *lua_;
     ScriptableController *controller_;
@@ -266 +251 @@
     std::list<NearPointHandler> nearPointHandlers_;
     std::list<AreaHandler> areaHandlers_;
-    std::list<std::string> pawnsToKill_;
     std::map<std::string, std::list<std::function<void (std::string)> > > pawnDestroyedHandlers_;
     std::map<std::string, std::list<std::function<void (std::string, std::string, double, double)> > > pawnHitHandlers_;
@@ -273 +257 @@
 
     /**
+     * @brief Called by ScriptableController when a pawn is killed
+     * @param id The dead pawn
+     *
+     * Calls the lua callbacks associated with this event.
+     */
+    void pawnKilled(std::string id, Pawn *pawn);
+
+    /**
+     * @brief Called by ScriptableController when a Pawn is hit
+     * @param target_id The hit Pawn
+     * @param source_id The shooting Pawn
+     * @param new_health The new health of the hit Pawn
+     * @param new_shield The new shield health of the hit Pawn
+     */
+    void pawnHit(std::string target_id, std::string source_id, double new_health, double new_shield);
+
+    /**
      * @brief Called every 0.5s
      *
-     * This handles things that have to be checked periodically (like area events) and
-     * things that are done by lua that have to synchronize with the main thread (like
-     * killing a pawn). Doing this in every tick would be an overkill.
+     * This handles things that have to be checked periodically (like area events)
+     * but doing this in every tick would be an overkill.
      */
     void periodic(void);