svs_simulation.entities.customentities.CustomEntityGroup

Package svs_simulation :: Package entities :: Module customentities :: Class CustomEntityGroup

[show private | hide private]

Class CustomEntityGroup

 Entity --+    
          |    
EntityGroup --+
              |
             CustomEntityGroup

Holds a collection of entities all generated from the same custom source code, and maintains reference to the source.

Method Summary
	`__init__(self, name, sourceReference)`
`svs_simulation.entities.base_entities.Entity`	`createInstanceFromFile(self, filename)` Instantiates version of custom entity class from given file and adds it to group.
Inherited from EntityGroup
	`__str__(self)` Returns string representation of object.
	`addMember(self, member)` Adds member to group, making sure it is unique.
	`decode(self, data)` Applies encoded data to self.
	`encode(self)` Returns encoded representation of self.
	`getMembers(self)` Returns all memebrs as a list.
	`removeMember(self, member)` Removes member from group.
	`setup(self, name)`
Inherited from Entity
	`enterPartition(self, partition)` Called when entity enters a partition.
	`enterStructure(self, structure)` Called when entity enters a structure.
	`enterWorld(self, world)` Called when entity is added to world.
	`exitPartition(self, partition)` Called when entity is leaves a structure.
	`exitWorld(self, simTime)` Called when structure is removed world.
	`getName(self)` If the entity has a name, return this, otherwise returns a name created from its class name and unique id.
	`handleSimEvent(self, event)` Handles event form simulation.
boolean	`isTagged(self)` Returns tag state.
	`placeInWorld(self)` Sets the structure and partition that the entity is within.
	`reportChange(self, data)` Forwards data representing change in entity to process handler.
	`startWorld(self, simTime)` Called when the simulation world starts running, or if an entity has been added to a world after it has started.
	`stopWorld(self, simTime)` Called when the simulation world stops running, or if an entity has been removed from a world after it has started.
	`updateWorld(self, simTime)` Called when the simulation world updates.

Method Details

createInstanceFromFile(self, filename)

Instantiates version of custom entity class from given file and adds it to group.

Returns:: svs_simulation.entities.base_entities.Entity

Generated by Epydoc 2.1 on Thu Oct 20 15:30:28 2005

http://epydoc.sf.net