Module GameTypes :: Class CListValue

Class CListValue

PyObjectPlus --+        
               |        
          CValue --+    
                   |    
          CPropValue --+
                       |
                      CListValue

CListValue

This is a list like object used in the game engine internally that behaves similar to a python list in most ways.

As well as the normal index lookup. val= clist[i]

CListValue supports string lookups. val= scene.objects["OBCube"]

Other operations such as len(clist), list(clist), clist[0:10] are also supported.

Instance Methods

append(val)
Add an item to the list (like pythons append)

integer

count(val)
Count the number of instances of a value in the list.

integer

index(val)
Return the index of a value in the list.

reverse()
Reverse the order of the list.

get(key, default=None)
Return the value matching key, or the default value if its not found.

boolean

has_key(key)
Return True if the key is found.

from_id(id)
This is a funtion especially for the game engine to return a value with a spesific id.

bool

isA(game_type)
Check if this is a type or a subtype game_type. (Inherited from GameTypes.PyObjectPlus)

Deprecated

string

getName()
Returns the name of the CValue. (Inherited from GameTypes.CValue)

Instance Variables
bool	invalid Test if the object has been freed by the game engine and is no longer valid. (Inherited from GameTypes.PyObjectPlus)
string	name The name of this CValue derived object (read-only). (Inherited from GameTypes.CValue)

Method Details

append(val)

Add an item to the list (like pythons append)

Warning: Appending values to the list can cause crashes when the list is used internally by the game engine.

count(val)

Count the number of instances of a value in the list.

Returns: integer: number of instances

index(val)

Return the index of a value in the list.

Returns: integer: The index of the value in the list.

get(key, default=None)

Return the value matching key, or the default value if its not found.

Returns:: The key value or a default.

has_key(key)

Return True if the key is found.

Returns: boolean: The key value or a default.

from_id(id)

This is a funtion especially for the game engine to return a value with a spesific id.

Since object names are not always unique, the id of an object can be used to get an object from the CValueList.

Example.

myObID = id(gameObject)

...

ob= scene.objects.from_id(myObID)

Where myObID is an int or long from the id function.

This has the advantage that you can store the id in places you could not store a gameObject.

Warning: the id is derived from a memory location and will be different each time the game engine starts.