Template:Callback/doc

This template is used to describe a callback. It will generally be used on the page of the class that it belongs to.

Technical details
In essence, this template does nothing other than just passing all the arguments it receive to the member template, together with an additional type argument, which will always be "callback".

Parameters
'''It is important to fill all the parameters that apply. Leaving out parameters may cause problems and makes the page look unprofessional. If you don't know what to put in a field, ask for help on the talk page.'''


 * name
 * The name of the member. Would be "OnInvoke", in the case of the  callback.


 * level
 * The level of the member's section header. The default value for this parameter is 2.


 * pt1 - pt9
 * The type of the parameters. In the case of the  callback, pt1 would be "Tuple".


 * pn1 - pn9
 * The name of the parameters. In the case of the  callback, pn1 would be "arguments". These names should not be invented, they should be the names that appear in the API dump and in the object browser.


 * pd1 - pd9
 * The description of the parameters (usually a short sentence that describes the parameter).


 * description
 * The description of the callback.


 * status
 * The status of the callback. Must be 'deprecated', 'readonly', 'preliminary' or 'hidden'. The status of a callback can be found in the API dump or in the object browser.


 * status2
 * The second status of the callback, for callbacks that have more than one status. Must conform to the same rules as the status parameter.


 * security
 * The security identifier of the callback, for callbacks that cannot be used by all threads. This information can only be found in the API dump and must be 'RobloxPlaceSecurity', 'RobloxScriptSecurity', 'LocalUserSecurity' or 'RobloxSecurity'.