Code/CryEngine/CrySchematyc2/Script/Elements/ScriptActionInstance.cpp

   1 // Copyright 2001-2019 Crytek GmbH / Crytek Group. All rights reserved.
   2
   3 #include "StdAfx.h"
   4 #include "Script/Elements/ScriptActionInstance.h"
   5
   6 #include <CrySerialization/BlackBox.h>
   7 #include <CrySerialization/IArchiveHost.h>
   8 #include <CrySerialization/STL.h>
   9 #include <CrySchematyc2/GUIDRemapper.h>
  10 #include <CrySchematyc2/IAbstractInterface.h>
  11 #include <CrySchematyc2/ICompiler.h>
  12 #include <CrySchematyc2/Deprecated/DocUtils.h>
  13 #include <CrySchematyc2/Env/IEnvRegistry.h>
  14 #include <CrySchematyc2/Serialization/ISerializationContext.h>
  15 #include <CrySchematyc2/Serialization/SerializationUtils.h>
  16
  17 namespace Schematyc2
  18 {
  19         //////////////////////////////////////////////////////////////////////////
  20         CScriptActionInstance::CScriptActionInstance(IScriptFile& file, const SGUID& guid, const SGUID& scopeGUID, const char* szName, const SGUID& actionGUID, const SGUID& componentInstanceGUID)
  21                 : CScriptElementBase(EScriptElementType::ActionInstance, file)
  22                 , m_guid(guid)
  23                 , m_scopeGUID(scopeGUID)
  24                 , m_name(szName)
  25                 , m_actionGUID(actionGUID)
  26                 , m_componentInstanceGUID(componentInstanceGUID)
  27         {
  28                 RefreshAction();
  29         }
  30
  31         //////////////////////////////////////////////////////////////////////////
  32         EAccessor CScriptActionInstance::GetAccessor() const
  33         {
  34                 return EAccessor::Private;
  35         }
  36
  37         //////////////////////////////////////////////////////////////////////////
  38         SGUID CScriptActionInstance::GetGUID() const
  39         {
  40                 return m_guid;
  41         }
  42
  43         //////////////////////////////////////////////////////////////////////////
  44         SGUID CScriptActionInstance::GetScopeGUID() const
  45         {
  46                 return m_scopeGUID;
  47         }
  48
  49         //////////////////////////////////////////////////////////////////////////
  50         bool CScriptActionInstance::SetName(const char* szName)
  51         {
  52                 m_name = szName;
  53                 return true;
  54         }
  55
  56         //////////////////////////////////////////////////////////////////////////
  57         const char* CScriptActionInstance::GetName() const
  58         {
  59                 return m_name.c_str();
  60         }
  61
  62         //////////////////////////////////////////////////////////////////////////
  63         void CScriptActionInstance::EnumerateDependencies(const ScriptDependancyEnumerator& enumerator) const {}
  64
  65         //////////////////////////////////////////////////////////////////////////
  66         void CScriptActionInstance::Refresh(const SScriptRefreshParams& params) {}
  67
  68         //////////////////////////////////////////////////////////////////////////
  69         void CScriptActionInstance::Serialize(Serialization::IArchive& archive)
  70         {
  71                 CRY_PROFILE_FUNCTION(PROFILE_LOADING_ONLY);
  72
  73                 CScriptElementBase::Serialize(archive);
  74
  75                 SerializationContext::SetValidatorLink(archive, SValidatorLink(m_guid)); // #SchematycTODO : Can we set this from CScriptElementBase?
  76                 switch(SerializationContext::GetPass(archive))
  77                 {
  78                 case ESerializationPass::PreLoad:
  79                 case ESerializationPass::Save:
  80                         {
  81                                 archive(m_guid, "guid");
  82                                 archive(m_scopeGUID, "scope_guid");
  83                                 archive(m_name, "name");
  84                                 archive(m_actionGUID, "action_guid");
  85                                 archive(m_componentInstanceGUID, "component_instance_guid");
  86                                 if(archive.isInput())
  87                                 {
  88                                         RefreshAction();
  89                                 }
  90                                 SerializeProperties(archive);
  91                                 break;
  92                         }
  93                 case ESerializationPass::Edit:
  94                         {
  95                                 if(archive.isOutput())
  96                                 {
  97                                         IActionFactoryConstPtr pFactory = gEnv->pSchematyc2->GetEnvRegistry().GetActionFactory(m_actionGUID);
  98                                         if(pFactory)
  99                                         {
 100                                                 string action = pFactory->GetName();
 101                                                 archive(action, "action", "!Action");
 102                                         }
 103                                 }
 104                                 SerializeProperties(archive);
 105                                 break;
 106                         }
 107                 }
 108         }
 109
 110         //////////////////////////////////////////////////////////////////////////
 111         void CScriptActionInstance::RemapGUIDs(IGUIDRemapper& guidRemapper)
 112         {
 113                 m_guid                  = guidRemapper.Remap(m_guid);
 114                 m_scopeGUID             = guidRemapper.Remap(m_scopeGUID);
 115                 m_componentInstanceGUID = guidRemapper.Remap(m_componentInstanceGUID);
 116         }
 117
 118         //////////////////////////////////////////////////////////////////////////
 119         SGUID CScriptActionInstance::GetActionGUID() const
 120         {
 121                 return m_actionGUID;
 122         }
 123
 124         //////////////////////////////////////////////////////////////////////////
 125         SGUID CScriptActionInstance::GetComponentInstanceGUID() const
 126         {
 127                 return m_componentInstanceGUID;
 128         }
 129
 130         //////////////////////////////////////////////////////////////////////////
 131         IPropertiesConstPtr CScriptActionInstance::GetProperties() const
 132         {
 133                 return m_pProperties;
 134         }
 135
 136         //////////////////////////////////////////////////////////////////////////
 137         void CScriptActionInstance::RefreshAction()
 138         {
 139                 IActionFactoryConstPtr pFactory = gEnv->pSchematyc2->GetEnvRegistry().GetActionFactory(m_actionGUID);
 140                 m_pProperties = pFactory ? pFactory->CreateProperties() : IPropertiesPtr();
 141         }
 142
 143         //////////////////////////////////////////////////////////////////////////
 144         void CScriptActionInstance::SerializeProperties(Serialization::IArchive& archive)
 145         {
 146                 if(m_pProperties)
 147                 {
 148                         GameSerialization::IContextPtr      pSerializationContext;
 149                         const IScriptComponentInstance* pComponentInstance = CScriptElementBase::GetFile().GetComponentInstance(m_componentInstanceGUID);
 150                         if(pComponentInstance)
 151                         {
 152                                 IPropertiesConstPtr pComponentProperties = pComponentInstance->GetProperties();
 153                                 if(pComponentProperties)
 154                                 {
 155                                         pSerializationContext = pComponentProperties->BindSerializationContext(archive);
 156                                 }
 157                         }
 158                         archive(*m_pProperties, "properties", "Properties");
 159                 }
 160         }
 161 }