Packageverlocity.components
Classpublic final class verEnts
InheritanceverEnts Inheritance Component Inheritance Singleton Inheritance Object

Manages all the entities. The entity manager which handles updating, memory management, and rendering of entities. The entities are handled in a linked list data structure.


Public Properties
 PropertyDefined By
 InheritedclassName : Object
[read-only] Returns the class name of the component for dictionary registration.
Component
Protected Properties
 PropertyDefined By
 Inheritedstage : Stage
Component
Public Methods
 MethodDefined By
  
verEnts()
Constructor of the component.
verEnts
  
_Destruct():void
[override] Destructor of the component.
verEnts
 Inherited
_IsNotUpdating():Boolean
Returns if the component is not updating (paused).
Component
 Inherited
_IsValid():Boolean
Returns if this singleton is active/valid.
Singleton
 Inherited
_SetUpdating(bUpdating:Boolean):void
Pauses/resumes the component updating, if it's pausable.
Component
 Inherited
_UpdateComponent():void
Updates the component, if possible.
Component
  
CountAll():int
Returns the amount of current entities.
verEnts
  
Create(entClass:Class, bCollision:Boolean = true, dispObject:DisplayObject = null, bBitmap:Boolean = false):*
Creates an entity.
verEnts
  
CreateDrawable(bCollision:Boolean):DisplayEntity
Creates a display object entity with a sprite display object.
verEnts
  
CreateEffect(mc:MovieClip, bBitmap:Boolean = false):Effect
Creates an effect.
verEnts
  
CreateScreenEffect(scrFX:ScreenEffect, bAddOnTop:Boolean = true, bProtected:Boolean = false):*
Creates and spawns a screen effect.
verEnts
  
GetAll():Array
Returns all of the current entities.
verEnts
  
GetByClass(entClass:Class):Array
Returns an array of entities by class name.
verEnts
  
GetByType(sType:String):Array
Returns an array of entities by type.
verEnts
  
GetLinkedList():LinkedList
Returns the linked list that holds all the entities.
verEnts
  
PauseAllAnimations():void
Pauses animations of all entities that have animations.
verEnts
  
RemoveAll(bRemoveProtected:Boolean = false):void
Removes all of the entities.
verEnts
  
RemoveAllClass(entClass:Class, bRemoveProtected:Boolean = false):void
Removes all entities based on class name.
verEnts
  
RemoveAllType(sType:String, bRemoveProtected:Boolean = false):void
Removes all entities based on type.
verEnts
  
RemoveAllTypes(aArray:Array, bRemoveProtected:Boolean = false):void
Removes all entities based on an array of types.
verEnts
  
ResetAll():void
Resets all entities (calls their reset and init function).
verEnts
  
ResumeAllAnimations():void
Resumes animations of all entities that have animations.
verEnts
Protected Methods
 MethodDefined By
  
_Concommands():void
[override] Concommands of the component.
verEnts
  
_Update():void
[override] Updates all the different lists of entities.
verEnts
Constructor Detail
verEnts()Constructor
public function verEnts()

Constructor of the component.

Method Detail
_Concommands()method
override protected function _Concommands():void

Concommands of the component.

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

Destructor of the component.

_Update()method 
override protected function _Update():void

Updates all the different lists of entities.

CountAll()method 
public final function CountAll():int

Returns the amount of current entities.

Returns
int —
Create()method 
public final function Create(entClass:Class, bCollision:Boolean = true, dispObject:DisplayObject = null, bBitmap:Boolean = false):*

Creates an entity.

Parameters

entClass:Class — The class of the entity you wish to create
 
bCollision:Boolean (default = true) — Should collision be checked on this?
 
dispObject:DisplayObject (default = null) — The display object that represents the artwork of the entity
 
bBitmap:Boolean (default = false)

Returns
* —
CreateDrawable()method 
public final function CreateDrawable(bCollision:Boolean):DisplayEntity

Creates a display object entity with a sprite display object. This is useful for creating a simple drawable entity using the graphics class.

Parameters

bCollision:Boolean — Should collision be checked on this?

Returns
DisplayEntity —
CreateEffect()method 
public final function CreateEffect(mc:MovieClip, bBitmap:Boolean = false):Effect

Creates an effect. Effects are one time animations objects without collision.

Parameters

mc:MovieClip — The movieclip effect.
 
bBitmap:Boolean (default = false) — Bitmap the effect?

Returns
Effect —
CreateScreenEffect()method 
public final function CreateScreenEffect(scrFX:ScreenEffect, bAddOnTop:Boolean = true, bProtected:Boolean = false):*

Creates and spawns a screen effect. Screen effects are displayed on the top of the entire screen.

Parameters

scrFX:ScreenEffect — Screen effect to spawn
 
bAddOnTop:Boolean (default = true) — Is it protected?
 
bProtected:Boolean (default = false)

Returns
* —
GetAll()method 
public final function GetAll():Array

Returns all of the current entities.

Returns
Array —
GetByClass()method 
public final function GetByClass(entClass:Class):Array

Returns an array of entities by class name.

Parameters

entClass:Class — The class name to search by

Returns
Array —
GetByType()method 
public final function GetByType(sType:String):Array

Returns an array of entities by type.

Parameters

sType:String — The type to search by

Returns
Array —
GetLinkedList()method 
public final function GetLinkedList():LinkedList

Returns the linked list that holds all the entities.

Returns
LinkedList —
PauseAllAnimations()method 
public final function PauseAllAnimations():void

Pauses animations of all entities that have animations.

RemoveAll()method 
public final function RemoveAll(bRemoveProtected:Boolean = false):void

Removes all of the entities.

Parameters

bRemoveProtected:Boolean (default = false) — Should we remove protected entities?

RemoveAllClass()method 
public final function RemoveAllClass(entClass:Class, bRemoveProtected:Boolean = false):void

Removes all entities based on class name.

Parameters

entClass:Class — The class to remove by
 
bRemoveProtected:Boolean (default = false) — Should we remove protected entities?

RemoveAllType()method 
public final function RemoveAllType(sType:String, bRemoveProtected:Boolean = false):void

Removes all entities based on type.

Parameters

sType:String — The type to remove by
 
bRemoveProtected:Boolean (default = false) — Should we remove protected entities?

RemoveAllTypes()method 
public final function RemoveAllTypes(aArray:Array, bRemoveProtected:Boolean = false):void

Removes all entities based on an array of types.

Parameters

aArray:Array — The array of string types
 
bRemoveProtected:Boolean (default = false)

ResetAll()method 
public final function ResetAll():void

Resets all entities (calls their reset and init function). This occurs each time a state is soft reset.

ResumeAllAnimations()method 
public final function ResumeAllAnimations():void

Resumes animations of all entities that have animations.





Wed Feb 29 2012, 07:04 PM -08:00