API Function Template

A repeat of the description, perhaps with more detail, and additional notes on the function's use.
;Usage
Object.Function(param_1, param_2 [, param3])
Parameter	Type 	Description
param_1 	type (eg. string, number, boolean, table)	description
param_2 	type 	description
param_3 	type 	description
;Return Values
Value 	Type 	Description
value_1	type (eg. string, number, boolean, table)	description
value_2	type 	description
value_3	type 	description
;Examples:
<nowiki>
Some basic code examples illustrating how to use the function (may be omitted if it's obvious for the function in question).
</nowiki>
Category:Addon_API