Enforce script essentials

Try to safely down-cast base class to child class.

Returns: down-casted 'from' pointer when cast is successfull (classes are related), or null if casting is invalid

// assume that Man inheites from Object
Object obj = g_Game.GetPlayer();
Man player = Man.Cast(obj);

if (player)
{
	// horay!
}

Try to safely down-cast base class to child class.

Returns: bool true when 'from' is not null and cast successfull, false when casting is not valid or 'from' is null

// assume that Man inheites from Object
Object obj = g_Game.GetPlayer();
Man player;

if (Class.CastTo(player, obj))
{
	// horay!
}

Returns name of class-type

inst

Class

Returns: string class-type

Man player = g_Game.GetPlayer();
string className = player.ClassName();
Print(className);

>> className = 'Man'

Copes contents of `from` array to this array.

Returns: How many elements were copied

O(1) complexity.

Returns: Number of elements of the array

Returns: The number of elements in the hashmap.

Print all elements in array

Returns: void

my_array.Debug();

>> "One"
>> "Two"
>> "Three"

Returns an index where 2 arrays start to differ from each other

Returns: int Index from where arrays differ

array<int> arr1 = {0,1,2,3};
array<int> arr2 = {0,1,3,2};
int differsAt = arr1.DifferentAtPosition(arr2);
Print(differsAt);

>> 2

Tries to find the first occurance of given value in the array.

Returns: Index of the first occurance of `value` if found, -1 otherwise

Search for an element with the given key.

key

The key of the element to find

val

result is stored to val

Returns: returns True if given key exist.

Tries to find the first occurance of given value in the set.

Returns: Index of the first occurance of `value` if found, -1 otherwise

Returns: Element at the index `n`

Search for an element with the given key.

key

The key of the element to find

Returns: Pointer to element data if found, NULL otherwise.

Dynamic read of variable value by its name

inst

When inst == NULL, it's for global variable, otherwise it's class member

index

Is index when variable is array

out result

Variable must be of the same type!

Returns: int true when success

float count = 0;

bool success = EnScript.GetClassVar(myClass, "m_Counter", 0, count);
Print(count);
Print(success);

>> count = 5
>> success = 1

Return the i:th element in the map. Note: This operation is O(n) complexity. Use with care!

index

The position of the element in the map

Returns: The element on the i:th position

Return the i:th element key in the map. Note: This operation is O(n) complexity. Use with care!

i

The position of the element key in the map

Returns: Return key of i-th element

Returns a random element of array

Returns: int Random element of array

Print( my_array.GetRandomElement() );

>> "Three"

Returns a random index of array. If Count is 0, return index is -1 .

Returns: int Random index of array

Print( my_array.GetRandomIndex() );

>> 2

Inserts element at the end of array.

value

Element to be inserted

Returns: Position at which element is inserted

Insert new element into hash map.

key

Key of element to be inserted.

value

Data of element to be inserted.

Inserts element at the end of array.

value

Element to be inserted

Returns: Position at which element is inserted

Inserts all elements from array

from

array<T> array from which all elements will be added

TStringArray arr1 = new TStringArray;
arr1.Insert( "Dave" );
arr1.Insert( "Mark" );
arr1.Insert( "John" );

TStringArray arr2 = new TStringArray;
arr2.Insert( "Sarah" );
arr2.Insert( "Cate" );

arr1.InsertAll(arr2);

for ( int i = 0; i < arr1.Count(); i++ )
{
	Print( arr1.Get(i) );
}

delete arr2;
delete arr1;

>> "Dave"
>> "Mark"
>> "John"
>> "Sarah"
>> "Cate"

Inserts element at certain position and moves all elements behind this position by one.

value

Element to be inserted

index

Position at which element is inserted. Must be less than Array::GetCardinality()

Returns: Number of elements after insertion

Inserts element at certain position and moves all elements behind this position by one.

value

Element to be inserted

index

Position at which element is inserted. Must be less than Array::GetCardinality()

Returns: Number of elements after insertion

Returns true when instance is of the type, or inherited one.

type

Class type

Returns: bool true when 'clType' is the same as 'type', or inherited one.

if (inst && inst.IsInherited(Widget))
{
	Print("inst is inherited from Widget class!");
}

Kills thread.

owner

Can be NULL for global threads.

name

Name of the first function on stack

Returns: int ???

???

Do load script and create ScriptModule for it

parentModule

Module

scriptFile

Script path

listing

??

Returns: ScriptModule Loaded scripted module

???

Returns a index in array moved by specific number

Returns: int Moved index in this array

Print( "Count: "+ my_array.Count() );
Print( "Moved 1:"+ my_array.MoveIndex(2, 1) );
Print( "Moved 3:"+ my_array.MoveIndex(2, 2) );

>> "Count: 4"
>> "Moved index 2 by 1: 3";
>> "Moved index 2 by 2: 0";

Parses string into array of tokens returns number of tokens

input

string String for parse

out tokens

array[] Parsed string in array

Returns: int Number of tokens

string token[2];
int result = ParseString("Hello World", token);

for( int i = 0; i < 2; i++ )
{
	Print(token[i]);
}

>> 'Hello'
>> 'World'

Parses one token from input string. Result is put into token string, and type of token is returned. Input string is left-truncated by the resulting token length.

[in,out] input string String for parse\ Output is without founded token

out token

string Founded string token

Returns: int Type of token \verbatim Token types: 0 - error, no token 1 - defined token (special characters etc. . / * ) 2 - quoted string. Quotes are removed -> TODO 3 - alphabetic string 4 - number 5 - end of line -> TODO \endverbatim

string input = "Hello*World";
string token1;
string token2;

int result1 = ParseStringEx(input, token1);
int result2 = ParseStringEx(input, token2);

Print( String( "Token1 = '" + token1 + "' Type = " + result1.ToString() ) );
Print( String( "Token2 = '" + token2 + "' Type = " + result2.ToString() ) );
Print( input );

>> 'Toke1 = 'Hello' Type = 3'
>> 'Toke1 = '*' Type = 1'

Removes element from array. The empty position is replaced by last element, so removal is quite fast but do not retain order.

index

Index of element to be removed

Removes element from array, but retain all elements ordered.

index

Index of element to be removed

Removes i:th element with given key. Note: This operation is O(n) complexity. Use with care!

i

The position of the element key in the map

Removes element from array, but retain all elements ordered. It's slower than Remove

index

Index of element to be removed

Dynamic write to variable by its name

inst

when inst == NULL, it's for global variable, otherwise it's class member

varname

index

Is index when variable is array

input

Input variable must be of the same type!

Returns: int Returns true(1) when success

Print(myClass.m_Counter);

>> m_Counter = 0

bool success = EnScript.SetClassVar(myClass, "m_Counter", 0, 5.0);

Print(myClass.m_Counter);
Print(success);

>> m_Counter = 5
>> success = 1

Sets variable value by value in string

out var

value

Returns: int

???

Sorts static array of integers(ascendically) / floats(ascendically) / strings(alphabetically)

param_array

array Array to sort

num

int How many items will be sorted in array

Returns: void

string	arrStr[3] = {"Dog", "Car", "Apple"};
Sort(arrStr, 2)
for ( int x = 0; x < 3; x++ )
{
	Print( arrStr[x] );
}

>> 'Car'
>> 'Dog'
>> 'Apple'

Sorts elements of array, depends on underlaying type.

Returns typename of class even without a variable or instance

Returns: typename class-type

typename eAITypename = StaticGetType(EntityAI);

Returns typename of object's reference

Returns: typename class-type

EntityAI e;
Print(e.StaticType());

>> 'EntityAI'

Helper for passing string expression to functions with void parameter. Example: Print(String("Hello " + var));

Debug function. Returns current function on stack of the thread

owner

Can be NULL for global threads

name

Name of the first function on stack

backtrace

???

linenumber

???

Returns: string ???

???

Returns typename of object's class

Returns: typename class-type

Man player = g_Game.GetPlayer();
typename type = player.Type();
Print(type.ToString());

>> 'Man'

Debug tool for watching certain variable. Invokes debugger whenever is variable used

var

Certain variable for watching

flags

= 1 means it will break even when not modified

Returns: void