The interface for an instance of a script object.
virtual int asIScriptObject::AddRef |
( |
| ) |
const |
|
pure virtual |
- Returns
- The number of references to this object.
Call this method when storing an additional reference to the object.
- Parameters
-
[in] | other | A pointer to the source object. |
- Returns
- A negative value on error.
- Return values
-
asINVALID_ARG | The argument is null. |
asINVALID_TYPE | The other object is of different type. |
This method copies the contents of the other object to this one.
virtual void* asIScriptObject::GetAddressOfProperty |
( |
asUINT |
prop | ) |
|
|
pure virtual |
- Parameters
-
[in] | prop | The property index. |
- Returns
- A pointer to the property value.
The method returns a pointer to the memory location for the property. Use the type id for the property to determine the content of the pointer, and how to handle it.
- Returns
- The script engine.
- Returns
- The object type interface of the script object.
This does not increase the reference count of the returned object type.
virtual asUINT asIScriptObject::GetPropertyCount |
( |
| ) |
const |
|
pure virtual |
- Returns
- The number of member properties of the script object.
virtual const char* asIScriptObject::GetPropertyName |
( |
asUINT |
prop | ) |
const |
|
pure virtual |
- Parameters
-
[in] | prop | The property index. |
- Returns
- A null terminated string with the property name.
virtual int asIScriptObject::GetPropertyTypeId |
( |
asUINT |
prop | ) |
const |
|
pure virtual |
- Parameters
-
[in] | prop | The property index. |
- Returns
- The type id of the member property, or a negative value on error.
- Return values
-
asINVALID_ARG | prop is too large |
virtual int asIScriptObject::GetTypeId |
( |
| ) |
const |
|
pure virtual |
- Returns
- The type id of the script object.
virtual int asIScriptObject::Release |
( |
| ) |
const |
|
pure virtual |
- Returns
- The number of references to this object.
Call this method when you will no longer use the references that you own.
The documentation for this class was generated from the following file: