yakscript.action
Class Sub

java.lang.Object
  |
  +--yakscript.Action
        |
        +--yakscript.action.Goto
              |
              +--yakscript.action.Sub

public class Sub
extends Goto

Syntax: Sub <frame> [arguments...]

Enters frame as a subroutine, with arguments passed on as in Goto. Variables are copied, so changes in the subroutine will not affect their previous values. Resume resumes executing at the point exactly after Sub was invoked.


Fields inherited from class yakscript.Action
arguments, condition
 
Constructor Summary
Sub()
           
 
Method Summary
 boolean exec(YakScript ys)
          Executes this action
Override this to actually provide the functionality of your action
 java.lang.String getKeyword()
          Return the keyword of this action
 
Methods inherited from class yakscript.action.Goto
isFinal, isInitial, setArguments
 
Methods inherited from class yakscript.Action
isCondition, setCondition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Sub

public Sub()
Method Detail

getKeyword

public java.lang.String getKeyword()
Description copied from class: Action
Return the keyword of this action
Overrides:
getKeyword in class Goto
Following copied from class: yakscript.Action
Returns:
Keyword string

exec

public boolean exec(YakScript ys)
Description copied from class: Action
Executes this action
Override this to actually provide the functionality of your action
Overrides:
exec in class Goto
Following copied from class: yakscript.Action
Parameters:
yakScript - Currently executing instance of YakScript
Returns:
Whether command execution was successful