Template:ApiReference

Use this template at the top of every API reference page:

{{ApiReference | name=spr | shortdesc=Draws a sprite, or sprite range, on the screen. | n || The sprite number. | x || The x coordinate. | y || The y coordinate. | flip_x | optional | If true, flips horizontally. | flip_y | optional | If true, flips vertically. }}

name=... is the name of the function.

shortdesc=... is a short description, where the first sentence is a verb phrase with an implied noun (e.g. "Draws a sprite, or sprite range, on the screen."), followed by an optional second (full) sentence.

The subsequent template parameters describe the function arguments. Each argument has three template parameters: the argument name, "optional" if the argument is optional, and a short description.

As a matter of style, function and argument short descriptions begin with a capital letter and end with a period.

This template supports up to 10 function arguments. Extend the template if more are needed.

{{{name}}} (

)

{{{shortdesc}}}