This wiki is archived and useful information is being migrated to the main bzflag.org website
Difference between revisions of "Bz APIString"
From BZFlagWiki
(New page: {{BZFS_API_Doc}} ==Overview== The bz_ApiString is a text string utility class that is used by the BZFS_API for passing text back to a plug-in from various events and functions. The cl...) |
m (remove Underscore) |
||
| Line 2: | Line 2: | ||
==Overview== | ==Overview== | ||
| − | The bz_ApiString is a text string utility class that is used by the [[ | + | The bz_ApiString is a text string utility class that is used by the [[BZFS API]] for passing text back to a plug-in from various events and functions. The class contains a number of utility methods commonly used by plug-ins. |
==Construction== | ==Construction== | ||
Revision as of 01:03, 10 April 2008
| BZFS API Documentation This page contains part of the BZFS API documentation for use by Plug-ins on the BZFS server. |
Overview
The bz_ApiString is a text string utility class that is used by the BZFS API for passing text back to a plug-in from various events and functions. The class contains a number of utility methods commonly used by plug-ins.
Construction
plug-ins should never create a bz_ApiString, they are only passed back to the plug-in by BZFS.
Assignment
The standard = operator is provided to assign the value in a string, from other strings, std::strings, and const char pointers.
Boolean Operators
The standard == and != operators are provided to assign allow testing of bz_ApiStrings with other bz_ApiStrings, std::strings and const char* pointers.
