README - AddSourceScol plugIT

This plugIT allows you to run any code written in Scol to OpenSpace3D.

Author : Stéphane Bisaro, aka iri <iri@irizone.net>
Date : november, 2011
License : GNU LGPL 2.1 or more (see COPYING file in the same folder)
Support : http://www.scolring.org/

History :
=========

1.01 : november 20, 2011
- with Run action, test if there is a parameter or not.

1.0 : nomvembre 20, 201
- first version


How to install :
================

You must have already installed Openspace3d.
Copy this folder ("addsourcecode") in this sub-directry :
Partition_LockedApp > tools > os3dplugins > misc

"Partition_LockedApp" is in your Scol directory (by default : 
C:\Program Files\Scol Voyager)

Restart Openspace3d, if any.


How to use :
============

Like any other plugin !
In the Tree editor, search it in the "misc" section.

In its editor, enter the code to run in the first field.
Enter the name of the called function in the second field.
Apply / Ok.

Actions :
- Run : run the code.
In parameter field, you can add a string argument to your called function.
In this case, make sure you have set this argument in the function.
If no parameter, the function takes no argument.

- Stop : stop the last executed code
No parameter

- GetCount : number of currently running code
No parameter

Events :
- Done : a code has been launched

- Error : a code has NOT been launched

- Stopped : a code has been killed (after a Stop action)

- GetCount : return the number in the parameter (after a GetCount action)


Have fun !
iri