SScript is an easy to use Haxe script tool that aims to be simple while supporting all Haxe structures.
haxelib install SScript
Enter this command in command prompt to get the latest release from Haxe library.
haxelib git SScript https://github.com/tahirk786/SScript.git
Enter this command in command prompt to get the latest git release from Github. Git releases have the latest features but they are unstable and can cause problems.
After installing SScript, don't forget to add it to your Haxe project.
Add this to Project.xml to add SScript to your OpenFL project:
<haxelib name="SScript"/>
<haxedef name="hscriptPos"/>Add this to build.hxml to add SScript to your Haxe build.
-lib SScript
-D hscriptPosFlag hscriptPos is needed for error handling at runtime. It is optional but definitely recommended.
To use SScript, you will need a file or a script. Using a file is recommended.
var script:tea.SScript = {}; // Create a new SScript class
script.doScript("
function returnRandom():Float
return Math.random() * 100;
"); // Implement the script
var call = script.call('returnRandom');
var randomNumber:Float = call.returnValue; // Access the returned value with returnValuevar script:tea.SScript = new tea.SScript("script.hx"); // Has the same contents with the script above
var randomNumber:Float = script.call('returnRandom').returnValue;SScript supports both ?. and ?? syntaxes including ??=.
import tea.SScript;
class Main
{
static function main()
{
var script:SScript = {};
script.doScript("
var string:String = null;
trace(string.length); // Throws an error
trace(string?.length); // Doesn't throw an error and returns null
trace(string ?? 'ss'); // Returns 'ss';
trace(string ??= 'ss'); // Returns 'ss' and assigns it to `string` variable
");
}
}You can create a class extending SScript to customize it better.
class SScriptEx extends tea.SScript
{
override function preset():Void
{
super.preset();
// Only use 'set', 'setClass' or 'setClassString' in preset
// Macro classes are not allowed to be set
setClass(StringTools);
set('NaN', Math.NaN);
setClassString('sys.io.File');
}
}Extend other functions only if you know what you're doing.
You can call methods and receive their return value from Tea's using call function.
It needs one obligatory argument (function name) and one optional argument (function arguments array).
using call will return a structure that contains the return value, if calling has been successful, exceptions if it did not, called function name and script file name of the Tea.
Example:
var tea:tea.SScript = {};
tea.doScript('
function method()
{
return 2 + 2;
}
');
var call = tea.call('method');
trace(call.returnValue); // 4
tea.doScript('
function method()
{
var num:Int = 1.1;
return num;
}
')
var call = tea.call('method');
trace(call.returnValue, call.exceptions[0]); // null, Float should be IntWith SScript, you can set variables to all running Tea's. Example:
var tea:tea.SScript = {};
tea.set('variable', 1);
tea.doScript('
function returnVar()
{
return variable + variable2;
}
');
tea.SScript.globalVariables.set('variable2', 2);
trace(tea.call('returnVar').returnValue); // 3Special object is an object that'll get checked if a variable is not found in a Tea. A special object cannot be a basic type like Int, Float, String, Array and Bool.
Special objects are useful for OpenFL and Flixel states.
Example:
import tea.SScript;
class PlayState extends flixel.FlxState
{
var sprite:flixel.FlxSprite;
override function create()
{
sprite = new flixel.FlxSprite();
var newScript:SScript = new SScript();
newScript.setSpecialObject(this);
newScript.doScript("sprite.visible = false;");
}
}If you have any questions or requests, open an issue here or message me on my Discord (tahirk786).
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent