IEntityProxy

C++
struct IEntityProxy : public IComponent {
};
File

IEntityProxy.h

Description

Base interface to access to various entity proxy objects.

IEntityProxy::~IEntityProxy Destructor
C++
virtual ~IEntityProxy();
IEntityProxy::Done Method
C++
virtual void Done() = 0;
Description

Called when the entity is destroyed! At this point, all proxies are valid! No memory should be deleted here!

IEntityProxy::GetEventPriority Method
C++
virtual ComponentEventPriority GetEventPriority(const int eventID) const;
IEntityProxy::GetMemoryUsage Method
C++
virtual void GetMemoryUsage(ICrySizer * pSizer) const;
IEntityProxy::GetSignature Method
C++
virtual bool GetSignature(TSerialize signature) = 0;
Parameters
Parameters
Description
ser
the object to serialize with, forming the signature
Returns

true - If the signature is thus far valid

Description

Builds a signature to describe the dynamic hierarchy of the parent Entity container

Notes

It's the responsibility of the proxy to identify its internal state which may complicate the hierarchy of the parent Entity i.e., sub-proxies and which actually exist for this instantiation.

IEntityProxy::GetType Method
C++
virtual EEntityProxy GetType() = 0;
IEntityProxy::Init Method
C++
virtual bool Init(IEntity * pEntity, SEntitySpawnParams & params) = 0;
Description

Called when the subsystem initialize.

IEntityProxy::NeedSerialize Method
C++
virtual bool NeedSerialize() = 0;
Returns

true - If proxy needs to be serialized

Description

Returns true if this proxy need to be saved during serialization.

IEntityProxy::Release Method
C++
virtual void Release() = 0;
Description

When host entity is destroyed every proxy will be called with the Release method to delete itself.

IEntityProxy::Reload Method
C++
virtual void Reload(IEntity * pEntity, SEntitySpawnParams & params) = 0;
Description

Called when the subsystem is reloaded.

IEntityProxy::Serialize Method
C++
virtual void Serialize(TSerialize ser) = 0;
Parameters
Parameters
Description
TSerialize ser
the object to serialize with
Description

Serialize proxy with a TSerialize

IEntityProxy::SerializeXML Method
C++
virtual void SerializeXML(XmlNodeRef & entityNode, bool bLoading) = 0;
Description

Serialize proxy to/from XML.

IEntityProxy::Update Method
C++
virtual void Update(SEntityUpdateContext & ctx) = 0;
Parameters
Parameters
Description
SEntityUpdateContext & ctx
Update context of the host entity, provides all the information needed to update the entity.
Description

Update will be called every time the host Entity is updated.