struct IEntityProxy : public IComponent { };
IEntityProxy.h
Base interface to access to various entity proxy objects.
virtual ~IEntityProxy();
virtual void Done() = 0;
Called when the entity is destroyed! At this point, all proxies are valid! No memory should be deleted here!
virtual ComponentEventPriority GetEventPriority(const int eventID) const;
virtual void GetMemoryUsage(ICrySizer * pSizer) const;
virtual bool GetSignature(TSerialize signature) = 0;
Parameters |
Description |
ser |
the object to serialize with, forming the signature |
true - If the signature is thus far valid
Builds a signature to describe the dynamic hierarchy of the parent Entity container
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.
virtual EEntityProxy GetType() = 0;
virtual bool Init(IEntity * pEntity, SEntitySpawnParams & params) = 0;
Called when the subsystem initialize.
virtual bool NeedSerialize() = 0;
true - If proxy needs to be serialized
Returns true if this proxy need to be saved during serialization.
virtual void Release() = 0;
When host entity is destroyed every proxy will be called with the Release method to delete itself.
virtual void Reload(IEntity * pEntity, SEntitySpawnParams & params) = 0;
Called when the subsystem is reloaded.
virtual void Serialize(TSerialize ser) = 0;
Parameters |
Description |
TSerialize ser |
the object to serialize with |
Serialize proxy with a TSerialize
virtual void SerializeXML(XmlNodeRef & entityNode, bool bLoading) = 0;
Serialize proxy to/from XML.
virtual void Update(SEntityUpdateContext & ctx) = 0;
Parameters |
Description |
SEntityUpdateContext & ctx |
Update context of the host entity, provides all the information needed to update the entity. |
Update will be called every time the host Entity is updated.