BZFS API Updates - Revision history

Zehra: merged bz_unload into page

2025-11-30T18:38:56Z

merged bz_unload into page

← Older revision		Revision as of 18:38, 30 November 2025
Line 40:		Line 40:
	# '''Register(bz_eEventType eventType)'''		# '''Register(bz_eEventType eventType)'''

			==bz_Unload==
			===Code Example===
			BZF_PLUGIN_CALL int bz_Unload ( void ) {
			bz_debugMessage(4,"SAMPLE_PLUGIN plugin unloaded");
			return 0;
			}

			===Functions===
			The bz_Unload function is required for all plugins. In this function all debug messages, events, map objects, and slash commands are unregistered. Available functions for this are as follows:
			* [[bz_debugMessage]]
			* [[bz_removeEvent]]
			* [[bz_removeCustomSlashCommand]]
			* [[bz_removeCustomMapObject]]

			===Deprecation===
			All calls to [[bz_Unload]] have been deprecated as of 2.4 and will be replaced with:
			'''virtual void Cleanup() {Flush();}'''

	==bz_removeEvent==		==bz_removeEvent==

Zehra: merged content from Bz removeEvent and Bz registerEvent

2025-11-30T02:56:55Z

merged content from Bz removeEvent and Bz registerEvent

← Older revision		Revision as of 02:56, 30 November 2025
Line 22:		Line 22:
	# '''void SAMPLE_PLUGIN::Init ( const char* config);'''		# '''void SAMPLE_PLUGIN::Init ( const char* config);'''

	~~More information on this function can be found on~~ the ~~[[BZFS_API_2~~.~~4_Upgrade]] page~~.		==bz_registerEvent==
			{{apicall
			\| name = bz_registerEvent
			\| returns = Whether or not the event was registered successfully.
			\| returntype = bool
			\| description = Registers a new event handler. This event handler will receive events of the event type specified.
			\| param1 = eventType
			\| param1type = bz_eEventType
			\| param1desc = The type of event to listen for
			\| param2 = eventHandler
			\| param2type = bz_EventHandler*
			\| param2desc = The listener that will be called when events of the specified type occur
			}}

			===Deprecation===
			All calls to [[bz_registerEvent]] have been deprecated as of 2.4 and will be replaced with:
			# '''Register(bz_eEventType eventType)'''


			==bz_removeEvent==
			{{apicall
			\| name = bz_removeEvent
			\| returns = Whether or not the event was removed successfully.
			\| returntype = bool
			\| description = Removes the specified event listener. The event listener must previously have been added by a call to [[bz_registerEvent]].
			\| param1 = eventType
			\| param1type = bz_eEventType
			\| param1desc = The type of event that this listener was previously registered to handle. This is so that if this listener is registered for multiple event types, only one of those will be removed.
			\| param2 = listener
			\| param2type = bz_EventHandler*
			\| param2desc = The listener to remove.
			}}

			===Deprecation===
			All calls to [[bz_removeEvent]] in the [[bz_Unload]] have been deprecated as of 2.4 and will be replaced with:
			# '''Flush();'''

Zehra: merged content from Bz Load

2025-11-30T02:51:44Z

merged content from Bz Load

← Older revision		Revision as of 02:51, 30 November 2025
Line 4:		Line 4:

	=2.0.x=		=2.0.x=
			==bz_Load==
			===Code Example===
			BZF_PLUGIN_CALL int bz_Load ( const char* /commandLine/ ) {
			bz_debugMessage(4,"SAMPLE_PLUGIN plugin loaded");
			return 0;
			}

			===Functions===
			The [[bz_Load]] function is required for all plugins. In this function all debug messages, events, map objects, and slash commands are registered. Available functions for this are as follows:
			* [[bz_debugMessage]]
			* [[bz_registerEvent]]
			* [[bz_registerCustomMapObject]]
			* [[bz_registerCustomSlashCommand]]

			===Deprecation===
			All calls to [[bz_Load]] have been deprecated as of 2.4 and will be replaced with:
			# '''void SAMPLE_PLUGIN::Init ( const char* config);'''

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

Zehra: basic merge and start of page

2025-11-24T01:42:06Z

basic merge and start of page

@@ Line 1: / Line 1: @@
 ===Code Example===
    void SAMPLE_PLUGIN::Init ( const char* /*commandLine*/ ) {
@@ Line 6: / Line 18: @@
 ===Functions===
-The [[Init]] function is required for all plugins 2.4 and higher. This function replaces the [[bz_Load]] function. In this function all debug messages, events, map objects, and slash commands are registered. Available functions for this are as follows:
+The '''Init''' function is required for all plugins 2.4 and higher. This function replaces the [[bz_Load]] function. In this function all debug messages, events, map objects, and slash commands are registered. Available functions for this are as follows:
 * [[bz_debugMessage]]
 * [[Register]]
@@ Line 12: / Line 24: @@
 * [[bz_registerCustomSlashCommand]]
-More information on this function can be found on the [[BZFS_API_2.4_Upgrade]] page.
+==Register==

Zehra: Zehra moved page Init to BZFS API Updates: API changes and updates can be more easily tracked

2025-11-24T00:57:02Z

Zehra moved page Init to BZFS API Updates: API changes and updates can be more easily tracked

← Older revision		Revision as of 00:57, 24 November 2025
(No difference)

Allejo: Added some information on the new plugin loading for 2.4

2011-07-10T19:35:19Z

Added some information on the new plugin loading for 2.4

New page

===Code Example===
void SAMPLE_PLUGIN::Init ( const char* /*commandLine*/ ) {
bz_debugMessage(4,"SAMPLE_PLUGIN plugin loaded");
return 0;
}

===Functions===
The [[Init]] function is required for all plugins 2.4 and higher. This function replaces the [[bz_Load]] function. In this function all debug messages, events, map objects, and slash commands are registered. Available functions for this are as follows:
* [[bz_debugMessage]]
* [[Register]]
* [[bz_registerCustomMapObject]]
* [[bz_registerCustomSlashCommand]]

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