Packagecom.whirled.contrib.platformer.board
Classpublic class Board

The base class for a board which contains pieces.


Protected Properties
 PropertyDefined by
  _actors : Object
Board
  _bound : Array
Board
  _dynamicIns : Object
Board
  _dynamics : Object
Board
  _globalDynamicIns : Object
Board
  _groupNames : Array
Board
  _listeners : Map
Board
  _maxId : int
Board
  _name : String
Board
  _pieceTree : Array
All the pieces on the board.
Board
  _shotId : int = 1000000
Board
  _shots : Object
Board
  _xml : XML
The XML definition.
Board
Public Methods
 MethodDefined by
  
Board()
Board
  
addActor(a:Actor):void
Board
  
addDynamic(d:Dynamic):void
Board
  
addDynamicIns(d:Dynamic, group:String):void
Board
  
addEventListener(eventName:String, callback:Function):void
Board
  
addPiece(p:Piece, tree:String):void
Board
  
addPieceGroup(tree:String, name:String):void
Board
  
addShot(s:Shot):void
Board
  
flipPiece(name:String, tree:String):void
Board
  
getActor(id:int):Actor
Board
  
getActors():Object
Board
  
getBackgroundXML():XML
Board
  
getBound(idx:int):int
Board
  
getDynamic(id:int):Dynamic
Board
  
getDynamicIns(group:String = null):Object
Board
  
getDynamicInsById(id:int):Dynamic
Board
  
getDynamics():Object
Board
  
getDynamicsXML(group:String):XML
Board
  
getEventXML():XML
Board
  
getGroupNames():Array
Board
  
getItem(name:String, tree:String):Object
Board
  
getMaxId():int
Board
  
getName():String
Board
  
getPieces():Array
Board
  
getPieceTreeXML():XML
Board
  
getXML():XML
Board
  
hasActor(a:Actor):Boolean
Board
  
hasDynamic(d:Dynamic):Boolean
Board
  
loadDynamic(xml:XML):Dynamic
[static]
Board
  
loadFromXML(level:XML):void
Board
  
moveItemBack(name:String, tree:String):void
Board
  
moveItemDown(name:String, tree:String):void
Board
  
moveItemForward(name:String, tree:String):void
Board
  
moveItemUp(name:String, tree:String):void
Board
  
removeDynamic(d:Dynamic):void
Board
  
removeEventListener(eventName:String, callback:Function):void
Board
  
removeItem(name:String, tree:String):void
Board
  
reserveId():int
Board
  
setBound(idx:int, bound:int):void
Board
  
setName(name:String):void
Board
  
updateDynamicIns(d:Dynamic, group:String):void
Board
  
updatePiece(name:String, tree:String, xml:XML):void
Board
Protected Methods
 MethodDefined by
  
addOrReplaceXML(source:XML, nodename:String, node:XML):void
Board
  
adjustMaxId(d:Dynamic):void
Board
  
boardHas(child:String):Boolean
Board
  
debug(msg:String):void
[static]
Board
  
genDynamicsXML(dynamics:Object, nodename:String):XML
Board
  
genPieceTreeXML(pieces:Array):XML
Board
  
getGroup(tree:String):Object
Board
  
isItem(item:Object, name:String):Boolean
Board
  
loadCoords(xml:XML, arr:Array):void
Board
  
loadDynamics(xml:XML, arr:Object):void
Board
  
loadPieceTree(xml:XML, arr:Array):void
Board
  
sendEvent(eventName:String, ... args):void
Board
  
setDynamicIns(group:String, d:Dynamic):void
Board
Public Constants
 ConstantDefined by
  ACTOR_ADDED : String = "actor_added"
[static]
Board
  ACTORS : String = "actors"
[static]
Board
  BOTTOM_BOUND : int = 2
[static]
Board
  DEBUG : Boolean = false
[static]
Board
  DYNAMIC_ADDED : String = "dynamic_added"
[static]
Board
  DYNAMIC_REMOVED : String = "dynamic_removed"
[static]
Board
  GATES : String = "gates"
[static]
Board
  GENERICS : String = "generics"
[static]
Board
  GROUP_ADDED : String = "group_added"
[static]
Board
  ITEM_BACK : String = "back"
[static]
Board
  ITEM_DOWN : String = "down"
[static]
Board
  ITEM_FORWARD : String = "forward"
[static]
Board
  ITEM_REMOVED : String = "item_removed"
[static]
Board
  ITEM_UP : String = "up"
[static]
Board
  ITEM_UPDATED : String = "updated"
[static]
Board
  LEFT_BOUND : int = 3
[static]
Board
  PIECE_ADDED : String = "added"
[static]
Board
  PIECE_LOADED : String = "loaded"
[static]
Board
  PIECE_REMOVED : String = "removed"
[static]
Board
  PLATFORMS : String = "platforms"
[static]
Board
  RIGHT_BOUND : int = 1
[static]
Board
  SHOT_ADDED : String = "shot_added"
[static]
Board
  SPAWNERS : String = "spawners"
[static]
Board
  TOP_BOUND : int = 0
[static]
Board
Protected Constants
 ConstantDefined by
  LOCAL_BASE : int = 10000
[static]
Board
  SHOT_BASE : int = 1000000
[static]
Board
Property detail
_actorsproperty
protected var _actors:Object
_boundproperty 
protected var _bound:Array
_dynamicInsproperty 
protected var _dynamicIns:Object
_dynamicsproperty 
protected var _dynamics:Object
_globalDynamicInsproperty 
protected var _globalDynamicIns:Object
_groupNamesproperty 
protected var _groupNames:Array
_listenersproperty 
protected var _listeners:Map
_maxIdproperty 
protected var _maxId:int
_nameproperty 
protected var _name:String
_pieceTreeproperty 
protected var _pieceTree:Array

All the pieces on the board.

_shotIdproperty 
protected var _shotId:int = 1000000
_shotsproperty 
protected var _shots:Object
_xmlproperty 
protected var _xml:XML

The XML definition.

Constructor detail
Board()constructor
public function Board()
Method detail
addActor()method
public function addActor(a:Actor):voidParameters
a:Actor
addDynamic()method 
public function addDynamic(d:Dynamic):voidParameters
d:Dynamic
addDynamicIns()method 
public function addDynamicIns(d:Dynamic, group:String):voidParameters
d:Dynamic
 
group:String
addEventListener()method 
public function addEventListener(eventName:String, callback:Function):voidParameters
eventName:String
 
callback:Function
addOrReplaceXML()method 
protected function addOrReplaceXML(source:XML, nodename:String, node:XML):voidParameters
source:XML
 
nodename:String
 
node:XML
addPiece()method 
public function addPiece(p:Piece, tree:String):voidParameters
p:Piece
 
tree:String
addPieceGroup()method 
public function addPieceGroup(tree:String, name:String):voidParameters
tree:String
 
name:String
addShot()method 
public function addShot(s:Shot):voidParameters
s:Shot
adjustMaxId()method 
protected function adjustMaxId(d:Dynamic):voidParameters
d:Dynamic
boardHas()method 
protected function boardHas(child:String):BooleanParameters
child:String

Returns
Boolean
debug()method 
protected static function debug(msg:String):voidParameters
msg:String
flipPiece()method 
public function flipPiece(name:String, tree:String):voidParameters
name:String
 
tree:String
genDynamicsXML()method 
protected function genDynamicsXML(dynamics:Object, nodename:String):XMLParameters
dynamics:Object
 
nodename:String

Returns
XML
genPieceTreeXML()method 
protected function genPieceTreeXML(pieces:Array):XMLParameters
pieces:Array

Returns
XML
getActor()method 
public function getActor(id:int):ActorParameters
id:int

Returns
Actor
getActors()method 
public function getActors():Object

Returns
Object
getBackgroundXML()method 
public function getBackgroundXML():XML

Returns
XML
getBound()method 
public function getBound(idx:int):intParameters
idx:int

Returns
int
getDynamic()method 
public function getDynamic(id:int):DynamicParameters
id:int

Returns
Dynamic
getDynamicIns()method 
public function getDynamicIns(group:String = null):ObjectParameters
group:String (default = null)

Returns
Object
getDynamicInsById()method 
public function getDynamicInsById(id:int):DynamicParameters
id:int

Returns
Dynamic
getDynamics()method 
public function getDynamics():Object

Returns
Object
getDynamicsXML()method 
public function getDynamicsXML(group:String):XMLParameters
group:String

Returns
XML
getEventXML()method 
public function getEventXML():XML

Returns
XML
getGroup()method 
protected function getGroup(tree:String):ObjectParameters
tree:String

Returns
Object
getGroupNames()method 
public function getGroupNames():Array

Returns
Array
getItem()method 
public function getItem(name:String, tree:String):ObjectParameters
name:String
 
tree:String

Returns
Object
getMaxId()method 
public function getMaxId():int

Returns
int
getName()method 
public function getName():String

Returns
String
getPieces()method 
public function getPieces():Array

Returns
Array
getPieceTreeXML()method 
public function getPieceTreeXML():XML

Returns
XML
getXML()method 
public function getXML():XML

Returns
XML
hasActor()method 
public function hasActor(a:Actor):BooleanParameters
a:Actor

Returns
Boolean
hasDynamic()method 
public function hasDynamic(d:Dynamic):BooleanParameters
d:Dynamic

Returns
Boolean
isItem()method 
protected function isItem(item:Object, name:String):BooleanParameters
item:Object
 
name:String

Returns
Boolean
loadCoords()method 
protected function loadCoords(xml:XML, arr:Array):voidParameters
xml:XML
 
arr:Array
loadDynamic()method 
public static function loadDynamic(xml:XML):DynamicParameters
xml:XML

Returns
Dynamic
loadDynamics()method 
protected function loadDynamics(xml:XML, arr:Object):voidParameters
xml:XML
 
arr:Object
loadFromXML()method 
public function loadFromXML(level:XML):voidParameters
level:XML
loadPieceTree()method 
protected function loadPieceTree(xml:XML, arr:Array):voidParameters
xml:XML
 
arr:Array
moveItemBack()method 
public function moveItemBack(name:String, tree:String):voidParameters
name:String
 
tree:String
moveItemDown()method 
public function moveItemDown(name:String, tree:String):voidParameters
name:String
 
tree:String
moveItemForward()method 
public function moveItemForward(name:String, tree:String):voidParameters
name:String
 
tree:String
moveItemUp()method 
public function moveItemUp(name:String, tree:String):voidParameters
name:String
 
tree:String
removeDynamic()method 
public function removeDynamic(d:Dynamic):voidParameters
d:Dynamic
removeEventListener()method 
public function removeEventListener(eventName:String, callback:Function):voidParameters
eventName:String
 
callback:Function
removeItem()method 
public function removeItem(name:String, tree:String):voidParameters
name:String
 
tree:String
reserveId()method 
public function reserveId():int

Returns
int
sendEvent()method 
protected function sendEvent(eventName:String, ... args):voidParameters
eventName:String
 
... args
setBound()method 
public function setBound(idx:int, bound:int):voidParameters
idx:int
 
bound:int
setDynamicIns()method 
protected function setDynamicIns(group:String, d:Dynamic):voidParameters
group:String
 
d:Dynamic
setName()method 
public function setName(name:String):voidParameters
name:String
updateDynamicIns()method 
public function updateDynamicIns(d:Dynamic, group:String):voidParameters
d:Dynamic
 
group:String
updatePiece()method 
public function updatePiece(name:String, tree:String, xml:XML):voidParameters
name:String
 
tree:String
 
xml:XML
Constant detail
ACTOR_ADDEDconstant
public static const ACTOR_ADDED:String = "actor_added"
ACTORSconstant 
public static const ACTORS:String = "actors"
BOTTOM_BOUNDconstant 
public static const BOTTOM_BOUND:int = 2
DEBUGconstant 
public static const DEBUG:Boolean = false
DYNAMIC_ADDEDconstant 
public static const DYNAMIC_ADDED:String = "dynamic_added"
DYNAMIC_REMOVEDconstant 
public static const DYNAMIC_REMOVED:String = "dynamic_removed"
GATESconstant 
public static const GATES:String = "gates"
GENERICSconstant 
public static const GENERICS:String = "generics"
GROUP_ADDEDconstant 
public static const GROUP_ADDED:String = "group_added"
ITEM_BACKconstant 
public static const ITEM_BACK:String = "back"
ITEM_DOWNconstant 
public static const ITEM_DOWN:String = "down"
ITEM_FORWARDconstant 
public static const ITEM_FORWARD:String = "forward"
ITEM_REMOVEDconstant 
public static const ITEM_REMOVED:String = "item_removed"
ITEM_UPconstant 
public static const ITEM_UP:String = "up"
ITEM_UPDATEDconstant 
public static const ITEM_UPDATED:String = "updated"
LEFT_BOUNDconstant 
public static const LEFT_BOUND:int = 3
LOCAL_BASEconstant 
protected static const LOCAL_BASE:int = 10000
PIECE_ADDEDconstant 
public static const PIECE_ADDED:String = "added"
PIECE_LOADEDconstant 
public static const PIECE_LOADED:String = "loaded"
PIECE_REMOVEDconstant 
public static const PIECE_REMOVED:String = "removed"
PLATFORMSconstant 
public static const PLATFORMS:String = "platforms"
RIGHT_BOUNDconstant 
public static const RIGHT_BOUND:int = 1
SHOT_ADDEDconstant 
public static const SHOT_ADDED:String = "shot_added"
SHOT_BASEconstant 
protected static const SHOT_BASE:int = 1000000
SPAWNERSconstant 
public static const SPAWNERS:String = "spawners"
TOP_BOUNDconstant 
public static const TOP_BOUND:int = 0