Scripting return codes

Below is a list of the error codes that are returned by many script routines. Some scripts return different codes (such as variants), see those functions for more information.

The English meaning (eg. "The world is already open") can also be obtained by calling the ErrorDesc script function. The descriptions corresponding to an error code can also be found in Lua by indexing into the error_desc table (as in the "check" function below).

There is a function built into the Lua script space which will check for errors automatically:

function check (result)
  if result ~= error_code.eOK then
    error (error_desc [result] or 
           string.format ("Unknown error code: %i", result), 
           2) -- error level - whoever called this function
  end -- if
end -- function check 

If you pass an error code to the "check" function it will raise an error if the code is not valid (ie. not zero), with the appropriate error message. For example:

check (WindowShow ("foo", true))   -- raises error if window "foo" does not exist

The error codes can also be accessed from Lua using the error_code table (eg. error_code.eOK, error_code.eCannotPlaySound).

---