The interface for a script function description.
| virtual const char* asIScriptFunction::GetConfigGroup |
( |
| ) |
const |
|
pure virtual |
- Returns
- The name of the config group, or null if not in any group.
| virtual const char* asIScriptFunction::GetDeclaration |
( |
bool |
includeObjectName = true | ) |
const |
|
pure virtual |
- Parameters
-
| [in] | includeObjectName | Indicate whether the object name should be prepended to the function name |
- Returns
- A null terminated string with the function declaration.
- Returns
- A pointer to the engine.
| virtual const char* asIScriptFunction::GetModuleName |
( |
| ) |
const |
|
pure virtual |
- Returns
- A null terminated string with the module name.
| virtual const char* asIScriptFunction::GetName |
( |
| ) |
const |
|
pure virtual |
- Returns
- A null terminated string with the name of the function.
| virtual const char* asIScriptFunction::GetObjectName |
( |
| ) |
const |
|
pure virtual |
- Returns
- A null terminated string with the name of the object type if this a method.
| virtual asIObjectType* asIScriptFunction::GetObjectType |
( |
| ) |
const |
|
pure virtual |
- Returns
- A pointer to the object type interface if this is a method.
| virtual int asIScriptFunction::GetParamCount |
( |
| ) |
const |
|
pure virtual |
- Returns
- The number of parameters.
| virtual int asIScriptFunction::GetParamTypeId |
( |
int |
index, |
|
|
asDWORD * |
flags = 0 |
|
) |
| const |
|
pure virtual |
- Parameters
-
| [in] | index | The zero based parameter index. |
| [out] | flags | A combination of asETypeModifiers. |
- Returns
- A negative value on error, or the type id of the specified parameter.
- Return values
-
| asINVALID_ARG | The index is out of bounds. |
| virtual int asIScriptFunction::GetReturnTypeId |
( |
| ) |
const |
|
pure virtual |
- Returns
- The type id of the return type.
| virtual const char* asIScriptFunction::GetScriptSectionName |
( |
| ) |
const |
|
pure virtual |
- Returns
- A null terminated string with the script section name where the function was implemented.
| virtual bool asIScriptFunction::IsClassMethod |
( |
| ) |
const |
|
pure virtual |
- Returns
- True if this a class method.
| virtual bool asIScriptFunction::IsInterfaceMethod |
( |
| ) |
const |
|
pure virtual |
- Returns
- True if this is an interface method.
