| Package | org.wak.action.actions |
| Interface | public interface IAction |
| Implementors | BaseAction |
| Property | Defined by | ||
|---|---|---|---|
| isReady : Boolean [read-only]
Returns true if the action has all the scene or inventory item needed as parameters
for the action.
| IAction | ||
| paramsNumber : int [read-only]
The number of parameters used by the action.
| IAction | ||
| Method | Defined by | ||
|---|---|---|---|
|
AddParameter(pItem:IInteractable):void
Add an IInteractable as action parameter.
| IAction | ||
|
CanExecute(pIterator:IIterator):Boolean
Tests if the action can execute.
| IAction | ||
|
Executes the action.
| IAction | ||
|
GetId():String
The action identificator.
| IAction | ||
|
GetNoActionText():String
If no method found for the action, you usually gets a generic message
this method returns that message.
| IAction | ||
|
The first parameter of the action.
| IAction | ||
|
The second parameter of the action.
| IAction | ||
|
GetText():String
Get the action localized text for player's interface uses.
| IAction | ||
|
TestParameter(pItem:IInteractable):Boolean
Test if the IInteractable is aceptable as action parameter
| IAction | ||
| isReady | property |
isReady:Boolean [read-only]Returns true if the action has all the scene or inventory item needed as parameters for the action.
Implementation public function get isReady():Boolean
| paramsNumber | property |
paramsNumber:int [read-only]The number of parameters used by the action. Usually 1 or 2.
Implementation public function get paramsNumber():int
| AddParameter | () | method |
public function AddParameter(pItem:IInteractable):voidAdd an IInteractable as action parameter.
ParameterspItem:IInteractable — an scene item.
|
| CanExecute | () | method |
public function CanExecute(pIterator:IIterator):BooleanTests if the action can execute.
ParameterspIterator:IIterator — iterator of Puzzles Controller.
|
Boolean — true if the action found a method for the execution.
|
| Execute | () | method |
public function Execute(pIterator:IIterator):BooleanExecutes the action.
ParameterspIterator:IIterator — iterator of Puzzles Controller.
|
Boolean — true if the action found a method for the execution.
|
| GetId | () | method |
public function GetId():StringThe action identificator.
ReturnsString |
| GetNoActionText | () | method |
public function GetNoActionText():StringIf no method found for the action, you usually gets a generic message this method returns that message.
ReturnsString — No action message for this action.
|
| GetParam1 | () | method |
public function GetParam1():IInteractableThe first parameter of the action.
ReturnsIInteractable —
IInteractable parameter.
|
| GetParam2 | () | method |
public function GetParam2():IInteractableThe second parameter of the action.
ReturnsIInteractable —
IInteractable parameter.
|
| GetText | () | method |
public function GetText():StringGet the action localized text for player's interface uses.
ReturnsString |
| TestParameter | () | method |
public function TestParameter(pItem:IInteractable):BooleanTest if the IInteractable is aceptable as action parameter
ParameterspItem:IInteractable — true if the action accept the pItem as parameter.
|
Boolean |