Packagecom.bourre.commands
Classpublic class CommandFPS
ImplementsTickListener
SubclassesCommandManagerFPS

Player version: Flash Player 9.0
Language version: ActionScript 3.0

The CommandFPS class manages a Commands list to execute on each frame (FPS).

See also

CommandManagerFPS


Public Methods
 MethodDefined by
  
Creates new ComandFPS instance.
CommandFPS
  
delay(oC:Command):String
Stores passed-in command and wait for a loop before executes it.
Command is removed after execution.
CommandFPS
  
getLength():Number
Returns execution list length.
CommandFPS
  
onTick(e:Event = null):void
Method called by the TickBeacon for each step of time according to its time slicing approach.
CommandFPS
  
push(oC:Command):String
Adds passed-in command to execution list and execute it now.
CommandFPS
  
pushWithName(oC:Command, sN:String = null):String
Adds passed-in command to execution list and executes it now.
CommandFPS
  
remove(oC:Command):Boolean
Removes passed-in command from execution list.
CommandFPS
  
removeAll():void
Removes all objects from execution list and from buffer.
CommandFPS
  
removeWithName(sN:String):Boolean
Removes command registered with passed-in name from execution list.
CommandFPS
  
resume(oC:Command):Boolean
Submits passed-in command into execution list.
CommandFPS
  
resumeWithName(sN:String):Boolean
Submits command registered with passed-in name into execution list.
CommandFPS
  
stop(oC:Command):Boolean
Excludes passed-in command from execution list.
CommandFPS
  
stopWithName(sN:String):Boolean
Excludes command registered with passed-in name from execution list.
CommandFPS
  
toString():String
Returns string representation of instance.
CommandFPS
Protected Methods
 MethodDefined by
  
_delay(oC:Command, sN:String):void
Executes a delay call.
CommandFPS
  
_getNameID():String
Returns a unique identifier.
CommandFPS
  
_push(oC:Command, sN:String):String
Registers passed-in command with passed-in name.
CommandFPS
  
_remove(s:String):Boolean
Removes command registered with passed-in identifier.
CommandFPS
  
_resume(s:String):Boolean
Adds command registered with passed-in identifier into execution list.
CommandFPS
  
_stop(s:String):Boolean
Excludes command registered with passed-in identifier from execution list.
CommandFPS
Constructor detail
CommandFPS()constructor
public function CommandFPS()

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Creates new ComandFPS instance.

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

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Executes a delay call.

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

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Returns a unique identifier.

Returns
String
_push()method 
protected function _push(oC:Command, 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
 
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

Removes command registered with passed-in identifier.

Parameters
s:String — Command identifier

Returns
Boolean
_resume()method 
protected function _resume(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
_stop()method 
protected function _stop(s:String):Boolean

Player version: Flash Player 9.0
Language version: ActionScript 3.0

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

Parameters
s:String — Command identifier

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

Player version: Flash Player 9.0
Language version: ActionScript 3.0

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

An identifier name is automatically build

Parameters
oC:Command — Command to delayed

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.
onTick()method 
public function onTick(e:Event = null):void

Player version: Flash Player 9.0
Language version: ActionScript 3.0

Method called by the TickBeacon for each step of time according to its time slicing approach.

The onTick method is very similar to the old onEnterFrame method, but doesn't specifically occurs when entering in a new frame of a frame-based animation. The tick could be the result of a setInterval call, or a change in the timecode of a video.

Parameters
e:Event (default = null) — event dispatched by the beacon object
push()method 
public function push(oC:Command):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

Returns
String — The command identifier name in list

See also

pushWithName()method 
public function pushWithName(oC:Command, 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
 
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
Booleantrue 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
Booleantrue if command is removed

See also

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.