vcEventReturnData

Events do not have return values, so having this object as a parameter allows passing some information back from event handler(s) to the event publisher.

Properties

Name Type Access Description
Handled Boolean RW

Defines if this event has already been handled.

This is used when an event should only be handled once. All listeners of the event should begin by checking this value before performing any operations. If True, then no further operations should be performed. Otherwise, logic can continue.

If the listener then handles this event and no further handling should be done to it, the listener should write True here.