Planet
navi homePPSaboutscreenshotsdownloaddevelopmentforum

source: orxonox.OLD/branches/preferences/src/story_entities/story_entity.cc @ 6746

Last change on this file since 6746 was 6153, checked in by bensch, 19 years ago

docu

File size: 1.5 KB
Line 
1
2
3/*
4   orxonox - the future of 3D-vertical-scrollers
5
6   Copyright (C) 2004 orx
7
8   This program is free software; you can redistribute it and/or modify
9   it under the terms of the GNU General Public License as published by
10   the Free Software Foundation; either version 2, or (at your option)
11   any later version.
12
13   ### File Specific:
14   main-programmer: Patrick Boenzli
15   co-programmer:
16*/
17
18
19#include "story_entity.h"
20
21
22using namespace std;
23
24
25
26StoryEntity::StoryEntity ()
27{
28  this->setClassID(CL_STORY_ENTITY, "StoryEntity");
29  this->isInit = false;
30  this->readyToRun = false;
31  this->isPaused = false;
32  this->isSuspended = false;
33}
34
35StoryEntity::~StoryEntity () {}
36
37
38/**
39  *  sets the story ID
40
41    sets the story id of the current entity, this enables it to be identified in a
42    global context.
43*/
44void StoryEntity::setStoryID(int storyID)
45{
46  this->storyID = storyID;
47}
48
49
50/**
51  *  this reads the story id of the current entity
52  * @returns the story entity id
53*/
54int StoryEntity::getStoryID()
55{
56  return this->storyID;
57}
58
59
60/**
61  *  sets the id of the next story entity
62
63    StoryEntities can choose their following entity themselfs. the entity id defined here
64    will be startet after this entity ends. this can be convenient if you want to have a
65    non linear story with switches.
66*/
67void StoryEntity::setNextStoryID(int nextStoryID)
68{
69  this->nextStoryID = nextStoryID;
70}
71
72/**
73  *  gets the story id of the current entity
74  * @returns story id
75*/
76int StoryEntity::getNextStoryID()
77{
78  return this->nextStoryID;
79}
Note: See TracBrowser for help on using the repository browser.