You.i Engine
CYIScriptableObject Class Reference

Detailed Description

The base class for an object accessible from script source code.

Any class that is intended to be bound and accessible from script source code must subclass from this class. This class provides a reference to the binding implementation associated with the scriptable object which is required when a C++ object is requested in script source code.

Subclassing from CYIScriptableObject does not on its own make the object accesible from script source code. One must also write an interface definition language (IDL) file describing the class which is being generated and use the binding generation tools provided in the SDK package.

See Binding overview documentation for more details on creating custom bindings.

#include <binding/YiScriptableObject.h>

Inheritance diagram for CYIScriptableObject:

Public Member Functions

 CYIScriptableObject ()
 
 CYIScriptableObject (const CYIScriptableObject &other)
 
CYIScriptableObjectoperator= (const CYIScriptableObject &other)
 
virtual ~CYIScriptableObject ()
 
CYIBindingImplementationGetBindingImplementation () const
 
void SetBindingImplementation (CYIBindingImplementation *pBindingImplementation)
 
virtual const CYIRuntimeTypeInfoGetRuntimeTypeInfoForScriptObject () const
 

Constructor & Destructor Documentation

CYIScriptableObject::CYIScriptableObject ( )
CYIScriptableObject::CYIScriptableObject ( const CYIScriptableObject other)
virtual CYIScriptableObject::~CYIScriptableObject ( )
virtual

Member Function Documentation

CYIBindingImplementation* CYIScriptableObject::GetBindingImplementation ( ) const

Returns the binding implementation associated with this scriptable object.

virtual const CYIRuntimeTypeInfo* CYIScriptableObject::GetRuntimeTypeInfoForScriptObject ( ) const
virtual

Returns the CYIRunTimeTypeInfo for this scriptable object. Returns null if the object doesn't have RTTI information.

Reimplemented in CYIScriptableRTTIObject.

CYIScriptableObject& CYIScriptableObject::operator= ( const CYIScriptableObject other)
void CYIScriptableObject::SetBindingImplementation ( CYIBindingImplementation pBindingImplementation)

Sets the binding implementation which is associated with this scriptable object.


The documentation for this class was generated from the following file: