0ad/source/simulation2/components/CCmpOwnership.cpp

/* Copyright (C) 2025 Wildfire Games.
 * This file is part of 0 A.D.
 *
 * 0 A.D. is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * 0 A.D. is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with 0 A.D.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "precompiled.h"

#include "ICmpOwnership.h"

#include "simulation2/MessageTypes.h"
#include "simulation2/helpers/Player.h"
#include "simulation2/system/Component.h"
#include "simulation2/system/Message.h"

#include <string>

/**
 * Basic ICmpOwnership implementation.
 */
class CCmpOwnership final : public ICmpOwnership
{
public:
	static void ClassInit(CComponentManager& componentManager)
	{
		componentManager.SubscribeToMessageType(MT_Destroy);
	}

	DEFAULT_COMPONENT_ALLOCATOR(Ownership)

	player_id_t m_Owner;

	static std::string GetSchema()
	{
		return
			"<a:example/>"
			"<a:help>Allows this entity to be owned by players.</a:help>"
			"<empty/>";
	}

	void Init(const CParamNode&) override
	{
		m_Owner = INVALID_PLAYER;
	}

	void Deinit() override
	{
	}

	void Serialize(ISerializer& serialize) override
	{
		serialize.NumberI32_Unbounded("owner", m_Owner);
	}

	void Deserialize(const CParamNode&, IDeserializer& deserialize) override
	{
		deserialize.NumberI32_Unbounded("owner", m_Owner);
	}

	void HandleMessage(const CMessage& msg, bool /*global*/) override
	{
		switch (msg.GetType())
		{
		case MT_Destroy:
		{
			// Reset the owner so this entity is e.g. removed from population counts
			SetOwner(INVALID_PLAYER);
			break;
		}
		}
	}

	player_id_t GetOwner() const override
	{
		return m_Owner;
	}

	void SetOwner(player_id_t playerID) override
	{
		if (playerID == m_Owner)
			return;

		player_id_t old = m_Owner;
		m_Owner = playerID;

		CMessageOwnershipChanged msg(GetEntityId(), old, playerID);
		GetSimContext().GetComponentManager().PostMessage(GetEntityId(), msg);
	}

	void SetOwnerQuiet(player_id_t playerID) override
	{
		if (playerID != m_Owner)
			m_Owner = playerID;
	}
};

REGISTER_COMPONENT_TYPE(Ownership)