This is an attempt at some documentation of my ScriptFX system. Here are the major features:

This was released under the LGPL in 2007 April - see this forum post

  • Interfaces can be designed for any scripting language, or any other means of input. An interface for Lua is included.
  • Create and control particle systems, meshes, billboards, and other ScriptFX effects through commands including Move, Rotate, Scale, and Tint.
  • Nest effects to create complex effects with less effort.
  • Get and set varibles on effects from LUA, without having to define them in C++.
  • You can use anything legal in your scripting language of choice, the only catch being how your language and ScriptFX communicate.
  • Call a scripting function every frame to update the effect however you wish, creating unlimited possibility.
  • Cleanly halt and hide an effect, including allowing existing particles to die out naturally, through the FXStop command. Effects can then easily be resumed with FXResume.
  • An Age variable, automatically updated on every effect, accessable through scripting, allowing timed events.


Link to .zip file (~7 megs, includes everything you need, no Ogre required): http://www.paranoidstudios.com/ScriptFX.zip
Just download, extract, run, and have fun with the .lua file.
Note that I have no error checking in, so if you screw something up, it will crash. Just work slowly and if something crashes, go back through and comment out lines to see where you crashed (Lua comments start with , so comment)

Source Code Download
I have finally cleaned up the code for release, months later. Sorry! Click here to download: http://www.paranoidstudios.com/ScriptFXsrc.zip
Download it and have even more fun. This should, emphasis on should, include everything you need, other than Ogre, Lua and Luabind. Install those and run. The source includes the effects demo I created, so you can get to messing around in the code as soon as possible. If you have any questions, contact me at urthenrampage on AIM, or urthen@paranoidstudios.com. I'll try and help as much as I can. Documentation is sparse in places but all names make it fairly obvious what things do. Good luck! If you make any modifications/extensions, email them to me and I'll see if I can include them in. (Code released under GNU LGPL - Ignore internal License.txt until I update that)

Here are some very short descriptions of the functions and what they take:

  • Variables:
    • string GetVar(string name); returns a variable from the effect. Returns "" if the variable isnt found. The string can be converted with tonumber() if required.
    • void SetVar(string name, string value); sets a variable on the effect. Note only string values can be passed, use tostring() if you need to pass a number.

  • Subeffect Creation
    • FXAddNode(string name) creates a SubNode. The subnode is invisible, but you can attach other subeffects, including subnodes, to it. It can be rotated and scaled.
    • FXAddEffect(string name, string effect) attaches another effect as a subeffect to this one. This effect can be moved, rotated, and scaled like any other subeffect. It cannot be tinted.
    • FXAddParticles(string name, string script) attaches a particlesystem. Scaling the system does not scale the particles but will scale the emitters, due to ogre restrictions. Tinting will tint the particles.
    • FXAddBillboard(string name, string material) attaches a single billboard. Scaling only uses the first two values of the function to set the height and width. Rotating can only be set, rather than roll/pitch/yaw. As such only the first value of the rotation function is used. Tinting colors the billboard.
    • FXAddMesh(string name, string mesh) attaches a mesh. Scaling, rotating, moving work normally. Tinting does not work.

  • Subeffect Manipulation (all angular measurements in degrees)
    • FXMove(string name, float x, float y, float z) moves the node the subeffect is attached to. If it is a subnode, it will move everything attached to that subnode as well.
    • FXRotate(string name, float pitch, float yaw, float roll) rotates the node, or in the case of a billboard, the texture is rotated to the pitch value.
    • FXScale(string name, float x, float y, float z) scales the node, or in the case of a billboard, sets the width and hight to the x and y values.
    • FXTint(string name, float red, float green, float blue) tints a billboard or a particlesystem. It uses the standard 0-1 system as Ogre.
    • FXKill(string name) instantly destroys any effect. If a SubNode is destroyed, anything attached will be re-attached to the effects' root node.
    • FXStop(string name) neatly stops all particlesystem emitters, hides billboards and meshes, and calls a full pause on effects. It has no function on SubNodes.
    • FXResume(string name) will reverse the effects of FXStop
    • FXAttach(string nameAnchor, string nameAttached) will attach the nameAttached subeffect to the nameAnchor subnode. If nameAnchor is not a subnode, it will do nothing.


If you try and create a subeffect with a duplicate name as one inside the same effect, it will fail silently. If you try and manipulate a subeffect that does not exist, it will also fail silently. Dont try and attach anything to itself or one of it's children, Ogre will probably crash.

Here are some screenshots for the little cutscene I put together using only my effects system.
(Note, FPS is relatively low because I ran this in debug mode. I re-ran it in release mode and got an average around 300 FPS. So its not horrendously slow, just FYI.)

ScriptFX_1.jpg
ScriptFX_2.jpg
ScriptFX_3.jpg
ScriptFX_4.jpg

Actual C++ code required to implement the entire demo, other than the internal effects code:

(Upon Ogre initialization)

mEffectManager = new ScriptFX::EffectManager(mSceneMgr, new ScriptFX::LuaInterface());
 ScriptFX::Effect* created = mEffectManager->AddEffect("demo");

(Every frame)

LuatestApp::getSingleton().getEffectManager()->doCycle(evt.timeSinceLastFrame);

<HR>
Creative Commons Copyright -- Some rights reserved.


THE WORK (AS DEFINED BELOW) IS PROVIDED UNDER THE TERMS OF THIS CREATIVE COMMONS PUBLIC LICENSE ("CCPL" OR "LICENSE"). THE WORK IS PROTECTED BY COPYRIGHT AND/OR OTHER APPLICABLE LAW. ANY USE OF THE WORK OTHER THAN AS AUTHORIZED UNDER THIS LICENSE OR COPYRIGHT LAW IS PROHIBITED.

BY EXERCISING ANY RIGHTS TO THE WORK PROVIDED HERE, YOU ACCEPT AND AGREE TO BE BOUND BY THE TERMS OF THIS LICENSE. THE LICENSOR GRANTS YOU THE RIGHTS CONTAINED HERE IN CONSIDERATION OF YOUR ACCEPTANCE OF SUCH TERMS AND CONDITIONS.

1. Definitions

  • "Collective Work" means a work, such as a periodical issue, anthology or encyclopedia, in which the Work in its entirety in unmodified form, along with a number of other contributions, constituting separate and independent works in themselves, are assembled into a collective whole. A work that constitutes a Collective Work will not be considered a Derivative Work (as defined below) for the purposes of this License.
  • "Derivative Work" means a work based upon the Work or upon the Work and other pre-existing works, such as a translation, musical arrangement, dramatization, fictionalization, motion picture version, sound recording, art reproduction, abridgment, condensation, or any other form in which the Work may be recast, transformed, or adapted, except that a work that constitutes a Collective Work will not be considered a Derivative Work for the purpose of this License. For the avoidance of doubt, where the Work is a musical composition or sound recording, the synchronization of the Work in timed-relation with a moving image ("synching") will be considered a Derivative Work for the purpose of this License.
  • "Licensor" means the individual or entity that offers the Work under the terms of this License.
  • "Original Author" means the individual or entity who created the Work.
  • "Work" means the copyrightable work of authorship offered under the terms of this License.
  • "You" means an individual or entity exercising rights under this License who has not previously violated the terms of this License with respect to the Work, or who has received express permission from the Licensor to exercise rights under this License despite a previous violation.
  • "License Elements" means the following high-level license attributes as selected by Licensor and indicated in the title of this License: Attribution, ShareAlike.

2. Fair Use Rights

Nothing in this license is intended to reduce, limit, or restrict any rights arising from fair use, first sale or other limitations on the exclusive rights of the copyright owner under copyright law or other applicable laws.

3. License Grant

Subject to the terms and conditions of this License, Licensor hereby grants You a worldwide, royalty-free, non-exclusive, perpetual (for the duration of the applicable copyright) license to exercise the rights in the Work as stated below:

  • to reproduce the Work, to incorporate the Work into one or more Collective Works, and to reproduce the Work as incorporated in the Collective Works;
  • to create and reproduce Derivative Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission the Work including as incorporated in Collective Works;
  • to distribute copies or phonorecords of, display publicly, perform publicly, and perform publicly by means of a digital audio transmission Derivative Works.
  • For the avoidance of doubt, where the work is a musical composition:
    • Performance Royalties Under Blanket Licenses. Licensor waives the exclusive right to collect, whether individually or via a performance rights society (e.g. ASCAP, BMI, SESAC), royalties for the public performance or public digital performance (e.g. webcast) of the Work.
    • Mechanical Rights and Statutory Royalties. Licensor waives the exclusive right to collect, whether individually or via a music rights society or designated agent (e.g. Harry Fox Agency), royalties for any phonorecord You create from the Work ("cover version") and distribute, subject to the compulsory license created by 17 USC Section 115 of the US Copyright Act (or the equivalent in other jurisdictions).
    • Webcasting Rights and Statutory Royalties. For the avoidance of doubt, where the Work is a sound recording, Licensor waives the exclusive right to collect, whether individually or via a performance-rights society (e.g. SoundExchange), royalties for the public digital performance (e.g. webcast) of the Work, subject to the compulsory license created by 17 USC Section 114 of the US Copyright Act (or the equivalent in other jurisdictions).


The above rights may be exercised in all media and formats whether now known or hereafter devised. The above rights include the right to make such modifications as are technically necessary to exercise the rights in other media and formats. All rights not expressly granted by Licensor are hereby reserved.

4. Restrictions

The license granted in Section 3 above is expressly made subject to and limited by the following restrictions:

  • You may distribute, publicly display, publicly perform, or publicly digitally perform the Work only under the terms of this License, and You must include a copy of, or the Uniform Resource Identifier for, this License with every copy or phonorecord of the Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Work that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder. You may not sublicense the Work. You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Work itself to be made subject to the terms of this License. If You create a Collective Work, upon notice from any Licensor You must, to the extent practicable, remove from the Collective Work any credit as required by clause 4(c), as requested. If You create a Derivative Work, upon notice from any Licensor You must, to the extent practicable, remove from the Derivative Work any credit as required by clause 4(c), as requested.
  • You may distribute, publicly display, publicly perform, or publicly digitally perform a Derivative Work only under the terms of this License, a later version of this License with the same License Elements as this License, or a Creative Commons iCommons license that contains the same License Elements as this License (e.g. Attribution-ShareAlike 2.5 Japan). You must include a copy of, or the Uniform Resource Identifier for, this License or other license specified in the previous sentence with every copy or phonorecord of each Derivative Work You distribute, publicly display, publicly perform, or publicly digitally perform. You may not offer or impose any terms on the Derivative Works that alter or restrict the terms of this License or the recipients' exercise of the rights granted hereunder, and You must keep intact all notices that refer to this License and to the disclaimer of warranties. You may not distribute, publicly display, publicly perform, or publicly digitally perform the Derivative Work with any technological measures that control access or use of the Work in a manner inconsistent with the terms of this License Agreement. The above applies to the Derivative Work as incorporated in a Collective Work, but this does not require the Collective Work apart from the Derivative Work itself to be made subject to the terms of this License.
  • If you distribute, publicly display, publicly perform, or publicly digitally perform the Work or any Derivative Works or Collective Works, You must keep intact all copyright notices for the Work and provide, reasonable to the medium or means You are utilizing: (i) the name of the Original Author (or pseudonym, if applicable) if supplied, and/or (ii) if the Original Author and/or Licensor designate another party or parties (e.g. a sponsor institute, publishing entity, journal) for attribution in Licensor's copyright notice, terms of service or by other reasonable means, the name of such party or parties; the title of the Work if supplied; to the extent reasonably practicable, the Uniform Resource Identifier, if any, that Licensor specifies to be associated with the Work, unless such URI does not refer to the copyright notice or licensing information for the Work; and in the case of a Derivative Work, a credit identifying the use of the Work in the Derivative Work (e.g., "French translation of the Work by Original Author," or "Screenplay based on original Work by Original Author"). Such credit may be implemented in any reasonable manner; provided, however, that in the case of a Derivative Work or Collective Work, at a minimum such credit will appear where any other comparable authorship credit appears and in a manner at least as prominent as such other comparable authorship credit.

5. Representations, Warranties and Disclaimer

UNLESS OTHERWISE AGREED TO BY THE PARTIES IN WRITING, LICENSOR OFFERS THE WORK AS-IS AND MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND CONCERNING THE MATERIALS, EXPRESS, IMPLIED, STATUTORY OR OTHERWISE, INCLUDING, WITHOUT LIMITATION, WARRANTIES OF TITLE, MERCHANTIBILITY, FITNESS FOR A PARTICULAR PURPOSE, NONINFRINGEMENT, OR THE ABSENCE OF LATENT OR OTHER DEFECTS, ACCURACY, OR THE PRESENCE OF ABSENCE OF ERRORS, WHETHER OR NOT DISCOVERABLE. SOME JURISDICTIONS DO NOT ALLOW THE EXCLUSION OF IMPLIED WARRANTIES, SO SUCH EXCLUSION MAY NOT APPLY TO YOU.

6. Limitation on Liability.

EXCEPT TO THE EXTENT REQUIRED BY APPLICABLE LAW, IN NO EVENT WILL LICENSOR BE LIABLE TO YOU ON ANY LEGAL THEORY FOR ANY SPECIAL, INCIDENTAL, CONSEQUENTIAL, PUNITIVE OR EXEMPLARY DAMAGES ARISING OUT OF THIS LICENSE OR THE USE OF THE WORK, EVEN IF LICENSOR HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. Termination

  • This License and the rights granted hereunder will terminate automatically upon any breach by You of the terms of this License. Individuals or entities who have received Derivative Works or Collective Works from You under this License, however, will not have their licenses terminated provided such individuals or entities remain in full compliance with those licenses. Sections 1, 2, 5, 6, 7, and 8 will survive any termination of this License.
  • Subject to the above terms and conditions, the license granted here is perpetual (for the duration of the applicable copyright in the Work). Notwithstanding the above, Licensor reserves the right to release the Work under different license terms or to stop distributing the Work at any time; provided, however that any such election will not serve to withdraw this License (or any other license that has been, or is required to be, granted under the terms of this License), and this License will continue in full force and effect unless terminated as stated above.

8. Miscellaneous

  • Each time You distribute or publicly digitally perform the Work or a Collective Work, the Licensor offers to the recipient a license to the Work on the same terms and conditions as the license granted to You under this License.
  • Each time You distribute or publicly digitally perform a Derivative Work, Licensor offers to the recipient a license to the original Work on the same terms and conditions as the license granted to You under this License.
  • If any provision of this License is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this License, and without further action by the parties to this agreement, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
  • No term or provision of this License shall be deemed waived and no breach consented to unless such waiver or consent shall be in writing and signed by the party to be charged with such waiver or consent.
  • This License constitutes the entire agreement between the parties with respect to the Work licensed here. There are no understandings, agreements or representations with respect to the Work not specified here. Licensor shall not be bound by any additional provisions that may appear in any communication from You. This License may not be modified without the mutual written agreement of the Licensor and You.