yakscript.action
Class Select

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

public class Select

extends Action

Syntax: Select <option>

Executes option for the current frame. Does not save state, execution of any following commands proceeds once (if) option returns. Executing a non-existent option is an error. Intended primarily for context-sensitive triggers.

Fields inherited from class yakscript.Action

arguments, condition

Constructor Summary

Select()

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
void	setArguments(java.util.StringTokenizer _arguments) Set the arguments for this action and verify their contents Override this if you need to perform syntax checking on the arguments passed to your action

Methods inherited from class yakscript.Action

isCondition, isFinal, isInitial, setCondition

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Select

public Select()

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

setArguments

public void setArguments(java.util.StringTokenizer _arguments)
                  throws SyntaxErrorException

Description copied from class: Action

Set the arguments for this action and verify their contents
Override this if you need to perform syntax checking on the arguments passed to your action

Overrides:

setArguments in class Action

Following copied from class: yakscript.Action

Parameters:

args - Arguments to pass

Throws:

SyntaxErrorException - Thrown if the arguments are syntactically invalid for this action

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