View source for IC 8 Python API:Enforcing Plugin Compatibility

{{TOC}}

{{Parent|IC_8_Python_API|iC8 Python API}}

In order to have Plugins run correctly in face of an ever-changing environment (resulting from continuous addition and modification of iClone functions and Python API), iClone 8 has introduced a checking mechanism for plugin compatibility. By adding "rl_plugin_info" in the '''main.py''' file, the plugin can be limited to certain environments.

<syntaxhighlight lang="python" line='line'>
rl_plugin_info = { "ap": "iClone", "ap_version": "8.0" }
</syntaxhighlight>

'''ap''' in '''rl_plugin_info''' limits the plugin to certain programs (possible values are "iClone", "Character Creator", or "Any"). "Any" indicates that the plugin can be run on both iClone and Character Creator; and even at the same time. The '''ap_version''' limits the plugin to certain version numbers. Again, "Any" dictates that the plugin can run in any version. Possible values are as follows:

<syntaxhighlight lang="python" line='line'>
# for iClone 8.0 and later version
rl_plugin_info = { "ap": "iClone", "ap_version": "8.0" }
# for iClone only
rl_plugin_info = { "ap": "iClone", "ap_version": "Any" }
# for Character Creator 4.0 and later version
rl_plugin_info = { "ap": "Character Creator", "ap_version": "4.0" }
# for Character Creator only
rl_plugin_info = { "ap": "Character Creator", "ap_version": "Any" }
# for iClone or Character Creator
rl_plugin_info = { "ap": "Any", "ap_version": "Any" }
</syntaxhighlight>

When iClone 8 checks the plugin and encounters incompatibility issues, the following warning message will appear. 

[[File:Ic8_python_api_checking_plugin_compatibility_01.png]]

This message indicates that there could be problems associated with running an incompatible plugin and users can choose to proceed at their own risk.