Packagecom.bourre.commands
Classpublic class CommandMS
SubclassesCommandManagerMS

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The CommandMS class manages a Commands list to execute on using timer tick.

See also

CommandManagerMS

Public Methods
 MethodDefined by
  
CommandMS()
Creates new CommandMS instance.
CommandMS
  
delay(oC:Command, nMs:Number):String
Stores passed-in command and wait for passed-in timer before executes it.
Command is removed after execution.
CommandMS
  
getLength():Number
Returns execution list length.
CommandMS
  
push(oC:Command, nMs:Number):String
Adds passed-in command to execution list and execute it now.
CommandMS
  
pushWithName(oC:Command, nMs:Number, sN:String = null):String
Adds passed-in command to execution list and executes it now.
CommandMS
  
remove(oC:Command):Boolean
Removes passed-in command from execution list.
CommandMS
  
removeAll():void
Removes all objects from execution list and from buffer.
CommandMS
  
removeWithName(sN:String):Boolean
Removes command registered with passed-in name from execution list.
CommandMS
  
resume(oC:Command):Boolean
Submits passed-in command into execution list.
CommandMS
  
resumeWithName(sN:String):Boolean
Submits command registered with passed-in name into execution list.
CommandMS
  
stop(oC:Command):Boolean
Excludes passed-in command from execution list.
CommandMS
  
stopWithName(sN:String):Boolean
Excludes command registered with passed-in name from execution list.
CommandMS
  
toString():String
Returns string representation of instance.
CommandMS
Protected Methods
 MethodDefined by
  
_delay(sN:String):void
Executes a delay call.
CommandMS
  
_getNameID():String
Returns a unique identifier.
CommandMS
  
_notify(s:String):Boolean
Adds command registered with passed-in identifier into execution list.
CommandMS
  
_push(oC:Command, nMs:Number, sN:String):String
Registers passed-in command with passed-in name.
CommandMS
  
_remove(s:String):Boolean
CommandMS
  
_stop(s:String):Boolean
Removes command registered with passed-in identifier.
CommandMS
Constructor detail
CommandMS()constructor
public function CommandMS()

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates new CommandMS instance.

Method detail
_delay()method
protected function _delay(sN:String):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Executes a delay call.

Parameters
sN:String — Command to execute
_getNameID()method 
protected function _getNameID():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns a unique identifier.

Returns
String
_notify()method 
protected function _notify(s:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds command registered with passed-in identifier into execution list.

Parameters
s:String — Command identifier

Returns
Boolean
_push()method 
protected function _push(oC:Command, nMs:Number, sN:String):String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Registers passed-in command with passed-in name.

Parameters
oC:Command — Command to push
 
nMs:Number — Command execution timer
 
sN:String — Command identifier

Returns
String
_remove()method 
protected function _remove(s:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Parameters
s:String

Returns
Boolean
_stop()method 
protected function _stop(s:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes command registered with passed-in identifier.

Parameters
s:String — Command identifier

Returns
Boolean
delay()method 
public function delay(oC:Command, nMs:Number):String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Stores passed-in command and wait for passed-in timer before executes it.
Command is removed after execution.

An identifier name is automatically build

Parameters
oC:Command — Command to delayed
 
nMs:Number — Command execution timer

Returns
String — The command identifier name in list
getLength()method 
public function getLength():Number

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns execution list length.

Returns
Number — The execution list length.
push()method 
public function push(oC:Command, nMs:Number):String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds passed-in command to execution list and execute it now.

An identifier name is automatically build

Parameters
oC:Command — Command to add
 
nMs:Number

Returns
String — The command identifier name in list

See also

pushWithName()
pushWithName()method 
public function pushWithName(oC:Command, nMs:Number, sN:String = null):String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Adds passed-in command to execution list and executes it now.

Parameters
oC:Command — Command to add
 
nMs:Number — Command execution timer
 
sN:String (default = null) — Command identifier

Returns
String — The command identifier name in list
remove()method 
public function remove(oC:Command):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes passed-in command from execution list.

Parameters
oC:Command — Command to remove

Returns
Boolean — true if command is removed
removeAll()method 
public function removeAll():void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes all objects from execution list and from buffer.

removeWithName()method 
public function removeWithName(sN:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Removes command registered with passed-in name from execution list.

Parameters
sN:String — Name of the command remove

Returns
Boolean — true if command is removed

See also

push()
pushWithName()
delay()
resume()method 
public function resume(oC:Command):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Submits passed-in command into execution list.

Parameters
oC:Command — Command to submit to execution list.

Returns
Boolean
resumeWithName()method 
public function resumeWithName(sN:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Submits command registered with passed-in name into execution list.

Parameters
sN:String — Command identifier

Returns
Boolean
stop()method 
public function stop(oC:Command):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Excludes passed-in command from execution list.

Command still in buffer, use resume() to replace command in execution list.

Parameters
oC:Command — Command to exclude form execution list.

Returns
Boolean
stopWithName()method 
public function stopWithName(sN:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Excludes command registered with passed-in name from execution list.

Command still in buffer, use resumeWithName() to replace command in execution list.

Parameters
sN:String — Command identifier

Returns
Boolean
toString()method 
public function toString():String

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns string representation of instance.

Returns
String — The string representation of instance.



Submit Feedback
LowRA API documentation 2008- 2009
Licensed under the MOZILLA PUBLIC LICENSE, Version 1.1
mer. févr. 25 2009, 9:22 AM GMT+01:00