Exception handling

From Bohemia Interactive Community
Revision as of 03:12, 15 July 2007 by Vdmj (talk | contribs)
Jump to navigation Jump to search

In Armed Assault exception handling is an implemented system of special scripting commands (try, catch and throw), which allows your scripts to create and to react to exceptions.

Standard construction is:

try {
    //block, that can throw exception
    if (_name == "") then {
        throw "no name"
    } else {
        TitleText [format["Good morning, Captain %1.", _name], "PLAIN DOWN"]
        ~1
        TitleText [_name, "PLAIN DOWN"]
    }
}
catch { //block, that processes an exception if (_exception == "no name") then { echo "Name wasn't entred" TitleText ["And the name isn't", "PLAIN DOWN"] } }

Note: ArmA scripting commands do not create an exception by themselves if they encounter an illegal situation (i.e. you can't use the here described exception handling for error trapping.)

The following would therefore not create a catchable exception: try {a=1/0;} catch {hint "illegal operation";}




Probably is this possible too:

Template:Box File

try {
    TitleText ["Sgt. Detritus: I get bomb to his car ;-)", "PLAIN DOWN"]
    [jeepOne] exec "fireBomb.sqs"
    TitleText ["Sgt. Detritus: He is dead!", "PLAIN DOWN"]
}
catch { if (_exception == "vehicle empty") then { TitleText ["Sgt. Detritus: He have luck, but next time I'll kill him!", "PLAIN DOWN"] } else { TitleText ["Sgt. Detritus: Some strange error appears... " + _exception + "... hmm... another time I'll get him!", "PLAIN DOWN"] }

In OFP, "exec" was asynchronous - think spawning another thread. (ArmA will make this slightly more explicit with the command spawn) As such, an exception won't unwind into the caller so that it can be caught and used there. Though firebomb.sqs would preferrably be inlined to begin with, using "call preprocessfile firebomb.sqf" would be getting you the effect you want. Besides, it could go into "he is dead" before firebomb.sqs' first line got executed.

There are, however, several things about the piece of code above worthy of criticism. First of all, the handler is a catch(anything) (as ofpscript forces it to be) but the handler assumes it to be a string. {if typeof _exception != "string" throw } as the first command in the handler should properly rethrow the exception so it can be handled even further out. (The last throw might require _exception as a parameter.)

The second, and bigger problem, is that the exception handling is used as a way of returning values. Exceptions should be used exclusively for runtime handling of error conditions. At least traditionally, this was so because exceptions are rather "expensive" in use, but generally speaking, the only proper reason for such usage is the lack of other suitable ways of returning results. It's good form, and helps maintainability.

Exceptions are most useful when different people work on interacting pieces of code.

--MaHuJa 07:29, 23 August 2006 (CEST)