Built-in addons

AngelScript basics

Math functions * | Script Arrays | Strings (string functions) | File | Dictionary | Filesystem | Datetime

* Math uses double instead of float, and has additional exp function. 

StopWatch

StopWatch watch;
watch.Start();
double elapsed = watch.elapsed;
watch.Stop();

A high precision stop watch to measure elapsed time. Elapsed time is in milliseconds, but its precision depends on the platform (usually precision should be close to a few microseconds).

XMLNode

Class and enum:

class XmlNode Reference type that describes a node in an Xml tree structure (DOM). 
  XmlNodeType type type of node (see below)
  string name name of the node
  dictionary & attributes attributes of element nodes
  array<XmlNode> & childNodes children nodes
enum XmlNodeType { kXmlElement, kXmlComment, kXmlText } Types of nodes: Element node, Comment node, Text node

Functions:

XmlNode XmlParseFile (const string &file) Parse an Xml file and build the corresponding DOM tree structure (returns null if failed).
XmlNode XmlParse (const string &str) Parse a string containing Xml and build the corresponding DOM tree structure (returns null if failed).
bool XmlWriteFile (const XmlNode &in xml, const string &file) Write an Xml DOM into a file. Returns false upon failure.
bool XmlWrite (const XmlNode &in xml, string &str) Write an Xml DOM into a string. Returns false upon failure.

An example of reading and parsing an XML file.

Unicode support (utf8)

Extensions to the scripting engine to deal with unicode strings (utf8)

Class utf8::iterator

class utf8::iterator (const string &iString)
class utf8::iterator (const iterator &iter)
  void operator= (const iterator &iIter)
  string first () positions the iterator at the first character in string and returns it (or empty) 
  string last () positions the iterator at the last character in string and returns it (or empty)
  string next (uint count) moves to the next character in string and returns it (or empty)
  string previous (uint count) moves to previous character in string and returns it (or empty)
  int index () returns the current position in the string (in bytes, NOT characters)

(Experimental) utf-8 iterator. Provides methods to navigate in unicode strings (all strings in KUIML are using utf-8 encoding).

Functions for Utf8

bool utf8::isValid (const string &in) returns true if the string contains valid utf8 characters.
string utf8::replaceInvalid (const string &in) replace invalid utf-8 character sequences in string by a special question mark character.
uint utf8::length (const string &in) returns the number of utf-8 characters in string (different from string length)

Using these class and function you can write your own functions to correctly process utf8 strings.

rand

double rand(double min = 0, double max = 1)

Generates a random number between min and max.

system

int system(const string & command)
int system(const string & command, string & output)

Executes "command" using the system shell and waits for the command to finish. Returns the result of the command; (optional) returns the output as a string

The 'system' command is powerful, however it waits till it's finished, which makes the GUI "freeze" while it's running. So be careful with it, especially for possibly long-running operations (like curl, etc). Speaking of curl, for internet access see ACTION type="LoadURL" which can be executed asyncronously.

getObjectById (experimental)

ref@ getObjectById(const string &in)

Get a handle to a KUIML object by id. Can be useful to access objects that you're not sure exist during the runtime. Don't forget that object should be exposed to scripts (using EXPOSED_OBJECTS or requires attribute). This is experimental and can change, use at your own risk.

See AngelScript Object Handles and Expressions (Type conversions).

Graphics

KUIML exposes a Kt::Graphics class. See more in CANVAS and Graphics API.