RenderWare Plugin System - Revision history

EOFIK at 22:20, 2 June 2022

2022-06-02T22:20:22Z

← Older revision		Revision as of 22:20, 2 June 2022
Line 89:		Line 89:
	[[category:GTA Games]]		[[category:GTA Games]]

	~~[[en:RenderWare Plugin System]]~~
	[[ru:RenderWare Plugin System]]		[[ru:RenderWare Plugin System]]

EOFIK: Добавление новых языков

2021-06-14T19:14:03Z

Добавление новых языков

← Older revision		Revision as of 19:14, 14 June 2021
Line 88:		Line 88:

	[[category:GTA Games]]		[[category:GTA Games]]

			[[en:RenderWare Plugin System]]
			[[ru:RenderWare Plugin System]]

EOFIK: Форматирование

2021-06-14T19:13:13Z

Форматирование

EOFIK: Форматирование

2021-06-14T19:02:08Z

Форматирование

← Older revision		Revision as of 19:02, 14 June 2021
Line 52:		Line 52:
	===RwObjectRegisterPluginStream===		===RwObjectRegisterPluginStream===
	size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback,		size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback,
	RwPluginStreamGetSize sizeCallback );		RwPluginStreamGetSize sizeCallback );
	* '''uiPluginID''' - id of the plugin struct (to find it in the registry)		* '''uiPluginID''' - id of the plugin struct (to find it in the registry)
	* '''readCallback''' - issued once a plugin struct is found by id in the RwStream		* '''readCallback''' - issued once a plugin struct is found by id in the RwStream
Line 58:		Line 58:
	* '''sizeCallback''' - called to return the size of the plugin struct in the stream (for allocation purposes)		* '''sizeCallback''' - called to return the size of the plugin struct in the stream (for allocation purposes)
	The plugin struct offset is returned if successfully registered. Otherwise the function returns 0 (which is always an invalid offset). The registration will fail if the plugin struct has not been registered previously. Therefor call RwObjectRegisterPlugin before RwObjectRegisterPluginStream!		The plugin struct offset is returned if successfully registered. Otherwise the function returns 0 (which is always an invalid offset). The registration will fail if the plugin struct has not been registered previously. Therefor call RwObjectRegisterPlugin before RwObjectRegisterPluginStream!

	===Callback types (templates)===		===Callback types (templates)===
	====RwPluginStreamRead====		====RwPluginStreamRead====

Fabervox at 12:22, 20 September 2014

2014-09-20T12:22:20Z

← Older revision		Revision as of 12:22, 20 September 2014
Line 20:		Line 20:
	Each plugin object (that is one of the above RenderWare types) offers a '''plugin registration routine'''. It registers plugin struct details into the '''plugin container'''. It is defined as follows...		Each plugin object (that is one of the above RenderWare types) offers a '''plugin registration routine'''. It registers plugin struct details into the '''plugin container'''. It is defined as follows...
	===RwObjectRegisterPlugin===		===RwObjectRegisterPlugin===
	size_t RwObjectRegisterPlugin( size_t sPluginSize, unsigned int uiPluginID, RwPluginConstructor constructor, RwPluginDestructor destructor, RwPluginCopyConstructor copyConstructor = NULL );		size_t RwObjectRegisterPlugin( size_t sPluginSize, unsigned int uiPluginID, RwPluginConstructor constructor,
			RwPluginDestructor destructor, RwPluginCopyConstructor copyConstructor = NULL );
	* '''sPluginSize''' - size of the plugin struct which is to be registered at the plugin object		* '''sPluginSize''' - size of the plugin struct which is to be registered at the plugin object
	* '''uiPluginID''' - unique ID of the plugin so it can be recognized by the system (e.g. in streams)		* '''uiPluginID''' - unique ID of the plugin so it can be recognized by the system (e.g. in streams)
Line 50:		Line 51:
	Plugin structs may offer a stream representation. Once sections designated by the struct id are found in a RwStream, the '''read callback''' is issued. If a RenderWare type is written to disk, all '''write callback'''s are invoked. Plugins do not have to write details to disk. The registration routine is defined as follows...		Plugin structs may offer a stream representation. Once sections designated by the struct id are found in a RwStream, the '''read callback''' is issued. If a RenderWare type is written to disk, all '''write callback'''s are invoked. Plugins do not have to write details to disk. The registration routine is defined as follows...
	===RwObjectRegisterPluginStream===		===RwObjectRegisterPluginStream===
	size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback, RwPluginStreamGetSize sizeCallback );		size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback,
			RwPluginStreamGetSize sizeCallback );
	* '''uiPluginID''' - id of the plugin struct (to find it in the registry)		* '''uiPluginID''' - id of the plugin struct (to find it in the registry)
	* '''readCallback''' - issued once a plugin struct is found by id in the RwStream		* '''readCallback''' - issued once a plugin struct is found by id in the RwStream
Line 84:		Line 86:
	On destruction, all plugin structs are destroyed by calling their destructors in reverse assignment order.		On destruction, all plugin structs are destroyed by calling their destructors in reverse assignment order.

	~~[[category:RenderWare]]~~ [[category:GTA~~:SA~~]]		[[category:GTA Games]]

The GTA: /* Callback types (templates) */

2013-06-10T10:21:51Z

Callback types (templates)

← Older revision		Revision as of 10:21, 10 June 2013
Line 57:		Line 57:
	The plugin struct offset is returned if successfully registered. Otherwise the function returns 0 (which is always an invalid offset). The registration will fail if the plugin struct has not been registered previously. Therefor call RwObjectRegisterPlugin before RwObjectRegisterPluginStream!		The plugin struct offset is returned if successfully registered. Otherwise the function returns 0 (which is always an invalid offset). The registration will fail if the plugin struct has not been registered previously. Therefor call RwObjectRegisterPlugin before RwObjectRegisterPluginStream!
	===Callback types (templates)===		===Callback types (templates)===
			====RwPluginStreamRead====
	template <class objectType>		template <class objectType>
	~~====RwPluginStreamRead====~~
	RwStream* RwPluginStreamRead( RwStream stream, size_t sPluginSize, objectType obj );		RwStream* RwPluginStreamRead( RwStream stream, size_t sPluginSize, objectType obj );
	* '''stream''' - source stream of the plugin object		* '''stream''' - source stream of the plugin object

The GTA at 10:17, 10 June 2013

2013-06-10T10:17:34Z

← Older revision		Revision as of 10:17, 10 June 2013
Line 19:		Line 19:
	==Registration of plugin object extensions==		==Registration of plugin object extensions==
	Each plugin object (that is one of the above RenderWare types) offers a '''plugin registration routine'''. It registers plugin struct details into the '''plugin container'''. It is defined as follows...		Each plugin object (that is one of the above RenderWare types) offers a '''plugin registration routine'''. It registers plugin struct details into the '''plugin container'''. It is defined as follows...
			===RwObjectRegisterPlugin===
	size_t RwObjectRegisterPlugin( size_t sPluginSize, unsigned int uiPluginID, RwPluginConstructor constructor, RwPluginDestructor destructor, RwPluginCopyConstructor copyConstructor = NULL );		size_t RwObjectRegisterPlugin( size_t sPluginSize, unsigned int uiPluginID, RwPluginConstructor constructor, RwPluginDestructor destructor, RwPluginCopyConstructor copyConstructor = NULL );
	~~===Arguments===~~
	* '''sPluginSize''' - size of the plugin struct which is to be registered at the plugin object		* '''sPluginSize''' - size of the plugin struct which is to be registered at the plugin object
	* '''uiPluginID''' - unique ID of the plugin so it can be recognized by the system (e.g. in streams)		* '''uiPluginID''' - unique ID of the plugin so it can be recognized by the system (e.g. in streams)
Line 28:		Line 28:
	The function returns the offset of the registered plugin struct.		The function returns the offset of the registered plugin struct.
	===Callback types (templates)===		===Callback types (templates)===
			====RwPluginConstructor====
	template <class objectType>		template <class objectType>
	objectType* RwPluginConstructor( objectType *obj, size_t sPluginOffset );		objectType* RwPluginConstructor( objectType *obj, size_t sPluginOffset );

			====RwPluginDestructor====
	template <class objectType>		template <class objectType>
	void RwPluginDestructor( objectType *obj, size_t sPluginOffset );		void RwPluginDestructor( objectType *obj, size_t sPluginOffset );
	~~====Arguments====~~
	* '''obj''' - plugin object in question		* '''obj''' - plugin object in question
	* '''sPluginOffset''' - offset of the plugin struct		* '''sPluginOffset''' - offset of the plugin struct
Line 39:		Line 40:
	If the constructor routine returns NULL, the plugin has failed to construct. It is not recommended to do so, since the plugin object will be given to the runtime anyway. On the other hand, the destructor must not fail.		If the constructor routine returns NULL, the plugin has failed to construct. It is not recommended to do so, since the plugin object will be given to the runtime anyway. On the other hand, the destructor must not fail.

			====RwPluginCopyConstructor====
	template <class objectType>		template <class objectType>
	objectType* RwPluginCopyConstructor( objectType objNew, objectType source, size_t sPluginOffset );		objectType* RwPluginCopyConstructor( objectType objNew, objectType source, size_t sPluginOffset );
	~~====Arguments====~~
	* '''objNew''' - the newly created plugin object		* '''objNew''' - the newly created plugin object
	* '''source''' - plugin object to clone data from		* '''source''' - plugin object to clone data from
Line 48:		Line 49:
	==Registration of plugin object stream extensions==		==Registration of plugin object stream extensions==
	Plugin structs may offer a stream representation. Once sections designated by the struct id are found in a RwStream, the '''read callback''' is issued. If a RenderWare type is written to disk, all '''write callback'''s are invoked. Plugins do not have to write details to disk. The registration routine is defined as follows...		Plugin structs may offer a stream representation. Once sections designated by the struct id are found in a RwStream, the '''read callback''' is issued. If a RenderWare type is written to disk, all '''write callback'''s are invoked. Plugins do not have to write details to disk. The registration routine is defined as follows...
			===RwObjectRegisterPluginStream===
	size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback, RwPluginStreamGetSize sizeCallback );		size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback, RwPluginStreamGetSize sizeCallback );
	~~===Arguments===~~
	* '''uiPluginID''' - id of the plugin struct (to find it in the registry)		* '''uiPluginID''' - id of the plugin struct (to find it in the registry)
	* '''readCallback''' - issued once a plugin struct is found by id in the RwStream		* '''readCallback''' - issued once a plugin struct is found by id in the RwStream
Line 57:		Line 58:
	===Callback types (templates)===		===Callback types (templates)===
	template <class objectType>		template <class objectType>
			====RwPluginStreamRead====
	RwStream* RwPluginStreamRead( RwStream stream, size_t sPluginSize, objectType obj );		RwStream* RwPluginStreamRead( RwStream stream, size_t sPluginSize, objectType obj );
	~~====Arguments====~~
	* '''stream''' - source stream of the plugin object		* '''stream''' - source stream of the plugin object
	* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize)		* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize)
Line 64:		Line 65:
	If this function succeeds, it should return the stream. Otherwise it can return NULL. This means that reading the RenderWare type has failed. The runtime will receive a NULL pointer then.		If this function succeeds, it should return the stream. Otherwise it can return NULL. This means that reading the RenderWare type has failed. The runtime will receive a NULL pointer then.

			====RwPluginStreamWrite====
	template <class objectType>		template <class objectType>
	int RwPluginStreamWrite( RwStream stream, size_t sPluginSize, objectType obj );		int RwPluginStreamWrite( RwStream stream, size_t sPluginSize, objectType obj );
	~~====Arguments====~~
	* '''stream''' - source stream of the plugin object		* '''stream''' - source stream of the plugin object
	* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize)		* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize)
Line 72:		Line 73:
	This callback should return a boolean whether writing succeeded or not.		This callback should return a boolean whether writing succeeded or not.

			====RwPluginStreamGetSize====
	template <class objectType>		template <class objectType>
	size_t RwPluginStreamGetSize( objectType *obj );		size_t RwPluginStreamGetSize( objectType *obj );
	~~====Arguments====~~
	* '''obj''' - plugin object to write to disk		* '''obj''' - plugin object to write to disk
	This callback should return the required size to write to the RwStream. If 0 is returned, no data has to be written to disk (hence no section is created). The return value is passed to the write callback.		This callback should return the required size to write to the RwStream. If 0 is returned, no data has to be written to disk (hence no section is created). The return value is passed to the write callback.

The GTA: /* Registration of plugin object stream extensions */

2013-06-10T10:13:49Z

Registration of plugin object stream extensions

@@ Line 55: / Line 55: @@
 * '''sizeCallback''' - called to return the size of the plugin struct in the stream (for allocation purposes)
 The plugin struct offset is returned if successfully registered. Otherwise the function returns 0 (which is always an invalid offset). The registration will fail if the plugin struct has not been registered previously. Therefor call RwObjectRegisterPlugin before RwObjectRegisterPluginStream!
 ==Lifetime of a RenderWare plugin object==

The GTA: /* Registration of plugin object extensions */

2013-06-10T10:01:27Z

Registration of plugin object extensions

@@ Line 27: / Line 27: @@
 * '''copyConstructor''' (can be NULL) - called upon plugin cloning to recreated properties of the source plugin object in the new one with same properties
 The function returns the offset of the registered plugin struct.
 ==Registration of plugin object stream extensions==
 Plugin structs may offer a stream representation. Once sections designated by the struct id are found in a RwStream, the '''read callback''' is issued. If a RenderWare type is written to disk, all '''write callback'''s are invoked. Plugins do not have to write details to disk. The registration routine is defined as follows...

The GTA: /* Lifetime of a RenderWare plugin object */

2013-06-10T09:19:12Z

Lifetime of a RenderWare plugin object

← Older revision		Revision as of 09:19, 10 June 2013
Line 38:		Line 38:

	==Lifetime of a RenderWare plugin object==		==Lifetime of a RenderWare plugin object==
	Once a plugin object is created, first it is filled with RenderWare data. Then all constructors are called in their assignment order to fill all plugin details. To access plugin details, API has to be created which accesses the plugin struct (which has been registered at said plugin) at the offset it is assigned to. Usually there is a global variable which holds the plugin struct offset that is used in all API. Since the structs are constructed the same way all the time, the plugin struct offset information could be omitted by creating a new definition which maps out the offsets statically at compile-time. Optimal implementations use the plugin struct offset returned by the registration function, so that each registered struct in the plugin is independent from others.		Once a plugin object is created, first it is filled with RenderWare data. Then all constructors are called in their assignment order to fill all plugin details. To access plugin details, API has to be created which accesses the plugin struct (which has been registered at said plugin) at the offset it is assigned to. Usually there is a global variable which holds the plugin struct offset that is used in all API. Since the structs are constructed the same way all the time, the plugin struct offset information could be omitted by creating a new definition which maps out the offsets statically at compile-time. Optimal implementations use the plugin struct offset returned by the registration function, so that each registered struct in the plugin object is independent from others.

	On destruction, all plugin structs are destroyed by calling their destructors in reverse assignment order.		On destruction, all plugin structs are destroyed by calling their destructors in reverse assignment order.

	[[category:RenderWare]] [[category:GTA:SA]]		[[category:RenderWare]] [[category:GTA:SA]]

← Older revision		Revision as of 19:13, 14 June 2021
Line 1:		Line 1:
	The '''RenderWare Plugin System''' is an interface used to extend known RenderWare types. RenderWare structs are allocated in free lists which know the RenderWare struct size at runtime. One free list is created for every type which is to be extended. Management of RenderWare plugins is done through plugin container structs that hold '''constructors''', '''destructors''' and '''copy-constructors''' of their plugin. Plugins can define stream '''read''' and '''write''' algorithms to save their properties to disk.		The '''RenderWare Plugin System''' is an interface used to extend known RenderWare types. RenderWare structs are allocated in free lists which know the RenderWare struct size at runtime. One free list is created for every type which is to be extended. Management of RenderWare plugins is done through plugin container structs that hold '''constructors''', '''destructors''' and '''copy-constructors''' of their plugin. Plugins can define stream '''read''' and '''write''' algorithms to save their properties to disk.
	===Reference===		===Reference===
	* '''plugin struct''' is the data structure which should be registered to the RenderWare type		* '''plugin struct''' is the data structure which should be registered to the RenderWare type;
	* '''plugin object''' is a RenderWare type with plugin support		* '''plugin object''' is a RenderWare type with plugin support;
	* '''plugin container''' is a global descriptor with extension information about the plugin object (such as size, constructors, destructors and stream callbacks)		* '''plugin container''' is a global descriptor with extension information about the plugin object (such as size, constructors, destructors and stream callbacks).
	__TOC__		__TOC__
	==Known RenderWare types with (built-in) plugin support==		==Known RenderWare types with (built-in) plugin support==
	* '''RpAtomic''' - geometry rendering descriptor		* '''RpAtomic''' - geometry rendering descriptor;
	* '''RpClump''' - container of atomics, lights and cameras		* '''RpClump''' - container of atomics, lights and cameras;
	* '''RpGeometry''' - 3D mesh holder		* '''RpGeometry''' - 3D mesh holder;
	* '''RpMaterial''' - rendering material for geometry		* '''RpMaterial''' - rendering material for geometry;
	* '''RpWorld''' - sector manager for RenderWare scenes which handles dynamic lights		* '''RpWorld''' - sector manager for RenderWare scenes which handles dynamic lights;
	* '''RpLight''' - dynamic light descriptor		* '''RpLight''' - dynamic light descriptor;
	* '''RwFrame''' - matrix in 3d space which holds frame objects (atomics, lights, cameras), creates a hierarchy to transform and offset objects		* '''RwFrame''' - matrix in 3d space which holds frame objects (atomics, lights, cameras), creates a hierarchy to transform and offset objects;
	* '''RwCamera''' - viewport into 3d space with rendering properties		* '''RwCamera''' - viewport into 3d space with rendering properties;
	* '''RwRaster''' - gfx texture data		* '''RwRaster''' - gfx texture data;
	* '''RwTexture''' - raster rendering descriptor		* '''RwTexture''' - raster rendering descriptor;
	* '''RwTexDictionary''' - container of textures to look-up by name		* '''RwTexDictionary''' - container of textures to look-up by name.
	==Registration of plugin object extensions==		==Registration of plugin object extensions==
	Each plugin object (that is one of the above RenderWare types) offers a '''plugin registration routine'''. It registers plugin struct details into the '''plugin container'''. It is defined as follows...		Each plugin object (that is one of the above RenderWare types) offers a '''plugin registration routine'''. It registers plugin struct details into the '''plugin container'''. It is defined as follows...
Line 22:		Line 22:
	size_t RwObjectRegisterPlugin( size_t sPluginSize, unsigned int uiPluginID, RwPluginConstructor constructor,		size_t RwObjectRegisterPlugin( size_t sPluginSize, unsigned int uiPluginID, RwPluginConstructor constructor,
	RwPluginDestructor destructor, RwPluginCopyConstructor copyConstructor = NULL );		RwPluginDestructor destructor, RwPluginCopyConstructor copyConstructor = NULL );
	* '''sPluginSize''' - size of the plugin struct which is to be registered at the plugin object		* '''sPluginSize''' - size of the plugin struct which is to be registered at the plugin object;
	* '''uiPluginID''' - unique ID of the plugin so it can be recognized by the system (e.g. in streams)		* '''uiPluginID''' - unique ID of the plugin so it can be recognized by the system (e.g. in streams);
	* '''constructor''' - called upon plugin object construction to set up plugin struct at it's offset		* '''constructor''' - called upon plugin object construction to set up plugin struct at it's offset;
	* '''destructor''' - called upon plugin object destruction to release associated resources		* '''destructor''' - called upon plugin object destruction to release associated resources;
	* '''copyConstructor''' (can be NULL) - called upon plugin cloning to recreated properties of the source plugin object in the new one with same properties		* '''copyConstructor''' (can be NULL) - called upon plugin cloning to recreated properties of the source plugin object in the new one with same properties.
	The function returns the offset of the registered plugin struct.		The function returns the offset of the registered plugin struct.
	===Callback types (templates)===		===Callback types (templates)===
Line 36:		Line 36:
	template <class objectType>		template <class objectType>
	void RwPluginDestructor( objectType *obj, size_t sPluginOffset );		void RwPluginDestructor( objectType *obj, size_t sPluginOffset );
	* '''obj''' - plugin object in question		* '''obj''' - plugin object in question;
	* '''sPluginOffset''' - offset of the plugin struct		* '''sPluginOffset''' - offset of the plugin struct.

	If the constructor routine returns NULL, the plugin has failed to construct. It is not recommended to do so, since the plugin object will be given to the runtime anyway. On the other hand, the destructor must not fail.		If the constructor routine returns NULL, the plugin has failed to construct. It is not recommended to do so, since the plugin object will be given to the runtime anyway. On the other hand, the destructor must not fail.
Line 44:		Line 44:
	template <class objectType>		template <class objectType>
	objectType* RwPluginCopyConstructor( objectType objNew, objectType source, size_t sPluginOffset );		objectType* RwPluginCopyConstructor( objectType objNew, objectType source, size_t sPluginOffset );
	* '''objNew''' - the newly created plugin object		* '''objNew''' - the newly created plugin object;
	* '''source''' - plugin object to clone data from		* '''source''' - plugin object to clone data from;
	* '''sPluginOffset''' - offset of the plugin struct		* '''sPluginOffset''' - offset of the plugin struct.

	==Registration of plugin object stream extensions==		==Registration of plugin object stream extensions==
Line 53:		Line 53:
	size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback,		size_t RwObjectRegisterPluginStream( unsigned int uiPluginID, RwPluginStreamRead readCallback, RwPluginStreamWrite writeCallback,
	RwPluginStreamGetSize sizeCallback );		RwPluginStreamGetSize sizeCallback );
	* '''uiPluginID''' - id of the plugin struct (to find it in the registry)		* '''uiPluginID''' - id of the plugin struct (to find it in the registry);
	* '''readCallback''' - issued once a plugin struct is found by id in the RwStream		* '''readCallback''' - issued once a plugin struct is found by id in the RwStream;
	* '''writeCallback''' - invoked once a plugin object is written to RwStream		* '''writeCallback''' - invoked once a plugin object is written to RwStream;
	* '''sizeCallback''' - called to return the size of the plugin struct in the stream (for allocation purposes)		* '''sizeCallback''' - called to return the size of the plugin struct in the stream (for allocation purposes).
	The plugin struct offset is returned if successfully registered. Otherwise the function returns 0 (which is always an invalid offset). The registration will fail if the plugin struct has not been registered previously. Therefor call RwObjectRegisterPlugin before RwObjectRegisterPluginStream!		The plugin struct offset is returned if successfully registered. Otherwise the function returns 0 (which is always an invalid offset). The registration will fail if the plugin struct has not been registered previously. Therefor call RwObjectRegisterPlugin before RwObjectRegisterPluginStream!

Line 63:		Line 63:
	template <class objectType>		template <class objectType>
	RwStream* RwPluginStreamRead( RwStream stream, size_t sPluginSize, objectType obj );		RwStream* RwPluginStreamRead( RwStream stream, size_t sPluginSize, objectType obj );
	* '''stream''' - source stream of the plugin object		* '''stream''' - source stream of the plugin object;
	* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize)		* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize);
	* '''obj''' - plugin object to write data to		* '''obj''' - plugin object to write data to.
	If this function succeeds, it should return the stream. Otherwise it can return NULL. This means that reading the RenderWare type has failed. The runtime will receive a NULL pointer then.		If this function succeeds, it should return the stream. Otherwise it can return NULL. This means that reading the RenderWare type has failed. The runtime will receive a NULL pointer then.

Line 71:		Line 71:
	template <class objectType>		template <class objectType>
	int RwPluginStreamWrite( RwStream stream, size_t sPluginSize, objectType obj );		int RwPluginStreamWrite( RwStream stream, size_t sPluginSize, objectType obj );
	* '''stream''' - source stream of the plugin object		* '''stream''' - source stream of the plugin object;
	* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize)		* '''sPluginSize''' - size of the plugin object (returned from RwPluginStreamGetSize);
	* '''obj''' - plugin object to write data to		* '''obj''' - plugin object to write data to.
	This callback should return a boolean whether writing succeeded or not.		This callback should return a boolean whether writing succeeded or not.

Line 79:		Line 79:
	template <class objectType>		template <class objectType>
	size_t RwPluginStreamGetSize( objectType *obj );		size_t RwPluginStreamGetSize( objectType *obj );
	* '''obj''' - plugin object to write to disk		* '''obj''' - plugin object to write to disk.
	This callback should return the required size to write to the RwStream. If 0 is returned, no data has to be written to disk (hence no section is created). The return value is passed to the write callback.		This callback should return the required size to write to the RwStream. If 0 is returned, no data has to be written to disk (hence no section is created). The return value is passed to the write callback.