Menu
Lumberyard
C++ API Reference (Version 1.10)

AZ::SerializeContext::IEventHandler Class Reference

You can use this class if you want special functions to run before reading or writing a class. More...

Public Member Functions

virtual ~IEventHandler ()
 A destructor. More...
 
virtual void OnReadBegin (void *classPtr)
 Called right before beginning to read from a class instance. More...
 
virtual void OnReadEnd (void *classPtr)
 Called right after reading from a class instance is complete. More...
 
virtual void OnWriteBegin (void *classPtr)
 Called right before beginning to write to a class instance. More...
 
virtual void OnWriteEnd (void *classPtr)
 Called right after writing to a class instance is complete. More...
 

Detailed Description

You can use this class if you want special functions to run before reading or writing a class.

IMPORTANT: Serialize events can be called from serialization thread(s), so all functions must be thread safe.

Constructor & Destructor Documentation

◆ ~IEventHandler()

virtual AZ::SerializeContext::IEventHandler::~IEventHandler ( )
inlinevirtual

A destructor.

Member Function Documentation

◆ OnReadBegin()

virtual void AZ::SerializeContext::IEventHandler::OnReadBegin ( void *  classPtr)
inlinevirtual

Called right before beginning to read from a class instance.

Parameters
classPtrA pointer to the class instance.

◆ OnReadEnd()

virtual void AZ::SerializeContext::IEventHandler::OnReadEnd ( void *  classPtr)
inlinevirtual

Called right after reading from a class instance is complete.

Parameters
classPtrA pointer to the class instance.

◆ OnWriteBegin()

virtual void AZ::SerializeContext::IEventHandler::OnWriteBegin ( void *  classPtr)
inlinevirtual

Called right before beginning to write to a class instance.

Parameters
classPtrA pointer to the class instance.

◆ OnWriteEnd()

virtual void AZ::SerializeContext::IEventHandler::OnWriteEnd ( void *  classPtr)
inlinevirtual

Called right after writing to a class instance is complete.

Parameters
classPtrA pointer to the class instance.

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