Editing Template:Apicall/doc

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 1: Line 1:
 
This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.
 
This template can be used for bzfs api call documentation pages. It contains fields for the parameters of the api call, it's return type (if any), a description for it, and some other api calls that can be referenced. The template supports up to 10 api call parameters, although support for more can be added by editing this template.
 
The template also includes a link at the bottom to the list of api functions, unless the parameter nopagelink is present (with any value). For simplicity, nopagelink has been set on all of the templates in this document, except for the last one.
 
  
 
To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:
 
To use the template, you must include at least a name parameter, and preferably a description. For example, a call that takes no arguments and returns nothing, and that doesn't have a desctiption, could be declared like this:
  
 
<pre>{{apicall
 
<pre>{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall()
| nopagelink      =
+
 
}}</pre>
 
}}</pre>
  
Line 13: Line 10:
  
  
{{apicall
+
:{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall()
| nopagelink      =
+
 
}}
 
}}
 +
 +
 
If we wanted a description for our call, we could do something like this:
 
If we wanted a description for our call, we could do something like this:
  
 
<pre>{{apicall
 
<pre>{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall()
 
| description      = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
 
| description      = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink      =
 
 
}}</pre>
 
}}</pre>
  
Line 28: Line 25:
  
  
{{apicall
+
:{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall()
 
| description      = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
 
| description      = This is the description for the function. This particular function doesn't really do anything. The text of this function's description is intentionally long, so that you can see that, when it line-wraps, the text is still indented.
| nopagelink      =
 
}}
 
Now let's say that our function takes some parameters. We can add those like this:
 
 
<pre>{{apicall
 
| name            = bz_testApiCall
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1type      = int
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param2          = theSecondParameter
 
| param2type      = int
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| nopagelink      =
 
}}</pre>
 
 
This would result in the following:
 
 
 
{{apicall
 
| name            = bz_testApiCall
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1type      = int
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param2          = theSecondParameter
 
| param2type      = int
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| nopagelink      =
 
}}
 
We can also add documentation on the function's return value. This can be done like this:
 
 
<pre>{{apicall
 
| name            = bz_testApiCall
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1type      = int
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param2          = theSecondParameter
 
| param2type      = int
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| returntype      = bz_APIString
 
| returns          = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
 
}}</pre>
 
 
Which results in this:
 
 
 
{{apicall
 
| name            = bz_testApiCall
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1type      = int
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param2          = theSecondParameter
 
| param2type      = int
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| returntype      = bz_APIString
 
| returns          = A string that means absolutely nothing. It might contain lang (depending on who implements the actual function), so make sure to censor it before using it anywhere.
 
 
}}
 
}}

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)