Visual objects

Collaboration diagram for Visual objects:

Topics
	Mesh object (XOB)

Functions
proto native vobject	GetObject (string name)
	Loads object from data, or gets it from cache. Object must be released when not used.
proto native void	ReleaseObject (vobject object, int flag=0)
proto native int	GetNumAnimFrames (vobject anim)
	Returns number of frames, if the object is animation.
proto string	vtoa (vobject vobj)
	Returns name of visual object.

Detailed Description

Function Documentation

GetNumAnimFrames()

proto native int GetNumAnimFrames

(

vobject

anim

)

Returns number of frames, if the object is animation.

GetObject()

proto native vobject GetObject

(

string

name

)

Loads object from data, or gets it from cache. Object must be released when not used.

ReleaseObject()

proto native void ReleaseObject	(	vobject	object,
		int	flag = 0 )

Release object. When there are not any other references, object is stored into cache and ready to be victed if necessary.

Parameters

object	Object handle
flag	If RF_RELEASE is used, the object is evicted immediatelly, if not used by anyone else

Referenced by Particle::CreateParticleEffect(), and ParticleList::PreloadParticles().

vtoa()

proto string vtoa

(

vobject

vobj

)

Returns name of visual object.