Packagenet.flashpunk.masks
Classpublic class Masklist
InheritanceMasklist Inheritance Hitbox Inheritance Mask Inheritance Object

A Mask that can contain multiple Masks of one or various types.



Public Properties
 PropertyDefined By
  count : uint
[read-only] Amount of Masks in the list.
Masklist
 Inheritedheight : int
Height.
Hitbox
 Inheritedlist : Masklist
The parent Masklist of the mask.
Mask
 Inheritedparent : Entity
The parent Entity of this mask.
Mask
 Inheritedwidth : int
Width.
Hitbox
 Inheritedx : int
X offset.
Hitbox
 Inheritedy : int
Y offset.
Hitbox
Public Methods
 MethodDefined By
  
Masklist(... mask)
Constructor.
Masklist
  
add(mask:Mask):Mask
Adds a Mask to the list.
Masklist
  
assignTo(parent:Entity):void
[override]
Masklist
 Inherited
collide(mask:Mask):Boolean
Checks for collision with another Mask.
Mask
  
getMask(index:uint = 0):Mask
Gets a Mask from the list.
Masklist
  
Removes the Mask from the list.
Masklist
  
removeAll():void
Removes all Masks from the list.
Masklist
  
removeAt(index:uint = 0):void
Removes the Mask at the index.
Masklist
  
renderDebug(g:Graphics):void
[override] Used to render debug information in console.
Masklist
  
update():void
[override]
Masklist
Property Detail
countproperty
count:uint  [read-only]

Amount of Masks in the list.


Implementation
    public function get count():uint
Constructor Detail
Masklist()Constructor
public function Masklist(... mask)

Constructor.

Parameters
... mask — Masks to add to the list.
Method Detail
add()method
public function add(mask:Mask):Mask

Adds a Mask to the list.

Parameters

mask:Mask — The Mask to add.

Returns
Mask — The added Mask.
assignTo()method 
override public function assignTo(parent:Entity):void

Parameters

parent:Entity

getMask()method 
public function getMask(index:uint = 0):Mask

Gets a Mask from the list.

Parameters

index:uint (default = 0) — The Mask index.

Returns
Mask — The Mask at the index.
remove()method 
public function remove(mask:Mask):Mask

Removes the Mask from the list.

Parameters

mask:Mask — The Mask to remove.

Returns
Mask — The removed Mask.
removeAll()method 
public function removeAll():void

Removes all Masks from the list.

removeAt()method 
public function removeAt(index:uint = 0):void

Removes the Mask at the index.

Parameters

index:uint (default = 0) — The Mask index.

renderDebug()method 
override public function renderDebug(g:Graphics):void

Used to render debug information in console.

Parameters

g:Graphics

update()method 
override public function update():void