Packagecom.pblabs.engine.components
Classpublic class GroupManagerComponent
InheritanceGroupManagerComponent Inheritance EntityComponent Inheritance Object

Utility class to manage a group of entities marked with GroupManagerComponent.



Public Properties
 PropertyDefined By
  autoCreateNamedGroups : Boolean = true
[static]
GroupManagerComponent
  entityList : Array
[read-only]
GroupManagerComponent
 InheritedisRegistered : Boolean
[read-only] Whether or not the component is currently registered with an entity.
EntityComponent
 Inheritedname : String
[read-only] The name given to the component when it is added to an entity.
EntityComponent
 Inheritedowner : IEntity
A reference to the entity that this component currently belongs to.
EntityComponent
Public Methods
 MethodDefined By
  
GroupManagerComponent
  
[static]
GroupManagerComponent
 Inherited
register(owner:IEntity, name:String):void
Registers the component with an entity.
EntityComponent
  
GroupManagerComponent
 Inherited
reset():void
This is called by an entity on all of its components any time a component is added or removed.
EntityComponent
 Inherited
unregister():void
Unregisters the component from an entity.
EntityComponent
Protected Methods
 MethodDefined By
 Inherited
onAdd():void
This is called when the component is added to an entity.
EntityComponent
 Inherited
onRemove():void
This is called when the component is removed from an entity.
EntityComponent
 Inherited
onReset():void
This is called anytime a component is added or removed from the owner entity.
EntityComponent
Property Detail
autoCreateNamedGroupsproperty
public static var autoCreateNamedGroups:Boolean = true

entityListproperty 
entityList:Array  [read-only]


Implementation
    public function get entityList():Array
Method Detail
addMember()method
public function addMember(member:GroupMemberComponent):void

Parameters

member:GroupMemberComponent

getGroupByName()method 
public static function getGroupByName(name:String):GroupManagerComponent

Parameters

name:String

Returns
GroupManagerComponent
removeMember()method 
public function removeMember(member:GroupMemberComponent):void

Parameters

member:GroupMemberComponent