Script changes

[utunnels]

1. function clear

Just like function main, it is another entry, called when the script is being cleared.
Of course it is optional. The purpose of this function is giving the modder a chance to clear their local variables, which include screen handles, sprite handles and array handles(explain below).

For example:

Code: [Select]

void main(){
    if(getlocalvar("sprite")==NULL())
    {
        setlocalvar("sprite", loadsprite("data/sprites/test.gif"));
    }
    //do something else
}

void clear(){
   if(getlocalvar("localclear")){
      void sprite = getlocalvar("sprite");
      if(sprite!=NULL()){
          free(sprite);
          setlocalvar("sprite", NULL());
      }
    }
}
The only accessible local variable is called "localclear". When it is 0, it means the engine is not about to clear your local variables, so you can do nothing in this case. When it is 1, it means the engine is about to clear your local variables, so you should free the handles before they are gone. When it is 2, it means the engine is about to delete this script, so you should take care of the script variables or they are gone forever.

For entity variables, you should be able to clear them in onkill script.

Important note: Don't do something like killentity (usually you can't since "self" is not accessible, but for those who play with the global variables, it is still dangerous), because kill will raise another clear, and crash the engine.

2. New functions:

array(size);
get(array, index);
set(array, index, value);
size(array);

So you can allocate an array and use it like the indexed variables. Don't forget to free it, and don't forget to free all its subscripted member if necessary (screen, sprite, array, etc).

Example:

Code: [Select]

  int i;
  void a = array(100);
  setglobalvar("my.cool.array", a);

   // blahblah...

   set(a, size(a)-1, "this is the last element");
   set(a, 0, "this is the fisrt element");
   set(a, 3, 123);
   set(a, 4, 99.66);
   set(a, 5, loadsprite("data/chars/dude/001.gif"));
   //blahblah...

    for(i=size(a)-1; i>=0; i--){
       log(get(a, i));
    }
   
    //free the sprite
    free(get(a, 5));
    set(a, 5, NULL());

    // doing this is good for string values
    // there is no array cleaning function so far,
    // so you should NULL them one by one
    for(i=size(a)-1; i>=0; i--){
       set(a, i, NULL());
    }
   
    free(a);
    setglobalvar("my.cool.array", NULL());
    So it is still complex to clean up the array. But since this feature is for the advanced modders, it shouldn't cause too many troubles to novice users.

[MatMan]

This has many factor of ooooooooohhh!!!

Great add-on utunnels 

[Damon Caskey]

Arrays! That's something I never thought we would see on OpenBOR Script! Nice one UT! 

Assuming you can assign them to indexed vars and not just global vars as in the example, I (and many others) can be rid of slow globals entirely. No more "fakearray.element.a", fakearray.element.b", "...".

DC