ActorBase.h

Go to the documentation of this file.

/*
* True Reality Open Source Game and Simulation Engine
* Copyright © 2021 Acid Rain Studios LLC
*
* This library is free software; you can redistribute it and/or modify it under
* the terms of the GNU Lesser General Public License as published by the Free
* Software Foundation; either version 3.0 of the License, or (at your option)
* any later version.
*
* This library 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 Lesser General Public License for more
* details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this library; if not, write to the Free Software Foundation, Inc.,
* 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*
* @author Maxim Serebrennik
*/

#pragma once

#include "Export.h"

#include <trManager/MessageBase.h>
#include <trManager/EntityBase.h>
#include <trBase/UniqueId.h>
#include <trBase/SmrtPtr.h>

#include <stdlib.h>
#include <vector>

namespace trManager
{
    class TR_MANAGER_EXPORT ActorBase : public trManager::EntityBase
    {
    public:

        using BaseClass = trManager::EntityBase;                

        const static trUtil::RefStr CLASS_TYPE;                 

        ActorBase(const std::string& name = CLASS_TYPE);

        virtual const std::string& GetType() const override = 0;

        virtual void RegisterForMessage(const std::string& messageType, const std::string& invokableName);

        virtual void UnRegisterFromMessage(const std::string& messageType);

        virtual void RegisterForMessagesAboutEntity(const trBase::UniqueId& aboutEntityId, const std::string& invokableName);

        virtual void UnregisterFromMessagesAboutEntity(const trBase::UniqueId& aboutEntityId);

        virtual void BuildInvokables();

        virtual void OnTick(const trManager::MessageBase& msg) = 0;

        virtual void OnTickRemote(const trManager::MessageBase& msg);

        virtual bool SendMessage(const trManager::MessageBase& message);

        virtual bool SendNetworkMessage(const trManager::MessageBase& message);

        virtual bool AddActorModule(trManager::EntityBase& actorModule);

        virtual bool RemoveActorModule(trManager::EntityBase& actorModule);

        virtual bool RemoveActorModule(const trBase::UniqueId& id);

        virtual bool RemoveAllActorModules();

        virtual trManager::EntityBase* FindActorModule(const trBase::UniqueId& id);

        virtual void OnAddedToSysMan() override;

        virtual void OnRemovedFromSysMan() override;

    protected:

        ~ActorBase();

        virtual void ActorModuleTick(const trManager::MessageBase& tickMsg);

    private:

        using ActorModules = std::vector<trBase::SmrtPtr<trManager::EntityBase>>;
        ActorModules mActorModules; //Actor Module Storage

        //Temp Storage for actor modules if this actor is disconnected and reconnected from and to System Manager.
        ActorModules mActModReAttachStore;
    };
}