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 6: Line 6:
  
 
<pre>{{apicall
 
<pre>{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall()
 
| nopagelink      =
 
| nopagelink      =
 
}}</pre>
 
}}</pre>
Line 14: Line 14:
  
 
{{apicall
 
{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall()
 
| nopagelink      =
 
| nopagelink      =
 
}}
 
}}
Line 20: Line 20:
  
 
<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      =
 
| nopagelink      =
Line 29: Line 29:
  
 
{{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      =
 
| nopagelink      =
Line 36: Line 36:
  
 
<pre>{{apicall
 
<pre>{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall(int theFirstParameter, int theSecondParameter)
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1          = theFirstParameter
Line 51: Line 51:
  
 
{{apicall
 
{{apicall
| name            = bz_testApiCall
+
| name            = bz_testApiCall(int theFirstParameter, int theSecondParameter)
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1          = theFirstParameter
| param1type      = int
 
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param2          = theSecondParameter
 
| param2          = theSecondParameter
| param2type      = int
 
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| nopagelink      =
 
| nopagelink      =
Line 64: Line 62:
  
 
<pre>{{apicall
 
<pre>{{apicall
| name            = bz_testApiCall
+
| name            = int bz_testApiCall(int theFirstParameter, int theSecondParameter)
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1          = theFirstParameter
| param1type      = int
 
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param2          = theSecondParameter
 
| param2          = theSecondParameter
| param2type      = int
 
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype      = bz_APIString
+
| returns          = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
| 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>
 
}}</pre>
  
Line 80: Line 75:
  
 
{{apicall
 
{{apicall
| name            = bz_testApiCall
+
| name            = int bz_testApiCall(int theFirstParameter, int theSecondParameter)
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| description      = This function does nothing, except that it accepts two numbers as inputs.
 
| param1          = theFirstParameter
 
| param1          = theFirstParameter
| param1type      = int
 
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param1desc      = This number is the first number. It doesn't do anything.
 
| param2          = theSecondParameter
 
| param2          = theSecondParameter
| param2type      = int
 
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
 
| param2desc      = This is the second of the two numbers. Like the first number, this one does absolutely nothing.
| returntype      = bz_APIString
+
| returns          = A number that means absolutely nothing. It might be 0, or it might be 1, or it might be something else.
| 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)