throw: Difference between revisions

From Bohemia Interactive Community
m (Text replacement - "\[\[Category:[ _]?Scripting[ _]Commands[ _]Arma[ _]3(\|.*)\]\]" to "{{GameCategory|arma3|Scripting Commands}}")
m (Some wiki formatting)
 
(60 intermediate revisions by 3 users not shown)
Line 1: Line 1:
{{Command|Comments=
{{RV|type=command
____________________________________________________________________________________________


| arma1 |Game name=
|game1= arma1
|version1= 1.00


|gr1= Program Flow |GROUP1=
|game2= arma2
|version2= 1.00


|1.00|Game version=
|game3= arma2oa
____________________________________________________________________________________________
|version3= 1.50


| Throws an exception. The exception is processed by first [[catch]] block. This command will terminate further execution of the code.
|game4= tkoh
|version4= 1.00


{{Important | Avoid using alternative shorthand syntax if you are planning on preparing your exception information dynamically, as it will have to be generated first regardless of the condition of the [[if]] statement before it, as shown in Example 3.}} |DESCRIPTION=
|game5= arma3
____________________________________________________________________________________________
|version5= 0.50


|s1= [[throw]] expression |SYNTAX=
|gr1= Program Flow


|p1= expression: [[Anything]] |PARAMETER1=
|descr= Throws an exception. The exception is processed by first [[catch]] block. This command will terminate further execution of the code.


|r1= [[Nothing]] |RETURNVALUE=
{{Feature|important|Avoid using alternative shorthand syntax if you are planning on preparing your exception information dynamically, as it will have to be generated first regardless of the condition of the [[if]] statement before it, as shown in {{Link|#Example 3}}.}}


|s2= if (condition) [[throw]] exception {{since|arma3|1.53.133045|y}} |SYNTAX2=
|s1= [[throw]] exception


|p21= if (condition): [[If Type]]  - if (condition) returns [[true]], "exception" is thrown |PARAMETER21=
|p1= exception: [[Anything]] - value that is put into the <sqf inline>_exception</sqf> variable inside [[catch]] block
|p22= exception: [[Anything]] - value that will be put into ''_exception'' variable inside [[catch]] block|PARAMETER22=


|r2= [[Nothing]] |RETURNVALUE2=
|r1= [[Nothing]]
____________________________________________________________________________________________
 
|x1= <code>[[try]] {[[throw]] "invalid argument"} [[catch]] {[[hint]] [[str]] _exception};</code> |EXAMPLE1=


|x2= {{since|arma3|1.53.133045}}: <code>123 [[try]] {[[if]] (_this != 123) [[throw]] "invalid argument"} [[catch]] {[[hint]] [[str]] _exception};</code> |EXAMPLE2=
|s2= ifType [[throw]] exception


|x3= The correct usage of shorthand alt syntax: <code>[[try]] {
|s2since= arma3 1.54
[[if]] (a > b) [[throw]] "Error: some error"; {{cc|OK}}
 
{{cc|The command argument is static}}
|p21= ifType: [[If Type]] - if the condition returns [[true]], ''exception'' is thrown
} [[catch]] {
[[hint]] [[str]] _exception;
};


[[try]] {
|p22= exception: [[Anything]] - value that is put into the <sqf inline>_exception</sqf> variable inside [[catch]] block
_someFunc = {
.....
};
[[if]] (a > b) [[throw]] ([[call]] _someFunc); {{cc|NOT OK}}
{{cc|The command argument is dynamic}}
{{cc|_someFunc is called first to get the value regardless of (a > b) outcome}}
} [[catch]] {
[[hint]] [[str]] _exception;
};


[[try]] {
|r2= [[Nothing]]
_someFunc = {
.....
};
[[if]] (a > b) [[then]] {[[throw]] ([[call]] _someFunc)}; /// OK
{{cc|The command argument is dynamic}}
{{cc|_someFunc is only called when (a > b) is [[true]]}}
} [[catch]] {
[[hint]] [[str]] _exception;
};</code> |EXAMPLE3=
____________________________________________________________________________________________


|seealso= [[Exception handling]], [[try]], [[catch]]
|x1= <sqf>try { throw "invalid argument" } catch { hint str _exception };</sqf>
}}


<h3 style="display:none">Notes</h3>
|x2= <sqf>123 try { if (_this != 123) throw "invalid argument" } catch { hint str _exception };</sqf>
<dl class="command_description">
<!-- Note Section BEGIN -->


<!-- Note Section END -->
|x3= The correct usage of shorthand alt syntax:
</dl>
<sqf>
try
{
if (a > b)
throw "Error: some error"; // OK - the command argument is static
}
catch
{
hint str _exception;
};
</sqf>
<sqf>
try
{
if (a > b)
throw (call _someFunc); // NOT OK - the command argument is dynamic
// _someFunc is called first to get the value regardless of (a > b) outcome
}
catch
{
hint str _exception;
};
</sqf>
<sqf>
try
{
if (a > b) then { throw (call _someFunc) }; // OK - the command argument is dynamic
// _someFunc is only called when (a > b) is true
}
catch
{
hint str _exception;
};
</sqf>


<h3 style="display:none">Bottom Section</h3>
|seealso= [[Exception handling]] [[try]] [[catch]]
[[Category:Scripting Commands|THROW]]
}}
{{GameCategory|arma1|Scripting Commands}}
[[Category:Scripting Commands Arma 2|{{uc:{{PAGENAME}}}}]]
{{GameCategory|arma3|Scripting Commands}}
[[Category:Scripting Commands Take On Helicopters|{{uc:{{PAGENAME}}}}]]

Latest revision as of 18:33, 7 January 2026

Logo A1 black.png 1.00Logo A2.png 1.00A2 OA Logo.png 1.50tkoh logo small.png 1.00Arma 3 logo black.png 0.50
Hover & click on the images for description

Description

Description:
Throws an exception. The exception is processed by first catch block. This command will terminate further execution of the code.
⚠
Avoid using alternative shorthand syntax if you are planning on preparing your exception information dynamically, as it will have to be generated first regardless of the condition of the if statement before it, as shown in Example 3.
Groups:
Program Flow

Syntax

Syntax:
throw exception
Parameters:
exception: Anything - value that is put into the _exception variable inside catch block
Return Value:
Nothing

Alternative Syntax

Syntax:
ifType throw exception
Parameters:
ifType: If Type - if the condition returns true, exception is thrown
exception: Anything - value that is put into the _exception variable inside catch block
Return Value:
Nothing

Examples

Example 1:
try { throw "invalid argument" } catch { hint str _exception };
Example 2:
123 try { if (_this != 123) throw "invalid argument" } catch { hint str _exception };
Example 3:
The correct usage of shorthand alt syntax:
try { if (a > b) throw "Error: some error"; // OK - the command argument is static } catch { hint str _exception; };
try { if (a > b) throw (call _someFunc); // NOT OK - the command argument is dynamic // _someFunc is called first to get the value regardless of (a > b) outcome } catch { hint str _exception; };
try { if (a > b) then { throw (call _someFunc) }; // OK - the command argument is dynamic // _someFunc is only called when (a > b) is true } catch { hint str _exception; };

Additional Information

See also:
Exception handling try catch

Notes

Report bugs on the Feedback Tracker and/or discuss them on the Arma Discord.
Only post proven facts here! Add Note
Retrieved from "https://community.bistudio.com/wiki?title=throw&oldid=377911"