RU/Debugging: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
 
(11 intermediate revisions by 9 users not shown)
Line 1: Line 1:
При написании скриптов вы обязательно столкнетесь с проблемами, которые не сможете решить немедленно. Цель этой страницы - показать вам основные способыы нахождения ошибок.
Во время скриптинга вы часто будете встречать проблемы, незаметные с первого взгляда. Эта страница покажет вам некоторые базовые стратегии локализирования ошибок.


==Консоль отладки==
==Консоль отладки==
MTA включает консоль, которая показывает отладочные сообщения, выводимые функциями MTA и скриптами. Вы можете открыть ее введя ''debugscript x'' в консоли, где ''x'' уровень отладки:
MTA предоставляет встроенную консоль отладки, которая показывает отладочные сообщения от функций и скриптов MTA. Ее можно открыть, введя в консоли ''debugscript x'', где ''x'' - уровень отладки:
* '''1:''' только ошибки
* '''1:''' только ошибки
* '''2:''' ошибки и предупреждения
* '''2:''' ошибки и предупреждения
* '''3:''' ошибки, предупреждения и информационные сообщения
* '''3:''' ошибки, предупреждения и информационные сообщения
Так, введя ''debugscript 3'', вы будете видеть все сообщения, этот или 2 уровень рекомендуется в большинстве случаев. Рекомендуем держать debugscript включенным всё время, пока вы тестируете свой скрипт, это поможет вам обнаружить мелкие ошибки и исправить их.
Таким образом, при вводе ''debugscript 3'' видны все сообщения, так что либо этот, либо уровень 2 рекомендованы в большинстве случаев. debugscript следует иметь включенным на протяжении практически всего времени, когда тестируете свои скрипты, это поможет в обнаружении опечаток и других мелких ошибок, позволяя с легкостью их поправить.


===Пример===
===Пример===
Этот участок кода содержит две ошибки:
В этом отрывке две ошибки:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
if (getClientName(player) == "Fedor")
if (getPlayerName(player) == "Fedor")
outputChatbox("Hello Fedor")
outputChatbox("Hello Fedor")
end
end
</syntaxhighlight>
</syntaxhighlight>
При попытке запуска скрипта, содержащего этот участо кода, debugscript выведет что-то похожее на:
Когда скрипт, в котором присутствует данный отрывок кода попробует загрузиться, debugscript выведет что-то типа этого:
{{Debug info|Loading script failed: C:\<server path>\mods\deathmatch\resources\myResource\script.lua:15: 'then' expected near ´outputChatbox'}}
:{{Debug info|Loading script failed: C:\<server path>\mods\deathmatch\resources\myResource\script.lua:15: 'then' expected near ´outputChatbox'}}
Это означает, что скрипт не может быть обработан из-за синтаксической ошибки. Показывается путь к скрипту, поэтому вы можете увидеть, какому ресурсу он принадлежит, ('myResource' в данном случае) и, конечно же, имя скрипта. После имени файла показан номер строки и информация об ошибке. Теперь проблема легко решается, мы просто забыли написать ключевое слово 'then':
Это значит, что скрипт не может быть обработан в силу синтаксической ошибки. Показывается путь ко скрипту, чтобы можно было также увидеть, частью какого ресурса он является ('myResource' в данном случае), и, конечно, имя самого скрипта. После имени файла показан номер строки и что в ней, собственно, не так. Теперь все с легкостью можно исправить, мы просто забыли оператор 'then':
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
if (getClientName(player) == "Fedor") then
if (getPlayerName(player) == "Fedor") then
outputChatbox("Hello Fedor")
outputChatbox("Hello Fedor")
end
end
</syntaxhighlight>
</syntaxhighlight>
Теперь скрипт загрузится нормально и не будет выводить ошибок пока не выполнится для игрока с ником 'Fedor'. Тогда debugscript выведет:
Сейчас скрипт нормально загрузится и не выведет никаких ошибок, но только пока не выполнится для игрока с ником 'Fedor'. В этом случае, debugscript выведет:
{{Debug error|C:\<server path>\mods\deathmatch\resources\d\script.lua:15: attempt to call global 'outputChatbox' (a nil value)}}
:{{Debug error|C:\<server path>\mods\deathmatch\resources\d\script.lua:15: attempt to call global 'outputChatbox' (a nil value)}}
Это значит, вызванная вами функция не существует, оно и понятно, ведь правильное название этой функции ''outputChatBox'' (с заглавной буквы ''B''):
То есть, что вызванной функции не существует, что и не удивительно, так как ее правильное название - ''outputChatBox'' (с заглавной ''B''):
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
if (getClientName(player) == "Fedor") then
if (getPlayerName(player) == "Fedor") then
outputChatBox("Hello Fedor")
outputChatBox("Hello Fedor")
end
end
</syntaxhighlight>
</syntaxhighlight>


Конечно, это просто пример, есть множество других сообщений и сценариев.
Это, конечно, лишь пример, есть еще море других сообщений и сценариев, но вам теперь должна быть понятна сама суть.


==Debug logging==
==Ведение отладочного лога на сервере и клиенте==
{{translate}}
====Сервер====
Можно также включить режим дебаггера, отредактировав ''coreconfig.xml'' в папке GTA\MTA. Найдите в нем следующий тэг:
Перейдите в: ''(корневая папка MTA)>server>mods>deathmatch''
<syntaxhighlight lang="xml"><debugfile/></syntaxhighlight>


И впишите туда адрес будущего лог-файла (путь указывайте, начиная с папки GTA):
Там есть два практически одинаковых файла:
<syntaxhighlight lang="xml"><debugfile>MTA\debugscript.log</debugfile></syntaxhighlight>


И теперь все сообщения дебаггера будут записываться в этот файл. Если хотите выключить ведение лога, оставьте содержимое тэга пустым:
*local.conf - содержит настройки сервера, доступного по нажатию на пункт "host game" главного меню MTA. Это быстрый и простой путь ненадолго запустить сервер извнутри клиента. При выключении клиента выключится и сервер.
<syntaxhighlight lang="xml"><debugfile/></syntaxhighlight>


==Debug strategies==
*mtaserver.conf - используется при выполнении запуска "MTA Server.exe" из (корневая папка MTA)>server. Это способ запустить сервер независимо от клиента на продолжительное время.
There are several strategies that support finding errors, apart from going through the code of course. Most of them include outputting debug messages, with differing information depending on the situtation.


===Useful functions===
В зависимости от выбранного вами способа, вам захочется отредактировать один из этих файлов. Настройки, интересные нам:
First of all some functions that may come in handy for debugging.
* [[outputDebugString]] or [[outputChatBox]] for outputting any information
* [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()] on a variable to turn it into a string, for example when it contains a boolean value
* [[getElementType]] to check an MTA Element for its type


===Add debugmessages to check ''if'', ''when'' or ''how often'' a section of code is executed===
<syntaxhighlight lang="xml"><!-- Задает имя и путь лог-файла debugscript. Если оставить пустым, такой файл создан не будет. -->
A typical example would be verify whether an ''if''-section is executed or not. To do that, just add any message you will recognize later within the ''if''-section.
<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
<!-- Задает уровень лог-файла debugscript. Допустимые значения: 0, 1, 2, 3. Если не установить, по умолчанию будет 0. -->
<scriptdebugloglevel>0</scriptdebugloglevel></syntaxhighlight>
 
Убедитесь, что указали имя лога. Также укажите уровень ошибок, которые будут записываться. При указании 0 ничего не будет записываться. Другие уровни были объяснены в начале данной статьи. При смене уровня записи на 3, все ошибки '''серверных''' скриптов будут записаны в (корневая папка MTA)>server>mods>deathmatch>logs>scripts.log
 
====Клиент====
Перейдите в: ''(корневая папка MTA)>server>clientscript.log''
 
В этот файл ведется запись ошибок всех '''клиентских''' скриптов. Запись включена по умолчанию, вмешательств не требуется.
 
==Стратегии отладки==
Есть несколько стратегий, помогающих в поиске ошибок, мы говорим об отличных от непосредственного просмотра кода, конечно же. Большинство из них включает в себя вывод отладочных сообщений с варьирующейся от ситуации к ситуации информацией.
 
===Полезные функции===
Для начала, некоторые функции, которые могут оказаться удобными при отладке.
* [[outputDebugString]] или [[outputChatBox]] для вывода информации любого вида
* [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()] обращает переменную в строковую, например, когда она является бинарной (двоичной)
* [[getElementType]] для выполнения проверки элемента MTA на получение его типа
 
===Добавляйте отладочные сообщения, чтобы проверять ''когда'', ''как часто'' и вообще, ''выполняется ли'' участок кода===
Типичный пример проверки на выполнение участка с ''if''. Чтобы его сделать, просто добавьте любое сообщение, которое вы потом будете в состоянии понять, внутрь участка с ''if''.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
if (variable1 == variable2) then
if (variable1 == variable2) then
outputDebugString("entered if")
outputDebugString("вошел в if")
-- do anything
-- что-нибудь делаем
end
end
</syntaxhighlight>
</syntaxhighlight>


Another application would be to check when variable values are modified. First search for all occurences of the variable being edited and add a message just beside it.
Другое применение - проверка переменной на предмет ее изменения. Для начала найдите все случаи, где переменная редактируется, и добавьте сообщения прямо рядом с ней.


===Add debugmessages to check the ''value'' of a variable===
===Добавляйте отладочные сообщения для проверки ''значения'' переменной===
Let's say you want to create a marker, but it doesn't appear at the position you expect it to be. The first thing you might want to do is check if the [[createMarker]] function is executed. But while doing this, you can also check the values being used in the [[createMarker]] function in one run.
Скажем, вы создали маркер, но он не появляется на той позиции, на которой вы этого хотели бы. Первое, что вы захотите сделать - проверить, была ли выполнена функция [[createMarker]]. Но одновременно с этим вы также можете проверить и значения, используемые при выполнении функции [[createMarker]], всего за один запуск.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
outputChatBox(tostring(x).." "..tostring(y).." "..tostring(z))
outputChatBox("posX - "..x.." posY - "..y.." posZ - "..z)
createMarker(x,y,z)
createMarker(x,y,z)
</syntaxhighlight>
</syntaxhighlight>
This would output all three variables that are used as coordinates for the marker. Assuming you read those from a map file, you can now compare the debug output to the desired values. The [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()] will ensure that the variables' value can be put together as a string, even if it's a boolean value for example.
Это выведет в консоль отладки все три переменные, используемые в качестве коодинат для маркера. Подразумевая, что у вас они считываются из map-файла, теперь вы сможете сравнить выведенное в консоль с желаемыми значениями. [http://www.lua.org/manual/5.1/manual.html#pdf-tostring tostring()] гарантирует, что значения переменных смогут быть выведены вместе строкой, даже если они, например, двоичные.


==Example==
==Пример==
Imagine you created a colshape (collision shape) somewhere and you want a player to stay 10 seconds in it, then perform some action.
Представьте, что где-то вы создали колшейп (collision shape) и хотите производить какое-либо действие над игроком, простоявшим в нем 10 секунд.
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function colShapeHit(player)
function colShapeHit(player)
-- set a timer to output a message (could as well execute another function)
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- store the timer id in a table, using the player as index
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)


function colShapeLeave(player)
function colShapeLeave(player)
-- kill the timer when the player leaves the colshape
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
killTimer(colshapeTimer[player])
end
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>
</syntaxhighlight>
When a player enters the colshape, debugscript outputs the following message:
При попадании игрока в колшейп, в консоль отладки выводится следующее сообщение:
{{Debug error|..[path]: attempt to index global 'colshapeTimer' (a nil value)}}
:{{Debug error|..[path]: attempt to index global 'colshapeTimer' (a nil value)}}
This means you tried to index a table that does not exist. In the example above, this is done when storing the timer id in the table. We need to add a check if the table exists and if not create it.
Что значит, что вы пытались проиндексировать несуществующую таблицу. В образце выше это сделано, так как id таймера сохраняется в таблице. Нам нужно добавить проверку на то, существует ли таблица, а если нет - создать ее.


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 98: Line 112:
colshapeTimer = {}
colshapeTimer = {}
end
end
-- set a timer to output a message (could as well execute another function)
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- store the timer id in a table, using the player as index
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)


function colShapeLeave(player)
function colShapeLeave(player)
-- kill the timer when the player leaves the colshape
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
killTimer(colshapeTimer[player])
end
end
Line 111: Line 125:
</syntaxhighlight>
</syntaxhighlight>


Now we still get a warning when a player enters the colshape, waits for the message and leaves it again:
Но мы все же получаем предупреждение, когда игрок попадает в колшейп, ждет сообщения и снова его покидает:


{{Debug warning|[..]: Bad argument @ 'killTimer' Line: ..}}
:{{Debug warning|[..]: Bad argument @ 'killTimer' Line: ..}}


Except for that (we will talk about that later) everything seems to work fine. A player enters the colshape, the timer is started, if he stays the message occurs, if he leaves the timer is killed.
За исключением этого сообщения (о нем поговорим позже) все, похоже, работает правильно. Игрок попадает в колшейп, таймер стартует, если он остается, появляется сообщение, если он уходит, таймер убирается.


===A more inconspicuous error===
===Более незаметная ошибка===
But for some reason the message gets outputted twice when you stay in the colcircle while in a vehicle. Since it would appear some code is executed twice, we add debug messages to check this.
Но, в силу некоторых обстоятельств, сообщение выводится дважды, если вы остаетесь в колшейпе на транспортном средстве. Если так получается, значит какой-то код выполняется дважды, мы добавим отладочные сообщения для проверки.


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 125: Line 139:
colshapeTimer = {}
colshapeTimer = {}
end
end
-- add a debug message
-- добавляем отладочное сообщение
outputDebugString("colShapeHit")
outputDebugString("colShapeHit")
-- set a timer to output a message (could as well execute another function)
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- store the timer id in a table, using the player as index
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)


function colShapeLeave(player)
function colShapeLeave(player)
-- add a debug message
-- добавляем отладочное сообщение
outputDebugString("colShapeLeave")
outputDebugString("colShapeLeave")
-- kill the timer when the player leaves the colshape
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
killTimer(colshapeTimer[player])
end
end
Line 142: Line 156:
</syntaxhighlight>
</syntaxhighlight>


Now we notice that both handler functions get executed twice when we are in a vehicle, but only once when we are on-foot. It would appear the vehicle triggers the colshape as well. To confirm this theory, we check the ''player'' variable that '''should''' contain a player element.
Теперь мы точно видим, что обе функции, прикрепленные к обработчикам, выполняются дважды, если мы в ТС, или один раз, если мы вне ТС. Такое может получаться, если транспортное средство тоже вызывает срабатывание колшейпа. Чтобы подтвердить или опровергнуть эту теорию, проверим переменную ''player'', которая '''должна''' содержать элемент типа player.


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 149: Line 163:
colshapeTimer = {}
colshapeTimer = {}
end
end
-- add a debug message, with the element type
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeHit "..getElementType(player))
outputDebugString("colShapeHit "..getElementType(player))
-- set a timer to output a message (could as well execute another function)
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- store the timer id in a table, using the player as index
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)


function colShapeLeave(player)
function colShapeLeave(player)
-- add a debug message, with the element type
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeLeave "..getElementType(player))
outputDebugString("colShapeLeave "..getElementType(player))
-- kill the timer when the player leaves the colshape
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
killTimer(colshapeTimer[player])
end
end
Line 166: Line 180:
</syntaxhighlight>
</syntaxhighlight>


The debug messages tell us that one of the ''player'' variables is a player, the other one a vehicle element. Since we only want to react when a player enters the colshape, we add an ''if'' that will end the execution of the function if it's '''not''' an player element.
Отладочные сообщения говорят, что одна из переменных ''player'' - действительно игрок, а другая - элемент типа vehicle, т.е. ТС. Так как мы хотим, чтобы срабатывание происходило при попадании в колшейп именно игрока, добавляем ''if'', который предотвратит выполнение функции, если в него попал '''не''' игрок (не элемент типа player).


<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
Line 173: Line 187:
colshapeTimer = {}
colshapeTimer = {}
end
end
-- add a check for the element type
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeHit "..getElementType(player))
outputDebugString("colShapeHit "..getElementType(player))
-- set a timer to output a message (could as well execute another function)
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- store the timer id in a table, using the player as index
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)


function colShapeLeave(player)
function colShapeLeave(player)
-- add a check for the element type
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeLeave "..getElementType(player))
outputDebugString("colShapeLeave "..getElementType(player))
-- kill the timer when the player leaves the colshape
-- убираем таймер при покидании игроком колшейпа
killTimer(colshapeTimer[player])
killTimer(colshapeTimer[player])
end
end
Line 194: Line 208:
</syntaxhighlight>
</syntaxhighlight>


Now the script should work as desired, but will still output the warning mentioned above. This happens because the timer we try to kill when a player leaves the colshape will not exist anymore when it reached the 10 seconds and is executed. There are different ways to get rid of that warning (since you know that the timer might not exist anymore and you only want to kill it if it is there). One way would be to check if the timer referenced in the table really exists. To do this, we need a little help function:
Теперь скрипт должен работать как задумано, но все еще будет выводить предупреждение, о котором было сказано ранее. Это происходит, так как таймер, который мы пытаемся убрать при покидании игроком колшейпа, не будет более существовать по прошествии 10 секунд (уже истек). Есть множество способов избавиться от этого предупреждения (вы же знаете, что таймер может более не существовать, и вы хотите его убрать, только если он еще существует). Одним из способов является проверка на то, существует ли упоминаемый в таблице таймер на самом деле. Чтобы ее сделать, нам понадобится [[isTimer]], которой мы и воспользуемся при убирании таймера:
<syntaxhighlight lang="lua">
function isTimer(timer)
local timers = getTimers()
for k,v in ipairs(timers) do
if (v == timer) then
return true
end
end
return false
end
</syntaxhighlight>
Which we will use when we kill the timer:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
if (isTimer(colshapeTimer[player])) then
if (isTimer(colshapeTimer[player])) then
Line 213: Line 215:
</syntaxhighlight>
</syntaxhighlight>


So the complete working code would be:
Итак, полностью рабочий код таков:
<syntaxhighlight lang="lua">
<syntaxhighlight lang="lua">
function colShapeHit(player)
function colShapeHit(player)
Line 219: Line 221:
colshapeTimer = {}
colshapeTimer = {}
end
end
-- add a check for the element type
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeHit "..getElementType(player))
outputDebugString("colShapeHit "..getElementType(player))
-- set a timer to output a message (could as well execute another function)
-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
-- store the timer id in a table, using the player as index
-- сохраняем id таймера в таблице, используя игрока как индекс
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)


function colShapeLeave(player)
function colShapeLeave(player)
-- add a check for the element type
-- добавляем проверку на тип элемента
if (getElementType(player) ~= "player") then return end
if (getElementType(player) ~= "player") then return end
-- add a debug message, with the element type
-- добавляем отладочное сообщение, с типом элемента
outputDebugString("colShapeLeave "..getElementType(player))
outputDebugString("colShapeLeave "..getElementType(player))
-- kill the timer when the player leaves the colshape
-- убираем таймер при покидании игроком колшейпа
if (isTimer(colshapeTimer[player])) then
if (isTimer(colshapeTimer[player])) then
killTimer(colshapeTimer[player])
killTimer(colshapeTimer[player])
Line 240: Line 242:
end
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
</syntaxhighlight>
==Отладка проблем с производительностью==
Если ваш сервер использует намного больше ресурсов, чем ему следовало бы, или вы просто хотите убедиться, что ваши скрипты эффективны, вы можете узнать правду, воспользовавшись отличным инструментом, который поставляется вместе с сервером MTA SA - performancebrowser. Удостоверьтесь, что он запущен, введя "start performancebrowser", а если у вас его нет, возьмите из комплекта стандартных ресурсов, поставляемых с сервером. Данный инструмент предоставляет потрясающее количество информации, полезной для отладки проблем с производительностью. Утечки памяти, утечки элементов и интенсивно использующие процессор скрипты легко найти через performancebrowser. Например, при использовании опции -d в Lua timing, вы можете увидеть, какие функции сильно загружают процессор.
Для доступа к performancebrowser вам понадобится перейти по адресу: http://здесьIPсервера:здесьHTTPпортсервера/performancebrowser/ в своем интернет-браузере. Заметьте, что в конце требуется символ / (слэш). То есть, например: http://127.0.0.1:22005/performancebrowser/ Затем вам понадобится войти со внутриигрового администраторского аккаунта или любого другого аккаунта, имеющего доступ к "general.HTTP". Большинство нужной вам информации находится в разделах Lua timing и Lua memory, там смотрите на те показатели, которые значительно превышают другие.


function isTimer(timer)
===Примеры скриптов, которые могут вызывать провалы производительности===
local timers = getTimers()
 
for k,v in ipairs(timers) do
Добавление данных в таблицу без последующего удаления. Хотя пройдут месяцы/годы, пока это реально вызовет какие-либо проблемы.
if (v == timer) then
<syntaxhighlight lang="lua">
return true
local someData = {}
end
 
end
function storeData()
return false
    someData[source] = true
    -- Здесь не учитывается выход игрока, что вызовет утечку памяти
    -- Используя вкладку Lua timing, вы можете обнаружить использование RAM каждым из ресурсов.
end
addEventHandler("onPlayerJoin", root, storeData)
</syntaxhighlight>
 
Утечка элементов возможна при использовании по какой-либо причине множества временных колшейпов и последующем их неустранении. Через некоторое время это повлечет за собой проблемы с пропускной способностью, расходом процессора и памяти сервера.
<syntaxhighlight lang="lua">
function useTemporaryCol()
    local col = createColCircle(здесь какой-нибудь код)
    if (нормальные для этого условия) then
        destroyElement(col)
    end
    -- Но иногда этого не происходит, так что даже по окончании скрипта зона коллизии остается, что впоследствии
    -- может вылиться в сотни, а то и тысячи бесполезных зон коллизии.
    -- Вкладка Lua timing позволит вам увидеть количество элементов, созданных каждым скриптом.
end
</syntaxhighlight>
 
Большой расход процессора чреват тем, что выливается в просадку FPS сервера до порога, когда тот становится неиграбельным. Менее чем за 24 часа это может превратить даже самый популярный сервер в пустующий. Количество "refs" в Lua timing обнаруживает данный тип скопления, удивительно, но вкладка Lua timing в данном случае не помогла, когда Lua memory - напротив.
<syntaxhighlight lang="lua">
addEventHandler("onPlayerJoin", root, function()
    -- Код для заходов
    addEventHandler("onPlayerQuit", root, function()
        -- Код для того, когда выходят
        -- Видите проблему? Он привязан к корню (root), к которому обработчик добавляется снова, снова и снова
    end)
end)
</syntaxhighlight>
 
Функция интенсивно использует процессор, потому что то, что она выполняет, занимает много времени. Это просто функция, которой для завершения требуется много времени. Без performancebrowser вы бы и не догадывались, в чем причина, но с performancebrowser вы можете увидеть, что ресурс сильно загружает процессор во вкладке Lua timing. Если вы затем введете: -d в редактируемое поле options, он даже скажет название файла и первую строку функции, которая так сильно загружает процессор.
<syntaxhighlight lang="lua">
function someDodgyCode()
    for i=1, 100000 do
        -- какой-нибудь код
    end
end
end
</syntaxhighlight>
</syntaxhighlight>


[[Category:Scripting Concepts]]
[[Category:Понятия скриптинга]]
 
[[en:Debugging]]
[[en:Debugging]]
[[hu:Debugging]]
[[it:Guida al Debug]]
[[it:Guida al Debug]]
[[zh-cn:脚本调试教程]]

Latest revision as of 16:43, 15 April 2017

Во время скриптинга вы часто будете встречать проблемы, незаметные с первого взгляда. Эта страница покажет вам некоторые базовые стратегии локализирования ошибок.

Консоль отладки

MTA предоставляет встроенную консоль отладки, которая показывает отладочные сообщения от функций и скриптов MTA. Ее можно открыть, введя в консоли debugscript x, где x - уровень отладки:

  • 1: только ошибки
  • 2: ошибки и предупреждения
  • 3: ошибки, предупреждения и информационные сообщения

Таким образом, при вводе debugscript 3 видны все сообщения, так что либо этот, либо уровень 2 рекомендованы в большинстве случаев. debugscript следует иметь включенным на протяжении практически всего времени, когда тестируете свои скрипты, это поможет в обнаружении опечаток и других мелких ошибок, позволяя с легкостью их поправить.

Пример

В этом отрывке две ошибки:

if (getPlayerName(player) == "Fedor")
	outputChatbox("Hello Fedor")
end

Когда скрипт, в котором присутствует данный отрывок кода попробует загрузиться, debugscript выведет что-то типа этого:

INFO: Loading script failed: C:\<server path>\mods\deathmatch\resources\myResource\script.lua:15: 'then' expected near ´outputChatbox'

Это значит, что скрипт не может быть обработан в силу синтаксической ошибки. Показывается путь ко скрипту, чтобы можно было также увидеть, частью какого ресурса он является ('myResource' в данном случае), и, конечно, имя самого скрипта. После имени файла показан номер строки и что в ней, собственно, не так. Теперь все с легкостью можно исправить, мы просто забыли оператор 'then':

if (getPlayerName(player) == "Fedor") then
	outputChatbox("Hello Fedor")
end

Сейчас скрипт нормально загрузится и не выведет никаких ошибок, но только пока не выполнится для игрока с ником 'Fedor'. В этом случае, debugscript выведет:

ERROR: C:\<server path>\mods\deathmatch\resources\d\script.lua:15: attempt to call global 'outputChatbox' (a nil value)

То есть, что вызванной функции не существует, что и не удивительно, так как ее правильное название - outputChatBox (с заглавной B):

if (getPlayerName(player) == "Fedor") then
	outputChatBox("Hello Fedor")
end

Это, конечно, лишь пример, есть еще море других сообщений и сценариев, но вам теперь должна быть понятна сама суть.

Ведение отладочного лога на сервере и клиенте

Сервер

Перейдите в: (корневая папка MTA)>server>mods>deathmatch

Там есть два практически одинаковых файла:

  • local.conf - содержит настройки сервера, доступного по нажатию на пункт "host game" главного меню MTA. Это быстрый и простой путь ненадолго запустить сервер извнутри клиента. При выключении клиента выключится и сервер.
  • mtaserver.conf - используется при выполнении запуска "MTA Server.exe" из (корневая папка MTA)>server. Это способ запустить сервер независимо от клиента на продолжительное время.

В зависимости от выбранного вами способа, вам захочется отредактировать один из этих файлов. Настройки, интересные нам:

<!-- Задает имя и путь лог-файла debugscript. Если оставить пустым, такой файл создан не будет. -->
	<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile> 
	
	<!-- Задает уровень лог-файла debugscript. Допустимые значения: 0, 1, 2, 3. Если не установить, по умолчанию будет 0. -->
	<scriptdebugloglevel>0</scriptdebugloglevel>

Убедитесь, что указали имя лога. Также укажите уровень ошибок, которые будут записываться. При указании 0 ничего не будет записываться. Другие уровни были объяснены в начале данной статьи. При смене уровня записи на 3, все ошибки серверных скриптов будут записаны в (корневая папка MTA)>server>mods>deathmatch>logs>scripts.log

Клиент

Перейдите в: (корневая папка MTA)>server>clientscript.log

В этот файл ведется запись ошибок всех клиентских скриптов. Запись включена по умолчанию, вмешательств не требуется.

Стратегии отладки

Есть несколько стратегий, помогающих в поиске ошибок, мы говорим об отличных от непосредственного просмотра кода, конечно же. Большинство из них включает в себя вывод отладочных сообщений с варьирующейся от ситуации к ситуации информацией.

Полезные функции

Для начала, некоторые функции, которые могут оказаться удобными при отладке.

  • outputDebugString или outputChatBox для вывода информации любого вида
  • tostring() обращает переменную в строковую, например, когда она является бинарной (двоичной)
  • getElementType для выполнения проверки элемента MTA на получение его типа

Добавляйте отладочные сообщения, чтобы проверять когда, как часто и вообще, выполняется ли участок кода

Типичный пример проверки на выполнение участка с if. Чтобы его сделать, просто добавьте любое сообщение, которое вы потом будете в состоянии понять, внутрь участка с if.

if (variable1 == variable2) then
	outputDebugString("вошел в if")
	-- что-нибудь делаем
end

Другое применение - проверка переменной на предмет ее изменения. Для начала найдите все случаи, где переменная редактируется, и добавьте сообщения прямо рядом с ней.

Добавляйте отладочные сообщения для проверки значения переменной

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

outputChatBox("posX - "..x.." posY - "..y.." posZ - "..z)
createMarker(x,y,z)

Это выведет в консоль отладки все три переменные, используемые в качестве коодинат для маркера. Подразумевая, что у вас они считываются из map-файла, теперь вы сможете сравнить выведенное в консоль с желаемыми значениями. tostring() гарантирует, что значения переменных смогут быть выведены вместе строкой, даже если они, например, двоичные.

Пример

Представьте, что где-то вы создали колшейп (collision shape) и хотите производить какое-либо действие над игроком, простоявшим в нем 10 секунд.

function colShapeHit(player)
	-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
	-- сохраняем id таймера в таблице, используя игрока как индекс
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
	-- убираем таймер при покидании игроком колшейпа
	killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)

При попадании игрока в колшейп, в консоль отладки выводится следующее сообщение:

ERROR: ..[path]: attempt to index global 'colshapeTimer' (a nil value)

Что значит, что вы пытались проиндексировать несуществующую таблицу. В образце выше это сделано, так как id таймера сохраняется в таблице. Нам нужно добавить проверку на то, существует ли таблица, а если нет - создать ее.

function colShapeHit(player)
	if (colshapeTimer == nil) then
		colshapeTimer = {}
	end
	-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
	-- сохраняем id таймера в таблице, используя игрока как индекс
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
	-- убираем таймер при покидании игроком колшейпа
	killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)

Но мы все же получаем предупреждение, когда игрок попадает в колшейп, ждет сообщения и снова его покидает:

WARNING: [..]: Bad argument @ 'killTimer' Line: ..

За исключением этого сообщения (о нем поговорим позже) все, похоже, работает правильно. Игрок попадает в колшейп, таймер стартует, если он остается, появляется сообщение, если он уходит, таймер убирается.

Более незаметная ошибка

Но, в силу некоторых обстоятельств, сообщение выводится дважды, если вы остаетесь в колшейпе на транспортном средстве. Если так получается, значит какой-то код выполняется дважды, мы добавим отладочные сообщения для проверки.

function colShapeHit(player)
	if (colshapeTimer == nil) then
		colshapeTimer = {}
	end
	-- добавляем отладочное сообщение
	outputDebugString("colShapeHit")
	-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
	-- сохраняем id таймера в таблице, используя игрока как индекс
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
	-- добавляем отладочное сообщение
	outputDebugString("colShapeLeave")
	-- убираем таймер при покидании игроком колшейпа
	killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)

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

function colShapeHit(player)
	if (colshapeTimer == nil) then
		colshapeTimer = {}
	end
	-- добавляем отладочное сообщение, с типом элемента
	outputDebugString("colShapeHit "..getElementType(player))
	-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
	-- сохраняем id таймера в таблице, используя игрока как индекс
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
	-- добавляем отладочное сообщение, с типом элемента
	outputDebugString("colShapeLeave "..getElementType(player))
	-- убираем таймер при покидании игроком колшейпа
	killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)

Отладочные сообщения говорят, что одна из переменных player - действительно игрок, а другая - элемент типа vehicle, т.е. ТС. Так как мы хотим, чтобы срабатывание происходило при попадании в колшейп именно игрока, добавляем if, который предотвратит выполнение функции, если в него попал не игрок (не элемент типа player).

function colShapeHit(player)
	if (colshapeTimer == nil) then
		colshapeTimer = {}
	end
	-- добавляем проверку на тип элемента
	if (getElementType(player) ~= "player") then return end
	-- добавляем отладочное сообщение, с типом элемента
	outputDebugString("colShapeHit "..getElementType(player))
	-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
	-- сохраняем id таймера в таблице, используя игрока как индекс
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
	-- добавляем проверку на тип элемента
	if (getElementType(player) ~= "player") then return end
	-- добавляем отладочное сообщение, с типом элемента
	outputDebugString("colShapeLeave "..getElementType(player))
	-- убираем таймер при покидании игроком колшейпа
	killTimer(colshapeTimer[player])
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)

Теперь скрипт должен работать как задумано, но все еще будет выводить предупреждение, о котором было сказано ранее. Это происходит, так как таймер, который мы пытаемся убрать при покидании игроком колшейпа, не будет более существовать по прошествии 10 секунд (уже истек). Есть множество способов избавиться от этого предупреждения (вы же знаете, что таймер может более не существовать, и вы хотите его убрать, только если он еще существует). Одним из способов является проверка на то, существует ли упоминаемый в таблице таймер на самом деле. Чтобы ее сделать, нам понадобится isTimer, которой мы и воспользуемся при убирании таймера:

if (isTimer(colshapeTimer[player])) then
	killTimer(colshapeTimer[player])
end

Итак, полностью рабочий код таков:

function colShapeHit(player)
	if (colshapeTimer == nil) then
		colshapeTimer = {}
	end
	-- добавляем проверку на тип элемента
	if (getElementType(player) ~= "player") then return end
	-- добавляем отладочное сообщение, с типом элемента
	outputDebugString("colShapeHit "..getElementType(player))
	-- устанавливаем таймер на вывод сообщения (можно также вызвать другую функцию)
	-- сохраняем id таймера в таблице, используя игрока как индекс
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"Игрок задержался в колшейпе на 10 секунд!")
end
addEventHandler("onColShapeHit",getRootElement(),colShapeHit)

function colShapeLeave(player)
	-- добавляем проверку на тип элемента
	if (getElementType(player) ~= "player") then return end
	-- добавляем отладочное сообщение, с типом элемента
	outputDebugString("colShapeLeave "..getElementType(player))
	-- убираем таймер при покидании игроком колшейпа
	if (isTimer(colshapeTimer[player])) then
		killTimer(colshapeTimer[player])
	end
end
addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)


Отладка проблем с производительностью

Если ваш сервер использует намного больше ресурсов, чем ему следовало бы, или вы просто хотите убедиться, что ваши скрипты эффективны, вы можете узнать правду, воспользовавшись отличным инструментом, который поставляется вместе с сервером MTA SA - performancebrowser. Удостоверьтесь, что он запущен, введя "start performancebrowser", а если у вас его нет, возьмите из комплекта стандартных ресурсов, поставляемых с сервером. Данный инструмент предоставляет потрясающее количество информации, полезной для отладки проблем с производительностью. Утечки памяти, утечки элементов и интенсивно использующие процессор скрипты легко найти через performancebrowser. Например, при использовании опции -d в Lua timing, вы можете увидеть, какие функции сильно загружают процессор.

Для доступа к performancebrowser вам понадобится перейти по адресу: http://здесьIPсервера:здесьHTTPпортсервера/performancebrowser/ в своем интернет-браузере. Заметьте, что в конце требуется символ / (слэш). То есть, например: http://127.0.0.1:22005/performancebrowser/ Затем вам понадобится войти со внутриигрового администраторского аккаунта или любого другого аккаунта, имеющего доступ к "general.HTTP". Большинство нужной вам информации находится в разделах Lua timing и Lua memory, там смотрите на те показатели, которые значительно превышают другие.

Примеры скриптов, которые могут вызывать провалы производительности

Добавление данных в таблицу без последующего удаления. Хотя пройдут месяцы/годы, пока это реально вызовет какие-либо проблемы.

local someData = {}

function storeData()
    someData[source] = true
    -- Здесь не учитывается выход игрока, что вызовет утечку памяти
    -- Используя вкладку Lua timing, вы можете обнаружить использование RAM каждым из ресурсов.
end
addEventHandler("onPlayerJoin", root, storeData)

Утечка элементов возможна при использовании по какой-либо причине множества временных колшейпов и последующем их неустранении. Через некоторое время это повлечет за собой проблемы с пропускной способностью, расходом процессора и памяти сервера.

function useTemporaryCol()
    local col = createColCircle(здесь какой-нибудь код)
    if (нормальные для этого условия) then
        destroyElement(col)
    end
    -- Но иногда этого не происходит, так что даже по окончании скрипта зона коллизии остается, что впоследствии
    -- может вылиться в сотни, а то и тысячи бесполезных зон коллизии. 
    -- Вкладка Lua timing позволит вам увидеть количество элементов, созданных каждым скриптом.
end

Большой расход процессора чреват тем, что выливается в просадку FPS сервера до порога, когда тот становится неиграбельным. Менее чем за 24 часа это может превратить даже самый популярный сервер в пустующий. Количество "refs" в Lua timing обнаруживает данный тип скопления, удивительно, но вкладка Lua timing в данном случае не помогла, когда Lua memory - напротив.

addEventHandler("onPlayerJoin", root, function()
    -- Код для заходов
    addEventHandler("onPlayerQuit", root, function()
        -- Код для того, когда выходят
        -- Видите проблему? Он привязан к корню (root), к которому обработчик добавляется снова, снова и снова
    end)
end)

Функция интенсивно использует процессор, потому что то, что она выполняет, занимает много времени. Это просто функция, которой для завершения требуется много времени. Без performancebrowser вы бы и не догадывались, в чем причина, но с performancebrowser вы можете увидеть, что ресурс сильно загружает процессор во вкладке Lua timing. Если вы затем введете: -d в редактируемое поле options, он даже скажет название файла и первую строку функции, которая так сильно загружает процессор.

function someDodgyCode()
    for i=1, 100000 do
        -- какой-нибудь код
    end
end