SandboxScripts

This is the reference of functions you can call from your Sandbox scripts.

Lua programming language

Lua is a very simple & generic script language, very close from C or PHP.

If you are familiar with most used languages, you can learn Lua basic structures in few minutes (for example from this page : https://awesome.naquadah.org/wiki/The_briefest_introduction_to_Lua).

Using Lua, you can write scripts to automate moves for your Sandbox games & provide rules reinforcement.

Sandbox Scripts Hello World

From Sandbox editor "interface view" tab, select an element, and access to its property (top right icon).

Go to "Scripts (advanced)" section.

In front of "When this element is clicked", enter "onMyClick".

Close the window. Go to "script view" tab.

Enter the following :

function onMyClick(id)
   addToBgaLog("Hello world! You just clicked on element "..id..". Congrats!")
end

Save & publish your project, starts a test session, click on the previous element : your message appears in the log on the right!

Functions you can use in your Lua Sandbox scripts

addToBgaLog( txt )

Write something in the BGA log on the right.

This is also a very practical to debug your script ;)

Note : you can also pass an object in parameter. This will dump the content of this object in the log (for debugging purpose).

getElementById( id )=

Get an object with all the properties of the element with specified ID.

Throw an exception if the element does not exists.

getElementIdByName( name )=

Get the ID of a Sandbox element from its name.

Return null if there are no element with this name. Throw an exception if there are more than 1 element with this name.

moveElement( element_id, target_id )

Move element to specified target id.