1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281
|
/**
\page doc_script_statements Statements
- \ref variable
- \ref expression
- \ref if
- \ref while
- \ref break
- \ref return
- \ref block
- \ref try
\section variable Variable declarations
<pre>
int var = 0, var2 = 10;
object\@ handle, handle2;
const float pi = 3.141592f;
</pre>
Variables must be declared before they are used within the statement block,
or any sub blocks. When the code exits the statement block where the variable
was declared the variable is no longer valid.
A variable can be declared with or without an initial expression. If it
is declared with an initial expression it, the expression must have the evaluate
to a type compatible with the variable type.
Any number of variables can be declared on the same line separated with commas, where
all variables then get the same type.
Variables can be declared as <code>const</code>. In these cases the value of the
variable cannot be changed after initialization.
Variables of primitive types that are declared without an initial value, will have
a random value. Variables of complex types, such as handles and object are initialized
with a default value. For handles this is <code>null</code>, for objects this is
what is defined by the object's default constructor.
\section expression Expression statement
<pre>
a = b; // a variable assignment
func(); // a function call
</pre>
Any \ref doc_expressions "expression" may be placed alone on a line as a statement. This will
normally be used for variable assignments or function calls that don't return any value of importance.
All expression statements must end with a <code>;</code>.
\section if Conditions: if / if-else / switch-case
<pre>
if( condition )
{
// Do something if condition is true
}
if( value < 10 )
{
// Do something if value is less than 10
}
else
{
// Do something else if value is greater than or equal to 10
}
</pre>
If statements are used to decide whether to execute a part of the logic
or not depending on a certain condition. The conditional expression must
always evaluate to <code>true</code> or <code>false</code>.
It's possible to chain several <code>if-else</code> statements, in which case
each condition will be evaluated sequencially until one is found to be <code>true</code>.
<pre>
switch( value )
{
case 0:
// Do something if value equals 0, then leave
break;
case 2:
case constant_value:
// This will be executed if value equals 2 or the constant_value
break;
default:
// This will be executed if value doesn't equal any of the cases
}
</pre>
If you have an integer (signed or unsigned) expression that have many
different outcomes that should lead to different code, a switch case is often
the best choice for implementing the condition. It is much faster than a
series of ifs, especially if all of the case values are close in numbers.
Each case should be terminated with a break statement unless you want the
code to continue with the next case.
The case value can be a constant variable that was initialized with a constant
expression. If the constant variable was initialized with an expression that
cannot be determined at compile time it cannot be used in the case values.
\section while Loops: while / do-while / for
<pre>
// Loop, where the condition is checked before the logic is executed
int i = 0;
while( i < 10 )
{
// Do something
i++;
}
// Loop, where the logic is executed before the condition is checked
int j = 0;
do
{
// Do something
j++;
} while( j < 10 );
</pre>
For both <code>while</code> and <code>do-while</code> the expression that determines
if the loop should continue must evaluate to either true or false. If it evaluates
to true, the loop continues, otherwise it stops and the code will continue with the next
statement immediately following the loop.
<pre>
// More compact loop, where condition is checked before the logic is executed
for( int n = 0; n < 10; n++ )
{
// Do something
}
</pre>
The <code>for</code> loop is a more compact form of a <code>while</code> loop. The
first part of the statement (until the first <code>;</code>) is executed only once,
before the loop starts. Here it is possible to declare a variable that will be visible
only within the loop statement. The second part is the condition that must be satisfied
for the loop to be executed. A blank expression here will always evaluate to true. The last
part is executed after the logic within the loop, e.g. used to increment an iteration variable.
Multiple variables can be declared in the <code>for</code> loop, separated by <code>,</code>.
Likewise, multiple increment expressions can be used in the last part by separating them with <code>,</code>.
\section break Loop control: break / continue
<pre>
for(;;) // endless loop
{
// Do something
// End the loop when condition is true
if( condition )
break;
}
</pre>
<code>break</code> terminates the smallest enclosing loop statement or switch statement.
<pre>
for(int n = 0; n < 10; n++ )
{
if( n == 5 )
continue;
// Do something for all values from 0 to 9, except for the value 5
}
</pre>
<code>continue</code> jumps to the next iteration of the smallest enclosing loop statement.
\section return Return statement
<pre>
float valueOfPI()
{
return 3.141592f; // return a value
}
</pre>
Any function with a return type other than <code>void</code> must be finished with a
<code>return</code> statement where expression evaluates to the same
data type as the function return type. Functions declared as <code>void</code> can have
<code>return</code> statements without any expression to terminate early.
\section block Statement blocks
<pre>
{
int a;
float b;
{
float a; // Override the declaration of the outer variable
// but only within the scope of this block.
// variables from outer blocks are still visible
b = a;
}
// a now refers to the integer variable again
}
</pre>
A statement block is a collection of statements. Each statement block has its own scope of
visibility, so variables declared within a statement block are not visible outside the block.
\section try Try-catch blocks
<pre>
{
try
{
DoSomethingThatMightThrowException();
// This is not executed if an exception was thrown
}
catch
{
// This is executed if an exception was thrown
}
}
</pre>
A try-catch block can be used if you're executing some code that might throw an exception
and you want to catch that exception and continue with the exception rather than just abort
the script.
Exceptions can occur for various reasons, some examples include, accessing null pointers in
uninitialized handles, division by zero, or exceptions raised from application registered functions.
In some cases exceptions are intentionally raised by the script to interrupt some execution.
\see \ref doc_script_stdlib_exception
*/
|