Changeset 4836 in orxonox.OLD for orxonox/trunk/src/story_entities/story_entity.cc
- Timestamp:
- Jul 12, 2005, 12:33:16 AM (20 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
orxonox/trunk/src/story_entities/story_entity.cc
r4597 r4836 32 32 33 33 /** 34 \briefsets the story ID34 * sets the story ID 35 35 36 36 sets the story id of the current entity, this enables it to be identified in a … … 44 44 45 45 /** 46 \briefthis reads the story id of the current entity47 \returns the story entity id46 * this reads the story id of the current entity 47 * @returns the story entity id 48 48 */ 49 49 int StoryEntity::getStoryID() … … 54 54 55 55 /** 56 \briefsets the id of the next story entity56 * sets the id of the next story entity 57 57 58 58 StoryEntities can choose their following entity themselfs. the entity id defined here … … 66 66 67 67 /** 68 \briefgets the story id of the current entity69 \returns story id68 * gets the story id of the current entity 69 * @returns story id 70 70 */ 71 71 int StoryEntity::getNextStoryID() … … 76 76 77 77 /** 78 \briefstuff that will have to be initialized before load78 * stuff that will have to be initialized before load 79 79 80 80 this gives all storyentities the possibility to init stuff before the … … 85 85 86 86 /** 87 \briefloads the current entity87 * loads the current entity 88 88 89 89 this is here to enable you loading maps into the entities. for all other actions you … … 96 96 97 97 /** 98 \briefinitialize the entity before use.99 \returns an error code if not able to apply.98 * initialize the entity before use. 99 * @returns an error code if not able to apply. 100 100 101 101 After execution of this function, the Entity is ready to be played/executed, … … 108 108 109 109 /** 110 \briefstarts the entity with the choosen id. only for entities with lists.111 \param story id112 \returns error code if this action has caused a error110 * starts the entity with the choosen id. only for entities with lists. 111 * @param story id 112 * @returns error code if this action has caused a error 113 113 114 114 this simply starts the story with the id storyID. the story with the choosen id has … … 122 122 123 123 /** 124 \briefstarts the current entity125 \returns error code if this action has caused a error124 * starts the current entity 125 * @returns error code if this action has caused a error 126 126 */ 127 127 ErrorMessage StoryEntity::start() … … 130 130 131 131 /** 132 \briefpause the current entity133 \returns error code if this action has caused a error132 * pause the current entity 133 * @returns error code if this action has caused a error 134 134 135 135 this pauses the current entity or passes this call forth to the running entity. … … 140 140 141 141 /** 142 \briefresumes a pause143 \returns error code if this action has caused a error142 * resumes a pause 143 * @returns error code if this action has caused a error 144 144 145 145 this resumess the current entity or passes this call forth to the running entity. … … 150 150 151 151 /** 152 \briefstops the current entity153 \returns error code if this action has caused a error152 * stops the current entity 153 * @returns error code if this action has caused a error 154 154 155 155 ATTENTION: this function shouldn't call other functions, or if so, they must return … … 164 164 165 165 /** 166 \briefdestroys and cleans up the current entity.166 * destroys and cleans up the current entity. 167 167 168 168 this cleans up ressources before the deconstructor is called. for terminating … … 174 174 175 175 /** 176 \briefthis displays the load screen176 * this displays the load screen 177 177 178 178 it will need some time to load maps or things like that. to inform the user about … … 184 184 185 185 /** 186 \briefundisplay the load screen186 * undisplay the load screen 187 187 188 188 the load process has terminated, you now can release the load screen and start this
Note: See TracChangeset
for help on using the changeset viewer.