Difference between revisions of "Template:Apicall/doc"

From BZFlagWiki
Jump to: navigation, search
Line 9: Line 9:
 
This would result in the following:
 
This would result in the following:
  
{{apicall
+
:{{apicall
 
| name            = bz_testApiCall()
 
| name            = bz_testApiCall()
 
}}
 
}}

Revision as of 22:48, 14 December 2008

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.

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:

{{apicall
| name             = bz_testApiCall()
}}

This would result in the following:

void bz_testApiCall() ()


No description