Return: Difference between revisions
Jump to navigation
Jump to search
mNo edit summary |
No edit summary |
||
| (2 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
A '''return''' command is similar to '''[[break]]''' in that it stops code after the '''return''' from executing and thus can be used to exit a state early. However, a '''return''' | A '''return''' command is similar to '''[[break]]''' in that it stops code after the '''return''' from executing and thus can be used to exit a state early. However, a '''return''' propagates along a call chain of [[state]]s and terminates the execution of the innermost [[event]] or [[actor]] code. Thus, when the following code snippet is run, only quote 125 ("SPAWNED HEAVYHBOMB") is displayed. | ||
See also [[break]]. | |||
Not to be confused with the [[RETURN]] gamevar and [[return (userdef)|return (userdef structure)]]. | |||
== Examples == | |||
'''definequote''' 125 SPAWNED HEAVYHBOMB | '''definequote''' 125 SPAWNED HEAVYHBOMB | ||
| Line 28: | Line 34: | ||
Replacing the '''return''' by a '''[[break]]''' in the above example would lead to quotes 126 and 125 being displayed (in that order) at run time. | Replacing the '''return''' by a '''[[break]]''' in the above example would lead to quotes 126 and 125 being displayed (in that order) at run time. | ||
[[Category:Event manipulation]] | |||
Revision as of 01:24, 20 February 2020
A return command is similar to break in that it stops code after the return from executing and thus can be used to exit a state early. However, a return propagates along a call chain of states and terminates the execution of the innermost event or actor code. Thus, when the following code snippet is run, only quote 125 ("SPAWNED HEAVYHBOMB") is displayed.
See also break.
Not to be confused with the RETURN gamevar and return (userdef structure).
Examples
definequote 125 SPAWNED HEAVYHBOMB
definequote 126 RAN EVENT_EGS
definequote 127 RAN TEST STATE
state teststate1
return
userquote 127
ends
onevent EVENT_EGS
ifactor HEAVYHBOMB
{
state teststate1 // after teststate1's return, return from EVENT_EGS!
userquote 126
}
endevent
onevent EVENT_LOADACTOR
ifvare THISACTOR 0
{
// the concrete actor is irrelevant, only placeholder
spawn HEAVYHBOMB // --> EVENT_EGS
userquote 125
}
endevent
Replacing the return by a break in the above example would lead to quotes 126 and 125 being displayed (in that order) at run time.