Editing Bz RegisterCustomFlag

Jump to: navigation, search

Warning: The database has been locked for maintenance, so you will not be able to save your edits right now. You may wish to copy and paste your text into a text file and save it for later.

The administrator who locked it offered this explanation: Server migration

The edit can be undone. Please check the comparison below to verify that this is what you want to do, and then save the changes below to finish undoing the edit.
Latest revision Your text
Line 5: Line 5:
  
 
==Parameters==
 
==Parameters==
; const char* abbr : The desired flag abbreviation.  Must be unique.  Must be 1 or 2 characters.
+
{| border="1" cellpadding="20" cellspacing="0"
; const char* name : The desired flag name.  Max length 32 characters.
+
  !name
; const char* helpString : The desired help string.  Max length 128 characters.
+
  !type
; [[bz_eShotType]] shotType : The default shot type for the flag.
+
  !value description
; [[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 23: Line 43:
 
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.
 
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==
+
==Notes==
Requires BZFS 2.1.16 (r15952) or newer.
+
Requires BZFS 2.1.16 or newer.

Please note that all contributions to BZFlagWiki may be edited, altered, or removed by other contributors. If you do not want your writing to be edited mercilessly, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource (see BZFlagWiki:Copyrights for details). Do not submit copyrighted work without permission!

To edit this page, please answer the question that appears below (more info):

Cancel | Editing help (opens in new window)

Templates used on this page: