asIScriptStruct Class Reference
[Interfaces]
The interface for a script class or interface.
List of all members.
Member Function Documentation
virtual int asIScriptStruct::AddRef |
( |
|
) |
[pure virtual] |
- Returns:
- The number of references to this object.
Call this method when storing an additional reference to the object.
virtual int asIScriptStruct::Release |
( |
|
) |
[pure virtual] |
- Returns:
- The number of references to this object.
Call this method when you will no longer use the references that you own.
virtual int asIScriptStruct::GetStructTypeId |
( |
|
) |
[pure virtual] |
- Returns:
- The type id of the script object.
virtual asIObjectType* asIScriptStruct::GetObjectType |
( |
|
) |
[pure virtual] |
- Returns:
- The object type interface of the script object.
virtual int asIScriptStruct::GetPropertyCount |
( |
|
) |
[pure virtual] |
- Returns:
- The number of member properties of the script object.
virtual int asIScriptStruct::GetPropertyTypeId |
( |
asUINT |
prop |
) |
[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 const char* asIScriptStruct::GetPropertyName |
( |
asUINT |
prop |
) |
[pure virtual] |
- Parameters:
-
[in] | prop | The property index. |
- Returns:
- A null terminated string with the property name.
virtual void* asIScriptStruct::GetPropertyPointer |
( |
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.
virtual int asIScriptStruct::CopyFrom |
( |
asIScriptStruct * |
other |
) |
[pure virtual] |
- 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.