This wiki is archived and useful information is being migrated to the main bzflag.org website
Editing Bz RegisterCustomFlag
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: Archived wiki
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== | ||
− | + | {| 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== | ==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. | ||
− | == | + | ==Notes== |
− | Requires BZFS 2.1.16 | + | Requires BZFS 2.1.16 or newer. |