Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 2141 in orxonox.OLD for orxonox/branches/chris/src/world.h


Ignore:
Timestamp:
Jul 14, 2004, 3:31:42 PM (21 years ago)
Author:
chris
Message:

orxonox/branches/chris: added lots and lots of doxygen tags

File:
1 edited

Legend:

Unmodified
Added
Removed

  • orxonox/branches/chris/src/world.h

    r2112 r2141  
     1/*!
     2    \file world.h
     3    \brief Holds and manages all game data
     4*/
    15
    26#ifndef WORLD_H
    … …  
    812class WorldEntity;
    913
     14//! The game environment
    1015class World {
    1116
    … …  
    4045};
    4146
     47/**
     48    \brief spawn a new WorldEntity at a Location
     49    \param loc: the Location where the Entity should be spawned
     50    \param owner: a pointer to the parent of the Entity
     51    \return a pointer to the new WorldEntity or NULL if there was an error
     52   
     53    You can use this function to spawn any derivation of WorldEntity you want, just specify the desired
     54    class within the template specification brackets. Do not attempt to spawn any classes that have NOT been
     55    derived from WorldEntity, you won't even be able to compile the code. Note that this version of spawn()
     56    works with both free and bound WorldEntities.
     57*/
    4258template<typename T> T* World::spawn(Location* loc = NULL, WorldEntity* owner = NULL)
    4359{
    … …  
    6278}
    6379
     80/**
     81    \brief spawn a new WorldEntity at a Placement
     82    \param lplc: the placement where the Entity should be spawned
     83    \param owner: a pointer to the parent of the Entity
     84    \return a pointer to the new WorldEntity or NULL if there was an error
     85   
     86    You can use this function to spawn any FREE derivation of WorldEntity you want, just specify the desired
     87    class within the template specification brackets. Do not attempt to spawn any classes that have NOT been
     88    derived from WorldEntity, you won't even be able to compile the code. Note that this version of spawn()
     89    works with free WorldEntities only, you will provoke an error message if you try to spawn a bound Entity with
     90    a Placement.
     91*/
    6492template<typename T> T* World::spawn(Placement* plc, WorldEntity* owner = NULL)
    6593{
Note: See TracChangeset for help on using the changeset viewer.