EngineExport
Engine/source/console/engineExports.h
Information about an entity exported by the engine API.
Public Friends
class
Protected Attributes
Public Functions
DECLARE_INSCOPE(ReflectionAPI )
const char *
Return the documentation string for this type.
Return the kind of entity being exported.
const char *
Return the name of the export.
Return the scope that contains this export.
Return the fully qualified name of this export starting from the global export scope.
Get the next export in the link chain of the export's associated scope.
Protected Functions
EngineExport(const char * name, EngineExportKind kind, EngineExportScope * scope, const char * docString)
Protected constructor as this is an abstract class.
Private Functions
Special constructor for the global scope instance.
Detailed Description
Information about an entity exported by the engine API.
This is an abstract base class.
Public Friends
Protected Attributes
const char * mDocString
Documentation string.
EngineExportKind mExportKind
Kind of export.
const char * mExportName
Name of the export.
Never NULL but will be an empty string for anonymous exports such as function types.
EngineExportScope * mExportScope
The scope in which this export is defined.
EngineExport * mNextExport
Next export in the link chain of the export's scope.
Public Functions
DECLARE_ABSTRACT_CLASS(EngineExport , StaticEngineObject )
DECLARE_INSCOPE(ReflectionAPI )
getDocString()
Return the documentation string for this type.
getExportKind()
Return the kind of entity being exported.
getExportName()
Return the name of the export.
getExportScope()
Return the scope that contains this export.
All exports except the global scope itself are contained in a scope.
getFullyQualifiedExportName()
Return the fully qualified name of this export starting from the global export scope.
Qualifiers are separated with "::".
getNextExport()
Get the next export in the link chain of the export's associated scope.
Protected Functions
EngineExport(const char * name, EngineExportKind kind, EngineExportScope * scope, const char * docString)
Protected constructor as this is an abstract class.
Parameters:
| name | Export name. |
| kind | Export kind. |
| scope | Scope to export to. |
| docString | Documentation string. |