[8907] | 1 | /* |
---|
| 2 | * ORXONOX - the hottest 3D action shooter ever to exist |
---|
| 3 | * > www.orxonox.net < |
---|
| 4 | * |
---|
| 5 | * |
---|
| 6 | * License notice: |
---|
| 7 | * |
---|
| 8 | * This program is free software; you can redistribute it and/or |
---|
| 9 | * modify it under the terms of the GNU General Public License |
---|
| 10 | * as published by the Free Software Foundation; either version 2 |
---|
| 11 | * of the License, or (at your option) any later version. |
---|
| 12 | * |
---|
| 13 | * This program is distributed in the hope that it will be useful, |
---|
| 14 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
---|
| 15 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
---|
| 16 | * GNU General Public License for more details. |
---|
| 17 | * |
---|
| 18 | * You should have received a copy of the GNU General Public License |
---|
| 19 | * along with this program; if not, write to the Free Software |
---|
| 20 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
---|
| 21 | * |
---|
| 22 | * Author: |
---|
| 23 | * Damian 'Mozork' Frick |
---|
| 24 | * Co-authors: |
---|
| 25 | * ... |
---|
| 26 | * |
---|
| 27 | */ |
---|
| 28 | |
---|
| 29 | /** |
---|
| 30 | @file |
---|
| 31 | @brief Definition of the PartyMember class. |
---|
| 32 | */ |
---|
| 33 | |
---|
| 34 | #ifndef _PartyMember_H__ |
---|
| 35 | #define _PartyMember_H__ |
---|
| 36 | |
---|
| 37 | #include "OrxonoxPrereqs.h" |
---|
| 38 | #include "core/OrxonoxClass.h" |
---|
| 39 | |
---|
| 40 | namespace orxonox |
---|
| 41 | { |
---|
| 42 | /** |
---|
| 43 | @brief |
---|
| 44 | PartyMember is an Interface, that can be implemented by any object to enable it to belong to a certain group. (friend, foe, neutral, ...) |
---|
| 45 | |
---|
| 46 | It just needs to inherit form PartyMember, and implement the methods. |
---|
| 47 | @author |
---|
| 48 | Damian 'Mozork' Frick |
---|
| 49 | */ |
---|
| 50 | class _OrxonoxExport PartyMember : virtual public OrxonoxClass |
---|
| 51 | { |
---|
| 52 | public: |
---|
| 53 | PartyMember(); |
---|
[8942] | 54 | virtual ~PartyMember(); |
---|
[8907] | 55 | |
---|
[8950] | 56 | |
---|
| 57 | |
---|
[8907] | 58 | /** |
---|
| 59 | @brief |
---|
[8950] | 60 | Method to set the objects teamnumber. |
---|
| 61 | Must be implemented by every class inheriting from PartyMember. It is virtual in order to allow to implement a hirarchy. |
---|
| 62 | Hirarchy: PlayerInfo > Controller > Pawn. When the level is set in the controller it should be also set in the controlled pawn. |
---|
| 63 | @param team The teamnumber to which a PartyMember belongs to. Value '-1' means no team is set. 0,1,2, ... are legal team numbers. |
---|
| 64 | |
---|
[8907] | 65 | @return |
---|
[8950] | 66 | |
---|
[8907] | 67 | */ |
---|
[8950] | 68 | virtual inline void setTeam(int team) =0; |
---|
[8907] | 69 | |
---|
| 70 | inline int getTeam() const |
---|
| 71 | { return this->team_; } |
---|
| 72 | |
---|
| 73 | protected: |
---|
| 74 | int team_; //<! Teamnumber: to identify to which group a PartyMember belongs to |
---|
| 75 | //<! Default value: -1 : neutral the meaning of other values is defined in the context |
---|
| 76 | |
---|
| 77 | |
---|
| 78 | }; |
---|
| 79 | } |
---|
| 80 | |
---|
| 81 | #endif /* _PartyMember_H__ */ |
---|