c4d.plugins.MessageData

A data class for creating message plugins. Use RegisterMessagePlugin() to register the plugin.

Definition

class c4d.plugins.MessageData

• MessageData.GetTimer()
• MessageData.CoreMessage()

Inheritance

• c4d.plugins.BaseData
  • c4d.plugins.MessageData

Methods

MessageData.GetTimer(self)

Override - Return a time in milliseconds to get timer messages with that interval sent to CoreMessage(). This function is queried again by after each message.

Return type: int Returns: The timer interval in milliseconds, or 0 for no timer messages.

MessageData.CoreMessage(self, id, bc)

Override - Receives C4D core messages.

Parameters:

• id (int) –

  The message ID.

  EVMSG_CHANGE	Sent by the EventAdd() function.
  EVMSG_DOCUMENTRECALCULATED	This message is sent while drawing after the animation, expressions and cachebuild have been done. It allows that certain managers (e.g. attribute manager) update their values to the changes done by the expressions etc. Any reactions on this message should be pretty fast! Also please note that no modifying stuff must be done here as the draw thread is running at the same time and accesses the same data!
  EVMSG_TOOLCHANGED	A tool setting has changed (local event).
  EVMSG_GRAPHVIEWCHANGED	Something in XPresso has been changed (local event).
  EVMSG_AUTKEYMODECHANGED	The autokey mode was changed.
  EVMSG_UPDATEHIGHLIGHT	A special message sent by C4D in the case that only the highlighting changes. This happens for example when you move the mouse over the viewport. Plugins usually don’t need to care about this.
  EVMSG_SHOWIN_SB	Show in Scene Browser.
  EVMSG_SHOWIN_TL	Show in Timeline.
  EVMSG_SHOWIN_FC	Show in Function Curve editor.
  EVMSG_SHOWIN_LM	Show in Layer Manager.
  EVMSG_TLOM_MERGE	Private.
  EVMSG_SHOWIN_MT	Show in Motion editor.
  EVMSG_TIMELINESELECTION	A timeline selection has been changed (local event).
  EVMSG_BROWSERCHANGE	Something in the browser has been changed (local event).
  EVMSG_MATERIALSELECTION	A material selection has been changed (local event).
  EVMSG_FCURVECHANGE	Something in the F-Curve manager has been changed (local event).
  EVMSG_RAYTRACER_FINISHED	Private.
  EVMSG_FRAME_SCENE	Private.
  EVMSG_MATERIALPREVIEW	Private.
  EVMSG_ACTIVEVIEWCHANGED	Private.
  EVMSG_ASYNCEDITORMOVE	The user moved something in the editor window. Managers should update things like position fields.
  EVMSG_TIMECHANGED	Private.

• bc (BaseContainer) – The message container.

Return type:

bool

Returns:

Currently not used.