yakscript.action
Class Pause

java.lang.Object
  |
  +--yakscript.Action
        |
        +--yakscript.action.Pause

public class Pause
extends Action

Syntax: Pause [-add] <text>
Sets: $RC = TRUE for user confirm, FALSE for user cancel

Prints text on the display and waits for user confirmation. By default, any current text is overwritten; if -add is specified, the text is added to the current message.


Fields inherited from class yakscript.Action
arguments, condition
 
Constructor Summary
Pause()
           
 
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
isCondition, isFinal, isInitial, setArguments, setCondition
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Pause

public Pause()
Method Detail

getKeyword

public java.lang.String getKeyword()
Description copied from class: Action
Return the keyword of this action
Overrides:
getKeyword in class Action
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 Action
Following copied from class: yakscript.Action
Parameters:
yakScript - Currently executing instance of YakScript
Returns:
Whether command execution was successful