BZFS API 2.4 Upgrade - Revision history

Allejo: grammar.... there -> their

2011-09-28T04:16:55Z

grammar.... there -> their

← Older revision		Revision as of 04:16, 28 September 2011
Line 59:		Line 59:

	==Events==		==Events==
	Every plug-in now has a single callback method for all events that it registers. The functions [[bz_registerEvent]] and [[bz_removeEvent]] have been removed from the API. In ~~there~~ place the [[bz_Plugin]] class now implements its own '''Register''' and '''Remove''' methods.		Every plug-in now has a single callback method for all events that it registers. The functions [[bz_registerEvent]] and [[bz_removeEvent]] have been removed from the API. In their place the [[bz_Plugin]] class now implements its own '''Register''' and '''Remove''' methods.

	These methods only take an event type and do not need a separate handler class, they will always use the '''Event''' method of the calling class.		These methods only take an event type and do not need a separate handler class, they will always use the '''Event''' method of the calling class.

Allejo: grammar... again... it's -> its

2011-09-28T04:16:13Z

grammar... again... it's -> its

← Older revision		Revision as of 04:16, 28 September 2011
Line 59:		Line 59:

	==Events==		==Events==
	Every plug-in now has a single callback method for all events that it registers. The functions [[bz_registerEvent]] and [[bz_removeEvent]] have been removed from the API. In there place the [[bz_Plugin]] class now implements ~~it's~~ own '''Register''' and '''Remove''' methods.		Every plug-in now has a single callback method for all events that it registers. The functions [[bz_registerEvent]] and [[bz_removeEvent]] have been removed from the API. In there place the [[bz_Plugin]] class now implements its own '''Register''' and '''Remove''' methods.

	These methods only take an event type and do not need a separate handler class, they will always use the '''Event''' method of the calling class.		These methods only take an event type and do not need a separate handler class, they will always use the '''Event''' method of the calling class.

Allejo: learn proper grammar. it's -> its

2011-09-28T04:15:30Z

learn proper grammar. it's -> its

← Older revision		Revision as of 04:15, 28 September 2011
Line 17:		Line 17:

	===Player Records===		===Player Records===
	The [[bz_PlayerRecord]] has been replaced with [[bz_BasePlayerRecord]] to allow for future derivation. Some of ~~it's~~ members have been changed, mostly notably the player position information is now part of the '''lastKnownState''' member of type [[bz_PlayerUpdateState]]. This structure contains much more information about the player state.		The [[bz_PlayerRecord]] has been replaced with [[bz_BasePlayerRecord]] to allow for future derivation. Some of its members have been changed, mostly notably the player position information is now part of the '''lastKnownState''' member of type [[bz_PlayerUpdateState]]. This structure contains much more information about the player state.

	==Entry Points==		==Entry Points==

Bullet Catcher: /* Upgrade */ replace bz_PlayerRecord with bz_BasePlayerRecord

2011-08-01T01:32:50Z

Upgrade: replace bz_PlayerRecord with bz_BasePlayerRecord

← Older revision		Revision as of 01:32, 1 August 2011
Line 109:		Line 109:
	* Replace the following.		* Replace the following.
	# '''bzApiString''' with '''bz_ApiString'''		# '''bzApiString''' with '''bz_ApiString'''
	# '''bzAPIIntList''' with '''bz_APIIntList'''		# '''bzAPIIntList''' with '''bz_APIIntList'''
	# '''bzAPIFloatList''' with '''bz_APIFloatList'''		# '''bzAPIFloatList''' with '''bz_APIFloatList'''
	# '''bzAPIStringList''' with '''bz_APIStringList'''		# '''bzAPIStringList''' with '''bz_APIStringList'''
			# '''bz_PlayerRecord''' with '''bz_BasePlayerRecord'''

	* Add '''_V1''' to all event data classes, and adjust calls to members as needed, time to eventTime, etc...		* Add '''_V1''' to all event data classes, and adjust calls to members as needed, time to eventTime, etc...

Thumper: Fix names for 2.0.x register event and remove event methods

2011-07-01T02:30:00Z

Fix names for 2.0.x register event and remove event methods

← Older revision		Revision as of 02:30, 1 July 2011
Line 105:		Line 105:
	* Change the '''handle''' method in any bz_CustomMapObjectInfo to '''MapObject'''		* Change the '''handle''' method in any bz_CustomMapObjectInfo to '''MapObject'''
	* Find the bz_Load callback and replace it with the '''Init''' method from the plug-in class.		* Find the bz_Load callback and replace it with the '''Init''' method from the plug-in class.
	* Replace calls to '''~~bz_registerEventHandler~~''' with calls to '''Register''', and remove the second parameter.		* Replace calls to '''bz_registerEvent''' with calls to '''Register''', and remove the second parameter.
	* If the plug-in used custom slash commands or custom map objects that need to be cleaned up then implement the '''Cleanup''' method for the plug-in class and replace the bz_Unload Callback with it. Calls to '''~~bz_removeEventHandler~~''' can be removed, and the method Flush can be called once for all events. If the plug-in only registers events then the bz_Unload callback can be removed.		* If the plug-in used custom slash commands or custom map objects that need to be cleaned up then implement the '''Cleanup''' method for the plug-in class and replace the bz_Unload Callback with it. Calls to '''bz_removeEvent''' can be removed, and the method Flush can be called once for all events. If the plug-in only registers events then the bz_Unload callback can be removed.
	* Replace the following.		* Replace the following.
	# '''bzApiString''' with '''bz_ApiString'''		# '''bzApiString''' with '''bz_ApiString'''

Thumper: typo fix

2011-07-01T02:19:06Z

typo fix

← Older revision		Revision as of 02:19, 1 July 2011
Line 49:		Line 49:
	'''Init''' is called by BZFS after the plug-in is loaded and serves the same function as the [[bz_Load]] entry point in previous versions.		'''Init''' is called by BZFS after the plug-in is loaded and serves the same function as the [[bz_Load]] entry point in previous versions.

	The derived class may also ~~optional~~ provide versions of these additional methods		The derived class may also optionally provide versions of these additional methods

	virtual void Cleanup() {Flush();}		virtual void Cleanup() {Flush();}

Allejo: typo fix: potion -> position

2011-06-18T08:18:32Z

typo fix: potion -> position

← Older revision		Revision as of 08:18, 18 June 2011
Line 17:		Line 17:

	===Player Records===		===Player Records===
	The [[bz_PlayerRecord]] has been replaced with [[bz_BasePlayerRecord]] to allow for future derivation. Some of it's members have been changed, mostly notably the player ~~potion~~ information is now part of the '''lastKnownState''' member of type [[bz_PlayerUpdateState]]. This structure contains much more information about the player state.		The [[bz_PlayerRecord]] has been replaced with [[bz_BasePlayerRecord]] to allow for future derivation. Some of it's members have been changed, mostly notably the player position information is now part of the '''lastKnownState''' member of type [[bz_PlayerUpdateState]]. This structure contains much more information about the player state.

	==Entry Points==		==Entry Points==

Allejo: clarified purpose of a "NAME"

2011-06-15T22:48:39Z

clarified purpose of a "NAME"

← Older revision		Revision as of 22:48, 15 June 2011
Line 100:		Line 100:
	virtual const char* Name (){return "NAME";}		virtual const char* Name (){return "NAME";}
	virtual void Init ( const char* config);		virtual void Init ( const char* config);
	* Replace the word '''NAME''' with the human readable name for your plug-in		* Replace the word '''NAME''' with the human readable name for your plug-in. This name will appear when a user types '''/listplugins''' while in the game.
	* Remove any global instances of your Plug-in object and replace it with a call to the '''BZ_PLUGIN(n)''' macro. There is no need to instantiate the object, the macro will do it for you.		* Remove any global instances of your Plug-in object and replace it with a call to the '''BZ_PLUGIN(n)''' macro. There is no need to instantiate the object, the macro will do it for you.
	* Change the '''handle''' method in any bz_CustomSlashCommandHandler to '''SlashCommand'''		* Change the '''handle''' method in any bz_CustomSlashCommandHandler to '''SlashCommand'''

Allejo: fixed typo and corrected the name of incorrect function

2011-06-15T22:34:46Z

fixed typo and corrected the name of incorrect function

← Older revision		Revision as of 22:34, 15 June 2011
Line 103:		Line 103:
	* Remove any global instances of your Plug-in object and replace it with a call to the '''BZ_PLUGIN(n)''' macro. There is no need to instantiate the object, the macro will do it for you.		* Remove any global instances of your Plug-in object and replace it with a call to the '''BZ_PLUGIN(n)''' macro. There is no need to instantiate the object, the macro will do it for you.
	* Change the '''handle''' method in any bz_CustomSlashCommandHandler to '''SlashCommand'''		* Change the '''handle''' method in any bz_CustomSlashCommandHandler to '''SlashCommand'''
	* Change the '''handle''' method in any ~~bz_bz_CustomMapObjectInfoto~~ '''MapObject'''		* Change the '''handle''' method in any bz_CustomMapObjectInfo to '''MapObject'''
	* Find the bz_Load callback and replace it with the '''Init''' method from the plug-in class.		* Find the bz_Load callback and replace it with the '''Init''' method from the plug-in class.
	* Replace calls to '''bz_registerEventHandler''' with calls to '''Register''', and remove the second parameter.		* Replace calls to '''bz_registerEventHandler''' with calls to '''Register''', and remove the second parameter.

76.95.144.121: /* Upgrade */

2011-06-14T22:28:48Z

Upgrade

← Older revision		Revision as of 22:28, 14 June 2011
Line 110:		Line 110:
	# '''bzApiString''' with '''bz_ApiString'''		# '''bzApiString''' with '''bz_ApiString'''
	# '''bzAPIIntList''' with '''bz_APIIntList'''		# '''bzAPIIntList''' with '''bz_APIIntList'''
	# '''bzAPIFloatList''' with '''~~bz_bz_APIFloatList~~'''		# '''bzAPIFloatList''' with '''bz_APIFloatList'''
	# '''bzAPIStringList''' with '''~~bz_bz_APIStringList~~'''		# '''bzAPIStringList''' with '''bz_APIStringList'''

	* Add '''_V1''' to all event data classes, and adjust calls to members as needed, time to eventTime, etc...		* Add '''_V1''' to all event data classes, and adjust calls to members as needed, time to eventTime, etc...