Bz RegisterCustomFlag - Revision history

Zehra: redirect, since functions are in official docs

2025-11-10T00:11:02Z

redirect, since functions are in official docs

← Older revision		Revision as of 00:11, 10 November 2025
Line 1:		Line 1:
	~~{{BZFS_API_Doc}}~~		#REDIRECT [[Category:BZFS API Docs]]
	~~{{BZFS_API_Funcs}}~~
	~~==Prototype==~~
	~~BZF_API bool bz_RegisterCustomFlag ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );~~

	~~==Parameters==~~
	~~; const char* abbr : The desired flag abbreviation. Must be unique. Must be 1 or 2 characters.~~
	~~; const char* name : The desired flag name. Max length 32 characters.~~
	~~; const char* helpString : The desired help string. Max length 128 characters.~~
	; [[~~bz_eShotType]] shotType~~ : ~~The default shot type for the flag.~~
	~~; [[bz_eFlagQuality]] quality : The flag's quality (good/bad).~~

	~~==Description==~~
	~~This function registers a custom flag. The registered abbreviation must be unique (that is, may not conflict with existing built-in or~~ API ~~flags).~~

	The registered flag will have no functionality by default (i.e. it will behave like Useless), but it can be used by your plugin by examining player records to see if they hold the flag, and taking appropriate action.

	The flag's "stickiness" will be determined by quality; this is roughly consistent with BZFlag's builtin flags. Good flags will be Unstable (that is, when dropped they will disappear and be respawned); bad flags will be Sticky (that is, undroppable).

	~~==Usage==~~
	If you wish to use a custom flag with +/-f or -sl server parameters (including +f good and -f bad), or in flag zones on the map, you must register the flag during init via -loadplugin (or before a call to [[bz_restart]]~~, if using it in a map).~~

	If a plugin registers a flag while there are clients connected, they will automatically receive the update. However, be aware that there is ''no'' corresponding bz_UnregisterCustomFlag function, so there is a limit to the dynamic capability of this functionality.

	~~==Version==~~
	~~Requires BZFS 2.1.16 (r15952) or newer.~~

Rob5a: typo

2012-10-03T15:28:32Z

typo

← Older revision		Revision as of 15:28, 3 October 2012
Line 21:		Line 21:
	If you wish to use a custom flag with +/-f or -sl server parameters (including +f good and -f bad), or in flag zones on the map, you must register the flag during init via -loadplugin (or before a call to [[bz_restart]], if using it in a map).		If you wish to use a custom flag with +/-f or -sl server parameters (including +f good and -f bad), or in flag zones on the map, you must register the flag during init via -loadplugin (or before a call to [[bz_restart]], if using it in a map).

	If a plugin registers a flag while there are clients connected, they will automatically ~~recieve~~ the update. However, be aware that there is ''no'' corresponding bz_UnregisterCustomFlag function, so there is a limit to the dynamic capability of this functionality.		If a plugin registers a flag while there are clients connected, they will automatically receive the update. However, be aware that there is ''no'' corresponding bz_UnregisterCustomFlag function, so there is a limit to the dynamic capability of this functionality.

	==Version==		==Version==
	Requires BZFS 2.1.16 (r15952) or newer.		Requires BZFS 2.1.16 (r15952) or newer.

AAA: wikify

2008-05-25T21:09:52Z

wikify

← Older revision		Revision as of 21:09, 25 May 2008
Line 5:		Line 5:

	==Parameters==		==Parameters==
	~~{\| border="1" cellpadding="20" cellspacing="0"~~		; const char* abbr : The desired flag abbreviation. Must be unique. Must be 1 or 2 characters.
	~~!name~~		; const char* name : The desired flag name. Max length 32 characters.
	~~!type~~		; const char* helpString : The desired help string. Max length 128 characters.
	~~!value description~~		; [[bz_eShotType]] shotType : The default shot type for the flag.
	\|-		; [[bz_eFlagQuality]] quality : The flag's quality (good/bad).
	~~\|abbr~~
	\|const char*
	\|The desired flag abbreviation. Must be unique. Must be 1 or 2 characters.
	\|-
	~~\|name~~
	\|const char*
	\|The desired flag name. Max length 32 characters.
	\|-
	~~\|helpString~~
	\|const char*
	\|The desired help string. Max length 128 characters.
	\|-
	\|shotType
	~~\|bz_eShotType~~
	\|The default shot type for the flag.
	\|-
	\|quality
	~~\|bz_eFlagQuality~~
	\|The flag's quality (good/bad).
	\|}

	==Description==		==Description==
Line 43:		Line 23:
	If a plugin registers a flag while there are clients connected, they will automatically recieve the update. However, be aware that there is ''no'' corresponding bz_UnregisterCustomFlag function, so there is a limit to the dynamic capability of this functionality.		If a plugin registers a flag while there are clients connected, they will automatically recieve the update. However, be aware that there is ''no'' corresponding bz_UnregisterCustomFlag function, so there is a limit to the dynamic capability of this functionality.

	==~~Notes~~==		==Version==
	Requires BZFS 2.1.16 or newer.		Requires BZFS 2.1.16 (r15952) or newer.

DTRemenak: doc registercustomflag

2007-09-25T22:46:05Z

doc registercustomflag

New page

{{BZFS_API_Doc}}
{{BZFS_API_Funcs}}
==Prototype==
BZF_API bool bz_RegisterCustomFlag ( const char* abbr, const char* name, const char* helpString, bz_eShotType shotType, bz_eFlagQuality quality );

==Parameters==
{| border="1" cellpadding="20" cellspacing="0"
!name
!type
!value description
|-
|abbr
|const char*
|The desired flag abbreviation. Must be unique. Must be 1 or 2 characters.
|-
|name
|const char*
|The desired flag name. Max length 32 characters.
|-
|helpString
|const char*
|The desired help string. Max length 128 characters.
|-
|shotType
|bz_eShotType
|The default shot type for the flag.
|-
|quality
|bz_eFlagQuality
|The flag's quality (good/bad).
|}

==Description==
This function registers a custom flag. The registered abbreviation must be unique (that is, may not conflict with existing built-in or API flags).

The registered flag will have no functionality by default (i.e. it will behave like Useless), but it can be used by your plugin by examining player records to see if they hold the flag, and taking appropriate action.

The flag's "stickiness" will be determined by quality; this is roughly consistent with BZFlag's builtin flags. Good flags will be Unstable (that is, when dropped they will disappear and be respawned); bad flags will be Sticky (that is, undroppable).

==Usage==
If you wish to use a custom flag with +/-f or -sl server parameters (including +f good and -f bad), or in flag zones on the map, you must register the flag during init via -loadplugin (or before a call to [[bz_restart]], if using it in a map).

If a plugin registers a flag while there are clients connected, they will automatically recieve the update. However, be aware that there is ''no'' corresponding bz_UnregisterCustomFlag function, so there is a limit to the dynamic capability of this functionality.

==Notes==
Requires BZFS 2.1.16 or newer.