Core
Python API events
Read time 2 minutesLast updated 25 days ago
AfterEntityPropertyChanged
def onAfterEntityPropertyChanged(entity, property, entityType): pass id = core.addAfterEntityPropertyChangedCallback(onAfterEntityPropertyChanged) ... core.removeAfterEntityPropertyChangedCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| Entity | entity | Entity changed. |
| String | property | Property changed. |
| Int | entityType | Type of the entity changed. |
AfterModulePropertyChanged
def onAfterModulePropertyChanged(module, property): pass id = core.addAfterModulePropertyChangedCallback(onAfterModulePropertyChanged) ... core.removeAfterModulePropertyChangedCallback(id)
Parameters
AfterUndoRedo
def onAfterUndoRedo(onlyPropertyChanged): pass id = core.addAfterUndoRedoCallback(onAfterUndoRedo) ... core.removeAfterUndoRedoCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| Boolean | onlyPropertyChanged | If true, the change in the undo/redo step is only property changes. |
AtExit
def onAtExit(): pass id = core.addAtExitCallback(onAtExit) ... core.removeAtExitCallback(id)
BeforeEntityPropertyChanged
def onBeforeEntityPropertyChanged(entity, property): pass id = core.addBeforeEntityPropertyChangedCallback(onBeforeEntityPropertyChanged) ... core.removeBeforeEntityPropertyChangedCallback(id)
Parameters
BeforeModulePropertyChanged
def onBeforeModulePropertyChanged(module, property): pass id = core.addBeforeModulePropertyChangedCallback(onBeforeModulePropertyChanged) ... core.removeBeforeModulePropertyChangedCallback(id)
Parameters
BeforeSessionReset
def onBeforeSessionReset(): pass id = core.addBeforeSessionResetCallback(onBeforeSessionReset) ... core.removeBeforeSessionResetCallback(id)
BeforeUndoRedo
def onBeforeUndoRedo(onlyPropertyChanged): pass id = core.addBeforeUndoRedoCallback(onBeforeUndoRedo) ... core.removeBeforeUndoRedoCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| Boolean | onlyPropertyChanged | If true, the change in the undo/redo step is only property changes. |
CurrentFileChanged
def onCurrentFileChanged(): pass id = core.addCurrentFileChangedCallback(onCurrentFileChanged) ... core.removeCurrentFileChangedCallback(id)
EnteringUnsafeMode
def onEnteringUnsafeMode(): pass id = core.addEnteringUnsafeModeCallback(onEnteringUnsafeMode) ... core.removeEnteringUnsafeModeCallback(id)
EntityDestroyed
def onEntityDestroyed(entity): pass id = core.addEntityDestroyedCallback(onEntityDestroyed) ... core.removeEntityDestroyedCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| Entity | entity | Entity detroyed. |
LeavingUnsafeMode
def onLeavingUnsafeMode(): pass id = core.addLeavingUnsafeModeCallback(onLeavingUnsafeMode) ... core.removeLeavingUnsafeModeCallback(id)
LicenseClientDisconnected
def onLicenseClientDisconnected(): pass id = core.addLicenseClientDisconnectedCallback(onLicenseClientDisconnected) ... core.removeLicenseClientDisconnectedCallback(id)
LicenseClientReconnected
def onLicenseClientReconnected(): pass id = core.addLicenseClientReconnectedCallback(onLicenseClientReconnected) ... core.removeLicenseClientReconnectedCallback(id)
OnConsoleMessage
def onOnConsoleMessage(text, verboseLevel): pass id = core.addOnConsoleMessageCallback(onOnConsoleMessage) ... core.removeOnConsoleMessageCallback(id)
Parameters
OnSessionReset
def onOnSessionReset(): pass id = core.addOnSessionResetCallback(onOnSessionReset) ... core.removeOnSessionResetCallback(id)
ProgressChanged
def onProgressChanged(progress): pass id = core.addProgressChangedCallback(onProgressChanged) ... core.removeProgressChangedCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| Int | progress | Current progression. |
ProgressStepFinished
def onProgressStepFinished(): pass id = core.addProgressStepFinishedCallback(onProgressStepFinished) ... core.removeProgressStepFinishedCallback(id)
ProgressStepStart
def onProgressStepStart(stepName): pass id = core.addProgressStepStartCallback(onProgressStepStart) ... core.removeProgressStepStartCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| String | stepName | Name of the started step. |
DebugEvent
def onDebugEvent(event_type): pass id = core.addDebugEventCallback(onDebugEvent) ... core.removeDebugEventCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| Int | event_type | The type of signal to emit. |
AfterCustomPropertyAdded
def onAfterCustomPropertyAdded(entity, property, entityType): pass id = core.addAfterCustomPropertyAddedCallback(onAfterCustomPropertyAdded) ... core.removeAfterCustomPropertyAddedCallback(id)
Parameters
Type | Name | Description |
|---|---|---|
| Entity | entity | Entity with custom property. |
| String | property | Custom property that has been added. |
| Int | entityType | Type of the entity. |
UndoRedoStackChanged
def onUndoRedoStackChanged(): pass id = core.addUndoRedoStackChangedCallback(onUndoRedoStackChanged) ... core.removeUndoRedoStackChangedCallback(id)