Core
Python API events
Read time 2 minutesLast updated 19 hours ago
AfterEntityPropertyChanged
def onAfterEntityPropertyChanged(entity, property, entityType): passid = 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): passid = core.addAfterModulePropertyChangedCallback(onAfterModulePropertyChanged)...core.removeAfterModulePropertyChangedCallback(id)
Parameters
Type | Name | Description |
|---|
| String | module | Module changed. |
| String | property | Property changed. |
AfterUndoRedo
def onAfterUndoRedo(onlyPropertyChanged): passid = 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(): passid = core.addAtExitCallback(onAtExit)...core.removeAtExitCallback(id)
BeforeEntityPropertyChanged
def onBeforeEntityPropertyChanged(entity, property): passid = core.addBeforeEntityPropertyChangedCallback(onBeforeEntityPropertyChanged)...core.removeBeforeEntityPropertyChangedCallback(id)
Parameters
Type | Name | Description |
|---|
| Entity | entity | Entity changed. |
| String | property | Property changed. |
BeforeModulePropertyChanged
def onBeforeModulePropertyChanged(module, property): passid = core.addBeforeModulePropertyChangedCallback(onBeforeModulePropertyChanged)...core.removeBeforeModulePropertyChangedCallback(id)
Parameters
Type | Name | Description |
|---|
| String | module | Module changed. |
| String | property | Property changed. |
BeforeSessionReset
def onBeforeSessionReset(): passid = core.addBeforeSessionResetCallback(onBeforeSessionReset)...core.removeBeforeSessionResetCallback(id)
BeforeUndoRedo
def onBeforeUndoRedo(onlyPropertyChanged): passid = 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(): passid = core.addCurrentFileChangedCallback(onCurrentFileChanged)...core.removeCurrentFileChangedCallback(id)
EnteringUnsafeMode
def onEnteringUnsafeMode(): passid = core.addEnteringUnsafeModeCallback(onEnteringUnsafeMode)...core.removeEnteringUnsafeModeCallback(id)
EntityDestroyed
def onEntityDestroyed(entity): passid = core.addEntityDestroyedCallback(onEntityDestroyed)...core.removeEntityDestroyedCallback(id)
Parameters
Type | Name | Description |
|---|
| Entity | entity | Entity detroyed. |
LeavingUnsafeMode
def onLeavingUnsafeMode(): passid = core.addLeavingUnsafeModeCallback(onLeavingUnsafeMode)...core.removeLeavingUnsafeModeCallback(id)
LicenseClientDisconnected
def onLicenseClientDisconnected(): passid = core.addLicenseClientDisconnectedCallback(onLicenseClientDisconnected)...core.removeLicenseClientDisconnectedCallback(id)
LicenseClientReconnected
def onLicenseClientReconnected(): passid = core.addLicenseClientReconnectedCallback(onLicenseClientReconnected)...core.removeLicenseClientReconnectedCallback(id)
OnConsoleMessage
def onOnConsoleMessage(text, verboseLevel): passid = core.addOnConsoleMessageCallback(onOnConsoleMessage)...core.removeOnConsoleMessageCallback(id)
Parameters
Type | Name | Description |
|---|
| String | text | Message content. |
| Verbose | verboseLevel | Verbose level. |
OnSessionReset
def onOnSessionReset(): passid = core.addOnSessionResetCallback(onOnSessionReset)...core.removeOnSessionResetCallback(id)
ProgressChanged
def onProgressChanged(progress): passid = core.addProgressChangedCallback(onProgressChanged)...core.removeProgressChangedCallback(id)
Parameters
Type | Name | Description |
|---|
| Int | progress | Current progression. |
ProgressStepFinished
def onProgressStepFinished(): passid = core.addProgressStepFinishedCallback(onProgressStepFinished)...core.removeProgressStepFinishedCallback(id)
ProgressStepStart
def onProgressStepStart(stepName): passid = core.addProgressStepStartCallback(onProgressStepStart)...core.removeProgressStepStartCallback(id)
Parameters
Type | Name | Description |
|---|
| String | stepName | Name of the started step. |
DebugEvent
def onDebugEvent(event_type): passid = 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): passid = 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(): passid = core.addUndoRedoStackChangedCallback(onUndoRedoStackChanged)...core.removeUndoRedoStackChangedCallback(id)