Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Changeset 3459 in orxonox.OLD for orxonox/trunk/src/story_entity.cc


Ignore:
Timestamp:
Mar 9, 2005, 1:00:30 AM (20 years ago)
Author:
patrick
Message:

orxonox/trunk: cleaning up old stuff in world.cc and its relatives. first step…

File:
1 edited

Legend:

Unmodified
Added
Removed

  • orxonox/trunk/src/story_entity.cc

    r3222 r3459  
    2626StoryEntity::StoryEntity () {}
    2727StoryEntity::~StoryEntity () {}
    28 
    29 
    30 /**
    31     \brief initialize the entity before use.
    32     \returns an error code if not able to apply.
    33 
    34     After execution of this function, the Entity is ready to be played/executed,
    35     this shifts the initialisation work before the execution - very important...
    36 */
    37 ErrorMessage StoryEntity::init()
    38 {}
    3928
    4029
    … …  
    8473
    8574/**
     75    \brief initialize the entity before use.
     76    \returns an error code if not able to apply.
     77
     78    After execution of this function, the Entity is ready to be played/executed,
     79    this shifts the initialisation work before the execution - very important...
     80*/
     81ErrorMessage StoryEntity::init()
     82{}
     83
     84
     85/**
     86    \brief loads the current entity
     87
     88    this is here to enable you loading maps into the entities. for all other actions you
     89    should take the init() function.
     90*/
     91ErrorMessage StoryEntity::load()
     92{}
     93
     94/**
    8695    \brief starts the entity with the choosen id. only for entities with lists.
    8796    \param story id
    … …  
    102111*/
    103112ErrorMessage StoryEntity::start()
    104 {}
    105 
    106 
    107 /**
    108     \brief stops the current entity
    109     \returns error code if this action has caused a error
    110 
    111     ATTENTION: this function shouldn't call other functions, or if so, they must return
    112     after finishing. If you ignore or forget to do so, the current entity is not able to
    113     terminate and it will run in the background or the ressources can't be freed or even
    114     worse: are freed and the program will end in a segmentation fault!
    115     hehehe, all seen... :)
    116 */
    117 ErrorMessage StoryEntity::stop()
    118113{}
    119114
    … …  
    140135
    141136/**
    142     \brief loads the current entity
     137    \brief stops the current entity
     138    \returns error code if this action has caused a error
    143139
    144     this is here to enable you loading maps into the entities. for all other actions you
    145     should take the init() function.
     140    ATTENTION: this function shouldn't call other functions, or if so, they must return
     141    after finishing. If you ignore or forget to do so, the current entity is not able to
     142    terminate and it will run in the background or the ressources can't be freed or even
     143    worse: are freed and the program will end in a segmentation fault!
     144    hehehe, all seen... :)
    146145*/
    147 void StoryEntity::load()
     146ErrorMessage StoryEntity::stop()
    148147{}
    149148
    … …  
    155154    the entity please use the stop() function.
    156155*/
    157 void StoryEntity::destroy()
     156ErrorMessage StoryEntity::destroy()
    158157{}
    159158
Note: See TracChangeset for help on using the changeset viewer.