iScriptObject Struct Reference

Inheritance diagram for iScriptObject:

Detailed Description

Script object reference interface.

Public Member Functions
virtual iScriptVM *	GetVM () const =0
	Parent script VM. {Property}. More...
virtual eScriptObjectType	GetType () const =0
	Get the script object's type. {Property}. More...
virtual iScriptObject *	Clone (tBool abHoldRef) const =0
	Clone the object reference. More...
virtual tScriptObjectPtrCVec *	EnumObjects () const =0
	Enumerate all objects in this table. More...
Public Member Functions inherited from iUnknown
virtual tBool	IsOK () const =0
	Check if the object is valid. More...
virtual tI32	AddRef ()=0
	Signal that one more reference of the object has been created. More...
virtual tI32	Release ()=0
	Release a reference of the object. More...
virtual void	DeleteThis ()=0
	Bypass any reference counting and delete this object. More...
virtual void	Invalidate ()=0
	Invalidate the object. More...
virtual iUnknown *	QueryInterface (const tUUID &aIID)=0
	Query an interface. More...
virtual void	ListInterfaces (iMutableCollection *apLst, tU32 anFlags) const =0
	Fill a UUID list containing the UUIDs of the implemented interfaces. More...
virtual tI32	SetNumRefs (tI32 anNumRefs)=0
	Set the reference counter directly. More...
virtual tI32	GetNumRefs () const =0
	Get the number of references to this object. More...

Value getting.
virtual tI32	GetInt () const =0
	Get the integer value. More...
virtual tF64	GetFloat () const =0
	{Property} Get the float value. More...
virtual const achar *	GetString () const =0
	Get the string value. More...
virtual iHString *	GetHString () const =0
	Get the hstring value. More...
virtual iUnknown *	GetIUnknown () const =0
	Get the IUnknown pointer value. More...
virtual iUnknown *	GetIUnknownEx (const tUUID &aIID) const =0
	Get the IUnknown object, will get the interface also from iDispatch table. More...
virtual sVec2f	GetVec2 () const =0
	Get the Vec2 value. {Property}. More...
virtual sVec3f	GetVec3 () const =0
	Get the Vec3 value. {Property}. More...
virtual sVec4f	GetVec4 () const =0
	Get the Vec4 value. {Property}. More...
virtual sMatrixf	GetMatrix () const =0
	Get the Matrix value. {Property}. More...
virtual const tUUID &	GetUUID () const =0
	Get the UUID value. {Property}. More...

Function specific
virtual tU32	GetNumParameters () const =0
	Get the number of parameters of the function. {Property}. More...
virtual tU32	GetNumFreeVars () const =0
	Get the number of free variables of the function. {Property}. More...
virtual tU32	GetNumCallParameters () const =0
	Get the number of parameters of the function minus the number of free variables. More...

Member Function Documentation

virtual iScriptVM* GetVM ( ) const

pure virtual

Parent script VM. {Property}.

virtual eScriptObjectType GetType ( ) const

pure virtual

Get the script object's type. {Property}.

virtual iScriptObject* Clone ( tBool  abHoldRef ) const

pure virtual

Clone the object reference.

virtual tScriptObjectPtrCVec* EnumObjects ( ) const

pure virtual

Enumerate all objects in this table.

virtual tI32 GetInt ( ) const

pure virtual

Get the integer value.

Returns

niMaxI32 if the type of the object is not integer.

virtual tF64 GetFloat ( ) const

pure virtual

{Property} Get the float value.

Returns

niMaxF64 if the type of the object is not float. {Property}

virtual const achar* GetString ( ) const

pure virtual

Get the string value.

Returns

NULL if the type of the object is not string. {Property}

virtual iHString* GetHString ( ) const

pure virtual

Get the hstring value.

Returns

NULL if the type of the object is not string. {Property}

virtual iUnknown* GetIUnknown ( ) const

pure virtual

Get the IUnknown pointer value.

Returns

NULL if the type of the object is not iUnknown.

Remarks

Make sure that the user data is really a IUnknown pointer otherwise the pointer returned will be garbage. {Property}

virtual iUnknown* GetIUnknownEx ( const tUUID &  aIID ) const

pure virtual

Get the IUnknown object, will get the interface also from iDispatch table.

virtual sVec2f GetVec2 ( ) const

pure virtual

Get the Vec2 value. {Property}.

virtual sVec3f GetVec3 ( ) const

pure virtual

Get the Vec3 value. {Property}.

virtual sVec4f GetVec4 ( ) const

pure virtual

Get the Vec4 value. {Property}.

virtual sMatrixf GetMatrix ( ) const

pure virtual

Get the Matrix value. {Property}.

virtual const tUUID& GetUUID ( ) const

pure virtual

Get the UUID value. {Property}.

virtual tU32 GetNumParameters ( ) const

pure virtual

Get the number of parameters of the function. {Property}.

virtual tU32 GetNumFreeVars ( ) const

pure virtual

Get the number of free variables of the function. {Property}.

virtual tU32 GetNumCallParameters ( ) const

pure virtual

Get the number of parameters of the function minus the number of free variables.

Remarks

This is the number of parameters to push on the stack to call the function. {Property}