YoYoGames Wiki:Article formatting/functions
From YoYoGames Wiki
Game Maker function articles have a separate article formatting guideline which will be explained in detail in this page.
- To link others to this page, use YY:FUNC.
Contents |
General Format
{{GMfunc|
title=required_title_of_the_function(and,all,arguments)
|description=A description of the function. Short and brief and straightforward.
|arguments=
*'''and''' ([[string]]): a description of
*'''all''' ([[real]]): of the
*'''arguments''' ([[real]]): for the function. In this style. Optional.
|return=([[string]]/[[real]]): information about the returned value, if applicable
|image=An_Image.png of the function, if it helps illustrate information about the function.
}}
==Explanation==
A further explanation section of the function that describes
it in further detail. If there is no explanation available,
the section would be omitted.
==Examples==
Some code examples on the functions. Do as much as you want.
If there are a lot of examples you can add "===Subsections===".
==Remarks==
Does this function only work in the registered version of Game
Maker? Does this function need to be called in the draw event?
Is this function too slow? Write any extra remarks about the
function here.
==See Also==
*[[similar functions]]
*[[etc]]
==External Links== [optional]
*[http://some site]
Description
The {{GMfunc}} Template
The {{GMfunc}} template contains some of the basic information that is included in most function pages. Note that most of the variables that need to be substituted in the template are optional. This means that if a certain function does not have arguments, the entire line with the arguments can be entirely omitted by simply not including it! The same applies to the image, description, and the return value. The title of the function, however, is required.
For more information about the GMfunc template, please see its documentation.
Explanation
The explanation section includes any further explanation that is too long to be included under the "description" variable of the {{GMfunc}} template. This is optional and only to be used if a further explanation needs to be given.
Examples
Here, code examples are used to further illustrate some information about the function. This includes information on how to use it, certain occasions where the function is useful, and using examples to further illustrate a use of the function that is vague when mentioned in its explanation or description.
Remarks
Further remarks ore only written if there are any. Not all functions need to have remarks. A remark does not explain the function in itself or what it does, but usually outlines its limitation, etc. This includes saying that the function only works on the pro version of Game Maker 7.0, or that the function was introduced in Game Maker 5.3, etc. This section is also useful if a certain function (i.e. a draw function), should only be called in the draw event or with conjunction with surfaces.
See Also and External Links
The See Also and External Links sections are typical sections found in other articles as well. The See Also section provides links to other functions that are either similar, or functions which work together, complement each other, or are inter-dependent. External links are only included if necessary.
Other Sections?
In general, we do not recommend adding addition high-level sections to the function page. This means that no "==Heading==" should be added, but should rather be incorporated in other locations. This includes adding it to the description of the function in the template, or to one of the sections that exist after the template (e.g. Explanation).
Sub sections of the existing sections, however, can be added if necessary. So, if a lot of text can be included under the "Explanation", it might be wise to divide it to sub sections. The same applies to examples.
Categorization
While there is no apparent categorization in the actual format you write, using the {{GMfunc}} template will automatically categorize the article under the Game Maker Functions category.
