net.nexttext.behaviour.control
Class Timer

java.lang.Object
  extended by net.nexttext.behaviour.AbstractAction
      extended by net.nexttext.behaviour.control.Timer
All Implemented Interfaces:
Action

public class Timer
extends AbstractAction

A Timer executes a given action for an absolute period of time given in seconds.

See Also:
Delay

Nested Class Summary
 
Nested classes/interfaces inherited from interface net.nexttext.behaviour.Action
Action.ActionResult
 
Constructor Summary
Timer(Action action, float duration)
          Creates a Timer for the given action.
 
Method Summary
 Action.ActionResult behave(TextObject to)
          Default behave method for single objects.
 void complete(TextObject to)
          Default implementation which removes state information for the object.
 java.util.Map<java.lang.String,Property> getRequiredProperties()
          The properties that this action requires on a TextObject.
 
Methods inherited from class net.nexttext.behaviour.AbstractAction
behave, behave, getDisplayName, makeBehaviour, properties, setDisplayName
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Timer

public Timer(Action action,
             float duration)
Creates a Timer for the given action.

Parameters:
duration - In seconds
Method Detail

behave

public Action.ActionResult behave(TextObject to)
Description copied from class: AbstractAction
Default behave method for single objects.

This method does nothing; it should be overriden by subclasses if they wish to support actions on single objects.

Trying to call this method on an Action which doesn't override it will throw an UnsupportedActionException.

Specified by:
behave in interface Action
Overrides:
behave in class AbstractAction

getRequiredProperties

public java.util.Map<java.lang.String,Property> getRequiredProperties()
Description copied from class: AbstractAction
The properties that this action requires on a TextObject.

Right now this method always returns an empty map, since basic Actions should be restricted to use only the core set of TextObject properties.

If a subclass of Action requires a set of additional properties then it should override this method and return the appropriate Map containing the property objects.

This method is required by the Action interface.

Specified by:
getRequiredProperties in interface Action
Overrides:
getRequiredProperties in class AbstractAction

complete

public void complete(TextObject to)
Description copied from class: AbstractAction
Default implementation which removes state information for the object.

Specified by:
complete in interface Action
Overrides:
complete in class AbstractAction