Kig Python Scripting API Documentation
0.10.5
This is the documentation of the Kig Python Scripting API. It is intended as a reference for people using the Kig Python Scripting System. The Documentation is generated from the C++ sources for the classes, and unfortunately, this means that the documentation uses a C++ syntax. However, if you ignore this fact, and simply look at the API as a set of classes with member and static functions, then you should be fine.
This API is mostly meant to be used from user-defined calc() functions. In these functions, it is necessary to
- access the information of the argument Object's
- construct and return a new Object
Both uses require the
Object API to be exported to Python, and this is the major part of this API. Some more classes are also exported, but mostly because they are used from one of the Object's APIs.
Next suggested reading is the
documentation of the Object class.
