Go

Overview

Package

Class

Use

Deprecated

Index

Home >> All >> org >> metacosm >> framework >> interact >> [ actions overview ]

PREV CLASS NEXT CLASS

SUMMARY:

JAVADOC |

Sourc code of org.metacosm.framework.interact.actions.Go

SOURCE |

Download org.metacosm.framework.interact.actions.Go

DOWNLOAD | NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.metacosm.framework.interact.actions
Class Go

java.lang.Object
  org.metacosm.framework.interact.BasicAction
      org.metacosm.framework.interact.actions.Go

All Implemented Interfaces:: org.metacosm.framework.interact.Action, org.metacosm.framework.persistence.Persistent, java.io.Serializable

public class Go
extends org.metacosm.framework.interact.BasicAction

Standard implementation of "Go" action
ActionId = GoActionID

Field Summary

Fields inherited from class org.metacosm.framework.interact.BasicAction

Fields inherited from interface org.metacosm.framework.interact.Action

COMPLETED_ACTION, CONTINUING_ACTION, FAILED_ACTION

Constructor Summary

Go()


Method Summary

java.lang.String getActionId()
          Returns the hardwired ActionID that was choosen for this action at development time.

org.metacosm.framework.interact.ActionState mayStart(org.metacosm.framework.entity.Entity[] invokers, org.metacosm.framework.entity.Entity[] receivers, java.lang.Object[] parameters, org.metacosm.framework.interact.IntentionFA intention)
          MayStart predicate determines if an action can be started.

int perform(org.metacosm.framework.interact.ActionState state)
          Performs or continues an action already started.

void showAvailableExits(org.metacosm.framework.entity.BasicEntity me, org.metacosm.framework.entity.BasicPlace myPlace)


Methods inherited from class org.metacosm.framework.interact.BasicAction

load, mayStart, save, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

Go

public Go()

Method Detail

getActionId

public java.lang.String getActionId()

Returns the hardwired ActionID that was choosen for this action at development time.

perform

public int perform(org.metacosm.framework.interact.ActionState state)

Performs or continues an action already started.

mayStart

public org.metacosm.framework.interact.ActionState mayStart(org.metacosm.framework.entity.Entity[] invokers,
                                                            org.metacosm.framework.entity.Entity[] receivers,
                                                            java.lang.Object[] parameters,
                                                            org.metacosm.framework.interact.IntentionFA intention)
                                                     throws org.metacosm.framework.interact.BadParameterException

MayStart predicate determines if an action can be started. If yes, perform initialization of ActionState object.

Go can always be started for now.

showAvailableExits

public void showAvailableExits(org.metacosm.framework.entity.BasicEntity me,
                               org.metacosm.framework.entity.BasicPlace myPlace)