Changeset 2193 in orxonox.OLD for orxonox/branches/chris/src/world.cc

Timestamp:

Jul 18, 2004, 10:19:16 AM (20 years ago)

Author:

chris

Message:

orxonx/branches/chris: added doxygen tags to World::explosion()

File:

• orxonox/branches/chris/src/world.cc (modified) (2 diffs)

orxonox/branches/chris/src/world.cc

@@ -280 +280 @@
 }
 
+/**
+        \brief sends a damage message to all WorldEntities in the specified vicinity
+        \param loc: the Location of the epicenter of the explosion
+        \param dmg: the damage dealt
+        \param r: the radius of the explosion
+        \param instigator: a pointer to the entity that caused the explosion
+        
+        This is a rather expensive function to call, so I suggest you do not call this every tick when you want to
+        create something that deals damage over time (use a countdown instead that calls this function every second or so).
+*/
 void World::explosion (Location* loc, Damage* dmg, float r, WorldEntity* instigator)
 {
@@ -308 +318 @@
 }
 
+/**
+        \brief sends a damage message to all WorldEntities in the specified vicinity
+        \param plc: the Placement of the epicenter of the explosion
+        \param dmg: the damage dealt
+        \param r: the radius of the explosion
+        \param instigator: a pointer to the entity that caused the explosion
+        
+        This is a rather expensive function to call, so I suggest you do not call this every tick when you want to
+        create something that deals damage over time (use a countdown instead that calls this function every second or so).
+*/
 void World::explosion (Placement* plc, Damage* dmg, float r, WorldEntity* instigator)
 {