iUIInventoryInfo Struct Reference
Get information about an entity/template that the inventory can use to render the entity in the inventory. More...
#include <tools/uitools/inventory.h>
Inheritance diagram for iUIInventoryInfo:
Public Member Functions | |
| virtual csRef< iString > | GetDescription (iCelEntity *entity)=0 |
| Get the description to show for this entity. | |
| virtual iMeshFactoryWrapper * | GetMeshFactory (iCelEntity *entity)=0 |
| Get a mesh factory which can be used for showing in the inventory. | |
| virtual csRef< iString > | GetName (iCelEntity *entity)=0 |
| Get the name for this entity. | |
| virtual iTextureHandle * | GetTexture (iCelEntity *entity)=0 |
| Get an image which can be used for showing in the inventory. | |
Detailed Description
Get information about an entity/template that the inventory can use to render the entity in the inventory.
Definition at line 36 of file inventory.h.
Member Function Documentation
| virtual csRef<iString> iUIInventoryInfo::GetDescription | ( | iCelEntity * | entity | ) | [pure virtual] |
Get the description to show for this entity.
Can be 0. An inventory implementation can show this description directly in the inventory or it can show it as a tooltip.
| virtual iMeshFactoryWrapper* iUIInventoryInfo::GetMeshFactory | ( | iCelEntity * | entity | ) | [pure virtual] |
Get a mesh factory which can be used for showing in the inventory.
Can be 0.
| virtual csRef<iString> iUIInventoryInfo::GetName | ( | iCelEntity * | entity | ) | [pure virtual] |
Get the name for this entity.
Can be 0.
| virtual iTextureHandle* iUIInventoryInfo::GetTexture | ( | iCelEntity * | entity | ) | [pure virtual] |
Get an image which can be used for showing in the inventory.
This can return 0.
The documentation for this struct was generated from the following file:
- tools/uitools/inventory.h
Generated for CEL: Crystal Entity Layer 2.1 by doxygen 1.6.1