pl.isangeles.senlin.cli

Class Script

java.lang.Object

pl.isangeles.senlin.cli.Script

All Implemented Interfaces:

SaveElement

public class Script
extends java.lang.Object
implements SaveElement

Class for CLI scripts

Author:

Isangeles

Constructor Summary

Constructors

Constructor and Description
Script(java.lang.String name, java.lang.String body, java.lang.String ifBody, java.lang.String endBody) Script constructor

Method Summary

Modifier and Type	Method and Description
void	finish() Marks script as finished
java.lang.String	getActiveCommand() Returns active command of script
int	getActiveIndex() Returns active script command index
java.lang.String	getEndCode() Returns code of end body
java.lang.String	getIfCode() Returns code of if body
java.lang.String	getName() Return script name
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Parses object to XML document element
int	getUseCount() Returns number of uses of this script
boolean	hasNext()
boolean	isFinished() Checks if script is finished
boolean	isWaiting() Checks if script is stopped for some time
void	next() Moves command index forward
void	pause(long millis) Pauses script for specified time
void	restart() Restarts command index (next command will be first command of the script)
void	setActiveLineId(int id) Sets specified ID as active script line ID
java.lang.String	toString()
void	update(int delta) Updates script
void	used() Increases number of uses of this script

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Script

public Script(java.lang.String name,
              java.lang.String body,
              java.lang.String ifBody,
              java.lang.String endBody)

Script constructor

Parameters:

name - Script name

body - Script code

Method Detail

update

public void update(int delta)

Updates script

Parameters:

delta - Time from last update

getName

public java.lang.String getName()

Return script name

Returns:

String with script name

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getIfCode

public java.lang.String getIfCode()

Returns code of if body

Returns:

String with if body code

getEndCode

public java.lang.String getEndCode()

Returns code of end body

Returns:

String with end body code

getActiveCommand

public java.lang.String getActiveCommand()

Returns active command of script

Returns:

String with script command

getActiveIndex

public int getActiveIndex()

Returns active script command index

Returns:

Active command index

getUseCount

public int getUseCount()

Returns number of uses of this script

Returns:

Number of uses

isFinished

public boolean isFinished()

Checks if script is finished

Returns:

True if script should not be executed, false otherwise

hasNext

public boolean hasNext()

isWaiting

public boolean isWaiting()

Checks if script is stopped for some time

Returns:

True if script must wait, false otherwise

setActiveLineId

public void setActiveLineId(int id)

Sets specified ID as active script line ID

Parameters:

id - ID

used

public void used()

Increases number of uses of this script

restart

public void restart()

Restarts command index (next command will be first command of the script)

next

public void next()

Moves command index forward

pause

public void pause(long millis)

Pauses script for specified time

Parameters:

millis - Time in millis

finish

public void finish()

Marks script as finished

getSave

public org.w3c.dom.Element getSave(org.w3c.dom.Document doc)

Description copied from interface: SaveElement

Parses object to XML document element

Specified by:

getSave in interface SaveElement

Parameters:

doc - XML document for save game

Returns:

XML document element