This reference page is linked to from the following overview topics: 3DXI Export Entities, 3DXI Property Containers, 3DXI Helper Objects, 3DXI Generic Objects, 3DXI Materials and Textures.
Detailed Description
Property container.
This class provides an extension mechanism that IGame can use - an Entity is free to use them. The developer can extend the properties that are "known" to IGame can be extended this way the property can be retrieved directly by the developer. As it is "known" to the developer the property type is also known and can be accessed directly
#include <IGameProperty.h>
Public Member Functions |
|
| virtual | ~IPropertyContainer () |
| Destructor. |
|
| virtual IGameProperty * | QueryProperty (DWORD PropID) |
| User Defined Property Access. |
|
| virtual int | GetNumberOfProperties () |
| The number of Properties for the Entity.
|
|
| virtual IGameProperty * | GetProperty (int index) |
| Direct Property Access. |
|
| virtual IGameProperty * | QueryProperty (const MCHAR *propName) |
| Property Access. |
|
| virtual void | EnumerateProperties (PropertyEnum &Enum)=0 |
| Enumerate the Properties. |
|
Constructor & Destructor Documentation
| virtual ~IPropertyContainer | ( | ) | [inline, virtual] |
Destructor.
{;}
Member Function Documentation
| virtual IGameProperty* QueryProperty | ( | DWORD | PropID | ) | [inline, virtual] |
User Defined Property Access.
Using the unique ID in the IGameProp.xml file, the user defined property can be queried directly
- Parameters:
-
PropID User Property ID used in the IGameProp.xml file
- Returns:
- A pointer to IGameProperty if found, NULL otherwise
{return NULL;}
| virtual int GetNumberOfProperties | ( | ) | [inline, virtual] |
The number of Properties for the Entity.
- Returns:
- The number of properties found. The default is 0
{return 0;}
| virtual IGameProperty* GetProperty | ( | int | index | ) | [inline, virtual] |
Direct Property Access.
The property can be accessed directly from the index provided by GetNumberOfProperties(). It will return NULL for "hidden" paramameters names (defined as empty string in paramblocks)
- Parameters:
-
index The index of the property to return
- Returns:
- A pointer to the IGameProperty. The default is NULL
{return NULL;}
| virtual IGameProperty* QueryProperty | ( | const MCHAR * | propName | ) | [inline, virtual] |
Property Access.
Using the name, the property can be queried directly
- Parameters:
-
propName Property name as defined in MAXScript or User Property name
- Returns:
- A pointer to IGameProperty if found. The default is NULL
{return NULL;}
| virtual void EnumerateProperties | ( | PropertyEnum & | Enum | ) | [pure virtual] |
Enumerate the Properties.
All properties can be enumerated by using this method. A user defined callback is used to provide access to the properties.
- Parameters:
-
&Enum The callback object to use.
