Line data    Source code

       1             : /* Copyright (C) 2017 Wildfire Games.
       2             :  * This file is part of 0 A.D.
       3             :  *
       4             :  * 0 A.D. is free software: you can redistribute it and/or modify
       5             :  * it under the terms of the GNU General Public License as published by
       6             :  * the Free Software Foundation, either version 2 of the License, or
       7             :  * (at your option) any later version.
       8             :  *
       9             :  * 0 A.D. is distributed in the hope that it will be useful,
      10             :  * but WITHOUT ANY WARRANTY; without even the implied warranty of
      11             :  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
      12             :  * GNU General Public License for more details.
      13             :  *
      14             :  * You should have received a copy of the GNU General Public License
      15             :  * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
      16             :  */
      17             : 
      18             : #ifndef INCLUDED_ICMPOWNERSHIP
      19             : #define INCLUDED_ICMPOWNERSHIP
      20             : 
      21             : #include "simulation2/system/Interface.h"
      22             : #include "simulation2/helpers/Player.h"
      23             : 
      24             : /**
      25             :  * Player ownership.
      26             :  * Owner values are either a player ID (if >= 0), or unassigned (INVALID_PLAYER).
      27             :  * Sends message OwnershipChanged after it changes.
      28             :  */
      29           0 : class ICmpOwnership : public IComponent
      30             : {
      31             : public:
      32             :     virtual player_id_t GetOwner() const = 0;
      33             : 
      34             :     virtual void SetOwner(player_id_t playerID) = 0;
      35             : 
      36             :     // Operates identically to SetOwner() but does not send a message.
      37             :     virtual void SetOwnerQuiet(player_id_t playerID) = 0;
      38             : 
      39         116 :     DECLARE_INTERFACE_TYPE(Ownership)
      40             : };
      41             : 
      42             : #endif // INCLUDED_ICMPOWNERSHIP