simEvents Plugin API reference

API functions for events

simEvents.addChildrenMonitor
simEvents.addProbe
simEvents.removeProbe

Description	Add a children monitor probe to monitor changes in the (direct) children of a scene object.
Lua synopsis	string probeHandle = simEvents.addChildrenMonitor(string callback, int parentHandle)
Lua parameters	callback (string): Callback function to call when children of the scene object change. Arguments are (childrenHandles). parentHandle (int): Handle to the scene object.
Lua return values	probeHandle (string)
Python synopsis	string probeHandle = simEvents.addChildrenMonitor(string callback, int parentHandle)

Description	Add a event probe.
Lua synopsis	string probeHandle = simEvents.addProbe(string callback, any condition)
Lua parameters	callback (string): Callback function to call when an event matches the given condition. Arguments are (eventData). condition (any): Boolean condition (see README).
Lua return values	probeHandle (string): Handle to the newly created probe object.
Python synopsis	string probeHandle = simEvents.addProbe(string callback, any condition)

Description	Remove a previously created event probe.
Lua synopsis	simEvents.removeProbe(string probeHandle)
Lua parameters	probeHandle (string): Handle to the probe object.
Lua return values
Python synopsis	simEvents.removeProbe(string probeHandle)

Script functions

Script functions are used to call some lua code from the plugin side (tipically used for event handlers).

Description	Callback called when children of an object change, used by simEvents.addChildrenMonitor.
Lua synopsis	simEvents.childrenMonitorCallback(int[] childrenHandles)
Lua parameters	childrenHandles (table of int): handles of the children objects
Lua return values	-
Python synopsis	simEvents.childrenMonitorCallback(list childrenHandles)
See also