Шаблон для новых тем

[Daniel_Cortez]

В этой теме приведён общий шаблон для описания функций.
Если хотите создать свою тему с описанием какой-либо нативной/автовызываемой функции в SA:MP или опубликовать свою функцию, просто скопируйте содержимое из-под спойлера ниже и заполните его.



Описание:

<описание функции>

Параметры:

<параметр1> - <описание>
<параметр2> - <описание>
<...>
<параметрN> - <описание>



Возвращаемое значение:

<Описание возвращаемого значения>

Плюсы реализации: <только для пользовательских функций, необязательное поле>

<перечисление>
<...>


Минусы реализации: <только для пользовательских функций, необязательное поле>

<перечисление>
<...>


Код: <только для пользовательских функций>


<Код функции>


Примечания: <необязательный пункт>
<...>
<...>


Пример использования:


<Код примера>

См. также: <необязательный пункт>

[Native] <название статьи #1> (<ссылка на статью #1>)
[Callback] <название статьи #2> (<ссылка на статью #2>)
[Function] <название статьи #3> (<ссылка на статью #3>)




Автор: <Ваш никнейм> <только для пользовательских функций>
Статью подготовил: <Ваш никнейм><только для нативных и автовызываемых функций>

Внимание: Не пытайтесь изменить цвет, шрифт и стиль подзаголовков или вносить ещё какие-либо свои изменения в шаблон. Серьёзно, в чём смысл шаблона, если каждый будет пытаться по-своему переделать его?
То же самое касается расположения строк и BB-кодов: не пытайтесь ставить лишние переносы и выносить BB-коды на новую строку. После каких-то пунктов в шаблоне присутствует лишняя пустая строка, после других нет - я сделал так специально, чтобы всё выглядело ровно, поскольку после некоторых BB-кодов ([list], [indent], etc.) и без переносов возникает лишнее пространство между строками.

Примеры использования на практике:

http://pro-pawn.ru/showthread.php?12246-SetPlayerFacingPos
http://pro-pawn.ru/showthread.php?3243-itos
http://pro-pawn.ru/showthread.php?12277-CreateActor
http://pro-pawn.ru/showthread.php?8862-settime-setdate

[Daniel_Cortez]

Переместил пункт "Примечания", поставив его перед пунктом "Пример использования", т.к. читателям может потребоваться сначала узнать особенности при работе с функцией, прежде чем смотреть на примеры кода.
Просьба ко всем, кто использовал этот шаблон, точно так же переместить вышеупомянутый пункт.

[Daniel_Cortez]

Добавил необязательный пункт "См. также". Впервые этот пункт был использован в статьях про функции gpci (http://pro-pawn.ru/showthread.php?12530-gpci) и PackHash (http://pro-pawn.ru/showthread.php?12507-PackHash), но так и не задокументирован до сих пор.
Также в этом пункте приведены примеры ссылок на статьи с нативными функциями, коллбэками и пользовательскими функциями. Форматирование текста ссылок прилагается.