ezEngine  Release 25.03
Classes | Public Member Functions | Static Public Attributes | List of all members
ezEditorEngineProcessConnection Class Reference

Classes

struct  Event
 

Public Member Functions

void SetFileSystemConfig (const ezApplicationFileSystemConfig &cfg)
 The given file system configuration will be used by the engine process to setup the runtime data directories. This only takes effect if the editor process is restarted.
 
void SetPluginConfig (const ezApplicationPluginConfig &cfg)
 The given plugin configuration will be used by the engine process to load runtime plugins. This only takes effect if the editor process is restarted.
 
void Update ()
 
ezResult RestartProcess ()
 
void ShutdownProcess ()
 
bool IsProcessCrashed () const
 
ezEditorEngineConnection * CreateEngineConnection (ezAssetDocument *pDocument)
 
void DestroyEngineConnection (ezAssetDocument *pDocument)
 
bool SendMessage (ezProcessMessage *pMessage)
 
ezResult WaitForMessage (const ezRTTI *pMessageType, ezTime timeout, ezProcessCommunicationChannel ::WaitForMessageCallback *pCallback=nullptr)
 
ezResult WaitForDocumentMessage (const ezUuid &assetGuid, const ezRTTI *pMessageType, ezTime timeout, ezProcessCommunicationChannel::WaitForMessageCallback *pCallback=nullptr)
 
bool IsEngineSetup () const
 
void ActivateRemoteProcess (const ezAssetDocument *pDocument, ezUInt32 uiViewID)
 
ezProcessCommunicationChannel & GetCommunicationChannel ()
 

Static Public Attributes

static ezEvent< const Event & > s_Events
 

Member Function Documentation

◆ WaitForDocumentMessage()

ezResult ezEditorEngineProcessConnection::WaitForDocumentMessage ( const ezUuid &  assetGuid,
const ezRTTI *  pMessageType,
ezTime  timeout,
ezProcessCommunicationChannel::WaitForMessageCallback *  pCallback = nullptr 
)

/brief Same as WaitForMessage but the message must be to a specific document. Therefore, pMessageType must be derived from ezEditorEngineDocumentMsg and the function will only return if the received message matches both type, document and is accepted by pCallback.

◆ WaitForMessage()

ezResult ezEditorEngineProcessConnection::WaitForMessage ( const ezRTTI *  pMessageType,
ezTime  timeout,
ezProcessCommunicationChannel ::WaitForMessageCallback *  pCallback = nullptr 
)

/brief Waits for a message of type pMessageType. If tTimeout is zero, the function will not timeout. If the timeout is valid and is it, EZ_FAILURE is returned. If the message type matches and pCallback is valid, the function will be called and the return values decides whether the message is to be accepted and the waiting has ended.

The documentation for this class was generated from the following files: