Chapter 4 · The TnpixTool Interface

4.10Licence

Function Returns What it does

licInfo() string The licence state of this computer: free, demo or activated, the build (build=rc, rc-beta or rc-demo), the demo's limits (cap= vertices, frames= at the scene's frame rate) and farm=, why this session counts as a farm session or no.

licCap() integer The demo's vertex limit for the whole scene (25000).

licActivate key string Activate this machine with a key; returns the outcome.

licCheck force string Check now with the store (true) or only when the check is due (false).

licDeactivate() string Deactivate this machine.

Function	Returns	What it does
`licInfo()`	string	The licence state of this computer: free, demo or activated, the build (build=rc, rc-beta or rc-demo), the demo's limits (cap= vertices, frames= at the scene's frame rate) and farm=, why this session counts as a farm session or no.
`licCap()`	integer	The demo's vertex limit for the whole scene (25000).
`licActivate key`	string	Activate this machine with a key; returns the outcome.
`licCheck force`	string	Check now with the store (`true`) or only when the check is due (`false`).
`licDeactivate()`	string	Deactivate this machine.

In the demo build (rc-demo) licInfo() always reports state=demo and key=none, and licActivate, licCheck and licDeactivate refuse with a sentence that names the demo build: it takes no key.

Do not put a licence key in a script you share: it is your purchase.

cache, lanes, instState, serState, serForceOff, custEditProbe, layers, debug, getDebug and debugFile are test instruments for the product's own checks and are not part of the scripting interface; in the released build they do nothing.