Return

Synopsis

return { expression }

Description

The return command transfers the execution back to where the sub was called using gosub.

providing a variable or expression to return will put the given value into the result system variable.

Example

gosub makeLowerCase #charname
event macro 1 0 my name is #result
halt

;The following sub takes the first parameter
;makes it lowercase, and then returns the
;lowercase version.
sub makeLowerCase
	str lower %1
return #strRes    ; the lowercase version of %1 is now stored in #result and control is returned to the main script.

Related Commands

Gosub

Sub

See Also

Flow Control

• Flow control commands allow scripts to make decisions based on the evaluation of boolean expressions.

break	Jumps to first statement outside of loop
call	Transfers execution to another script file
continue	Jumps execution of a loop to next iteration
exit	Exits a called script
for	Creates a counting loop
gosub	Transfers execution to the matching sub
goto	Jumps to another part of the script given by a label
halt	Stops the script
if	Executes code based on the evaluation of an expression
pause	Temporarily stops the execution of the current script
repeat..until	Creates a loop that checks condition after execution
return	Returns from a sub
stop	Ends the script
while	Creates a loop that checks condition before execution