Scripting

What is a script?

Scripting is basic programming. Some advanced programmers have created a special type of programming language with several functions and utilities. Scripting tools allow users to program their own tools (within certain limits), overcome program limitations, or create solutions for specific scenes. You can apply Python language scripts to five areas of RealFlow: batch processes, events, daemons, waves, and fluids. Next Limit has designed a full palette of functions that gives users almost total control over simulations.

Are there any beginner tutorials?

For common, not RealFlow-specific introductions we recommend an internet search. There are many tutorials suited for beginners, intermediates, and advanced users.

If you want to learn how to use Python in conjunction with RealFlow, the most effective way is to analyze existing scripts. There are several resources, e.g.

→ RealFlow Python Quick Start pages
→ RealFlow Python Code Examples
→ waterline magazine "Scripting with RealFlow" (free).
→ Pluralsight (commercial, formerly "DigitalTutors").

Is there a Python reference?

Go to RealFlow's main menu and choose Help > Scripting Reference...

Is there an online Python reference?

Currently there is no online reference, but all help files are in HTML format and can be displayed in a browser. They are located in RealFlow's application folder:

Linux	`/realflow/doc/help/scripting`
OS X	`/Applications/RealFlow 2016/doc/help/scripting`
Windows	`C:\Programs\Next Limit\RealFlow 2016\doc\help\scripting`

How do I place or load python scripts into the GUI version of RealFlow?

See → "Adding Python Scripts" for detailed information.

What is batch scripting?

Batch scripts are normally used to complete repetitive tasks, for example parameter changes, import of objects, applying colours, normalizing channels, object creation and manipulation, and so on. All these tasks do not need a simulation and they can be executed “offline”.

What is a simulation script?

Simulation scripts are executed during a simulation and their main purpose is the manipulation and creation of particles. But, they are also used to influence object positions, RealWave surface, write maps, activate or deactivate nodes on demand, etc.