Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

Ignore:
Timestamp:
Dec 31, 2005, 2:32:08 PM (19 years ago)
Author:
patrick
Message:

network: thown some old story entity functions away

File:
1 edited

Legend:

Unmodified
Added
Removed

  • branches/network/src/story_entities/story_entity.h

    r6153 r6371  
    2020
    2121  // INIT AND LOAD //
    22   /** @brief initializes a Story Entity to default Values */
     22  /** initializes a Story Entity to default Values */
    2323  virtual ErrorMessage init() {};
    24   /** @brief called before loading */
     24  /** called before loading */
    2525  virtual ErrorMessage preLoad() {};
    26   /** @brief called to load. */
     26  /** called to load. */
    2727  virtual ErrorMessage load() {};
    28   /** @brief called right after loading */
     28  /** called right after loading */
    2929  virtual ErrorMessage postLoad() {};
    30   /** @brief called after postload to check for integrity. (optional) */
     30  /** called after postload to check for integrity. (optional) */
    3131  virtual ErrorMessage check() {};
    3232
    3333  // RUNNING //
    34   /** @brief called shortly before starting the Entity */
     34  /** called shortly before starting the Entity */
    3535  virtual ErrorMessage preStart() {};
    36   /** @brief starts the Entity. Starts the main cycle */
     36  /** starts the Entity. Starts the main cycle */
    3737  virtual ErrorMessage start() = 0;
    38   /** @brief pauses the Entity. call to resume required to get it running again */
     38  /** pauses the Entity. call to resume required to get it running again */
    3939  virtual ErrorMessage pause() = 0;
    40   /** @brief resumes the Entity after a stop/pause or suspend. */
     40  /** resumes the Entity after a stop/pause or suspend. */
    4141  virtual ErrorMessage resume() = 0;
    42   /** @brief suspends the Entity detaches all mayor functions  (optional) */
     42  /** suspends the Entity detaches all mayor functions  (optional) */
    4343  virtual ErrorMessage suspend() {};
    44   /** @brief rewinds to the beginning/last checkpoint */
     44  /** rewinds to the beginning/last checkpoint */
    4545  virtual ErrorMessage rewind() {};
    46   /** @brief leaves the Entity. Ends it */
     46  /** leaves the Entity. Ends it */
    4747  virtual ErrorMessage preStop() {};
    48   /** @brief Stops the entity. */
     48  /** Stops the entity. */
    4949  virtual ErrorMessage stop() = 0;
    5050
    51   // KILLING
    52   /** @brief kills the Entity. should also calls prestop stop */
    53   virtual ErrorMessage destroy() {};
    5451
    55   void setStoryID(int storyID);
    56   int getStoryID();
     52  /** sets the story id of the current entity, this enables it to be identified in a global context.  @param storyID the story id */
     53  inline void setStoryID(int storyID) { this->storyID = storyID; }
     54  /** sets the story id of the current entity, this enables it to be identified in a  global context. @returns  the story id  */
     55  inline int getStoryID() { this->storyID = storyID; }
     56  /**  sets the id of the next story entity: StoryEntities can choose their following entity themselfs.
     57   * the entity id defined here  will be startet after this entity ends. this can be convenient if you
     58   * want to have a non linear story with switches.
     59   * @param nextStoryID the story id of the next StoryEntity   */
     60  inline void setNextStoryID(int nextStoryID) { this->nextStoryID = nextStoryID; }
     61  /**  gets the story id of the current entity @returns story id */
     62  inline int getNextStoryID() { return this->nextStoryID; }
    5763
    58   void setNextStoryID(int nextStoryID);
    59   int getNextStoryID();
     64
    6065
    6166  protected:
Note: See TracChangeset for help on using the changeset viewer.