Cleanup - Revision history

Zehra: redirect page, as we're merging content

2025-11-24T01:07:55Z

redirect page, as we're merging content

← Older revision		Revision as of 01:07, 24 November 2025
Line 1:		Line 1:
	~~===Code Example===~~		#REDIRECT [[BZFS API Updates]]
	~~void SAMPLE_PLUGIN::Cleanup( void ) {~~
	~~Flush(); //This removes all events that were registered with Registered()~~
	~~bz_debugMessage(4,"SAMPLE_PLUGIN plugin unloaded");~~
	~~return 0;~~
	}

	~~===Functions===~~
	~~The~~ [[~~Cleanup~~]] function is required for all plugins. This function replaces the [[bz_Unload]] function in plugins written for 2.4 or higher. In this function all debug messages, events, map objects, and slash commands are unregistered. Available functions for this are as follows:
	* [[bz_debugMessage]]
	* Flush()
	* [[bz_removeCustomSlashCommand]]
	* [[bz_removeCustomMapObject]]

	~~The Flush() function is called once in 2.4 plugins instead of having to a [[bz_removeEvent]] remove each registered event individually.~~

	~~More information on this function can be found on the [[BZFS_API_2.4_Upgrade]] page.~~

Allejo: fixed typo

2011-07-10T19:42:17Z

fixed typo

← Older revision		Revision as of 19:42, 10 July 2011
Line 9:		Line 9:
	The [[Cleanup]] function is required for all plugins. This function replaces the [[bz_Unload]] function in plugins written for 2.4 or higher. In this function all debug messages, events, map objects, and slash commands are unregistered. Available functions for this are as follows:		The [[Cleanup]] function is required for all plugins. This function replaces the [[bz_Unload]] function in plugins written for 2.4 or higher. In this function all debug messages, events, map objects, and slash commands are unregistered. Available functions for this are as follows:
	* [[bz_debugMessage]]		* [[bz_debugMessage]]
	* Flush		* Flush()
	* [[bz_removeCustomSlashCommand]]		* [[bz_removeCustomSlashCommand]]
	* [[bz_removeCustomMapObject]]		* [[bz_removeCustomMapObject]]

Allejo: add info about Flush()

2011-07-10T19:41:52Z

add info about Flush()

← Older revision		Revision as of 19:41, 10 July 2011
Line 9:		Line 9:
	The [[Cleanup]] function is required for all plugins. This function replaces the [[bz_Unload]] function in plugins written for 2.4 or higher. In this function all debug messages, events, map objects, and slash commands are unregistered. Available functions for this are as follows:		The [[Cleanup]] function is required for all plugins. This function replaces the [[bz_Unload]] function in plugins written for 2.4 or higher. In this function all debug messages, events, map objects, and slash commands are unregistered. Available functions for this are as follows:
	* [[bz_debugMessage]]		* [[bz_debugMessage]]
	* [[Flush]]		* Flush
	* [[bz_removeCustomSlashCommand]]		* [[bz_removeCustomSlashCommand]]
	* [[bz_removeCustomMapObject]]		* [[bz_removeCustomMapObject]]

			The Flush() function is called once in 2.4 plugins instead of having to a [[bz_removeEvent]] remove each registered event individually.

	More information on this function can be found on the [[BZFS_API_2.4_Upgrade]] page.		More information on this function can be found on the [[BZFS_API_2.4_Upgrade]] page.

Allejo: added some info on how the unloading part of a plugin works for 2.4

2011-07-10T19:39:15Z

added some info on how the unloading part of a plugin works for 2.4

New page

===Code Example===
void SAMPLE_PLUGIN::Cleanup( void ) {
Flush(); //This removes all events that were registered with Registered()
bz_debugMessage(4,"SAMPLE_PLUGIN plugin unloaded");
return 0;
}

===Functions===
The [[Cleanup]] function is required for all plugins. This function replaces the [[bz_Unload]] function in plugins written for 2.4 or higher. In this function all debug messages, events, map objects, and slash commands are unregistered. Available functions for this are as follows:
* [[bz_debugMessage]]
* [[Flush]]
* [[bz_removeCustomSlashCommand]]
* [[bz_removeCustomMapObject]]

More information on this function can be found on the [[BZFS_API_2.4_Upgrade]] page.