HU/Debugging
A szkriptekben gyakran előfordulnak kisebb nagyobb problémák, amelyeket nem veszünk észre!Ez a leírás segít abban hogy gyorsan megtaláld őket!
Hibakereső konzol
Az MTA tartalmaz beépített hibakereső konzolt!Hasznos mivel ha elgépelünk valamit és nem vesszük észre ő segítségünkre lehet.Ahhoz hogy tudjuk aktiválni ezt a jogusultságot Adminisztrátor rangot kell viselnünk{ACL}.Ha ez rendben van akkor a "debugscript x" parancsal tudjuk változtatni a visszajelzési szintet!
Lehetőségek:
- 1: Csak a Hibákat jelzi
- 2: A Hibákat és a Figyelmeztetéseket is jelzi
- 3: A Hibákat és a Figyelmeztetéseket is jelzi illetve az Információkat amelyeket elrejtünk a szkriptekben!
Ha begépeljük a "debugscript 3" parancsot akkor a fent leírt paramétereket fogja megmutatni.Ez a legcélszerűbb funkció, sokkal egyszerűbb vele a fejlesztés
Példa
Ebben a kódban elrejtettünk két darab hibát:
function Koszones(message, player) if (getPlayerName(player) == "Józsika") outputChatbox("Szia Józsika") end end addEventHandler("onChatMessage", root, Koszones)
Ha ezt a kódot lefuttatjuk akkor ezt a hibaüzenetet fogjuk kapni:
- INFO: Loading script failed: myResource\script.lua:2: 'then' expected near ´outputChatbox'[Ezt nem fordítom le]
Itt láthatjuk a hiba pozícióját!(heyle,hibás sor, hiba)
function Koszones(message, player) if (getPlayerName(player) == "Józsika") then outputChatbox("Szia Józsika") end end addEventHandler("onChatMessage", root, Koszones)
Ez mindaddig működik, míg a játékos neve nem Józsika, ha az, akkor ezt láthassuk:
- ERROR: myResource\script.lua:2: attempt to call global 'outputChatbox' (a nil value)
Ez az error azt jelenti, hogy a outputChatbox egy nil érték, az-az, nem létezik.Ez azért van, mert a funkciót outputChatBox-nak hivják, és nem outputChatbox-nak.Figyelj a nagy 'B' betűre:
function SayHello(message, player) if (getPlayerName(player) == "Józsika") then outputChatBox("Szia Józsika") end end addEventHandler("onChatMessage", root, SayHello)
Ez csak egy kis része a rendszernek.Nagyon sokoldalú illetve érdekes visszajelzéseket tud adni vissza nekünk.
=Szerver & Cliens hibakeresési napló
Szerver
Menj be a: (MTA mappa)>server>mods>deathmatch mappába
Van itt két majdnem azonos fájl.
- A local.conf a beállításokat tartalmazza a „host játék” menüpont beállításait a főmenübe. Ez egy gyors módja a szerver indításának. Ha a host lecsatlakozik akkor a szerver is kikapcsol!
- A mtaserver.conf akkor használjuk, amikor „MTA SERVER.EXE” fájlal indítjuk a szervert!(MTA mappája)> server. Ez a saját szerver konzol, szóval ha a host lecsatlakozik akkor nem kapcsol le. Ez akkor lehet hasznos, ha érdekel a szerver hosting hosszabb ideig.
Itt be lehet állítani a logok mentési helyét!
<!-- Itt beírhatja a log helyét!Ha üresen hagyod akkor a szerver megspórolja a helyet! --> <scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile> <!-- Itt lehet beállítani a debug szintjét! Lehetséges értékek: 0, 1, 2, 3. Ha nincs beállítva, akkor automatikusan 0. --> <scriptdebugloglevel>0</scriptdebugloglevel>
Te biztos akarsz lenni hogy van egy file a megadott néven. Meg tudod határozni, hogy milyen szintű hibák kerüljene knaplózásra . Ha ez 0 akkor semmi nem lesz rögzítve. A szintek magyarázata a cikk tetején található. Ha a naplózási szint megváltozott 3-ra, akkor ebben az esetben minden „” „szerveroldalon” „” lévő szkripthibákat elnaplóz.
(MTA mappa)>server>mods>deathmatch>logs>scripts.log
Kliens
Menj a: (MTA mappa)>server>clientscript.log
Ez a file az összes kliensoldali szkript hibákat naplózza. Ő alapértelmezés szerint fent van, nincs szükség telepítésre!
Hibakeresési stratégiák
Számos stratégia létezik, amelyek támogatják a hibakeresést. Legtöbbjük közé tartozik a kimenő Hibaüzenetek, a különböző információktól függően helyezkednek el.
Hasznos funkciók
Vannak olyan funkciók, amelyek jól jöhetnek a hibakereséshez.
- outputDebugString vagy outputChatBox (outputDebugString a műszaki kimenet)
- tostring() Hasznos, ha az érték nem szám vagy string.
- getElementType ellenőrizni, hogy milyen típusú az MTA elem.
- isElement ellenőrizni, hogy a MTA elem létezik.
Add debugmessages to check if, when or how often a section of code is executed
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.
if (variable1 == variable2) then outputDebugString("variable1 is the same as variable2!") -- do anything end
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.
outputChatBox("posX is: "..x.." posY is: "..y.." posZ is: "..z) createMarker(x,y,z)
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 tostring() will ensure that the values of the variables can be concatenated (put together) as a string, even if it's a boolean value.
Example
Imagine you created a collision shape somewhere and you want an action to perform after the player stays for ten seconds inside it, you would do this:
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 colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!") end addEventHandler("onColShapeHit", root, colShapeHit) function colShapeLeave(player) -- kill the timer when the player leaves the colshape killTimer(colshapeTimer[player]) end addEventHandler("onColShapeLeave", root, colShapeLeave)
When a player enters the colshape, debugscript outputs the following message:
- ERROR: ..[path]: attempt to index global 'colshapeTimer' (a nil value)
This means you tried to index a table that does not exist (because the table is a nil value, it doesn't 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 it does not exist we should create it.
function colShapeHit(player) if (colshapeTimer == nil) then colshapeTimer = {} 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 colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!") end addEventHandler("onColShapeHit", root, colShapeHit) function colShapeLeave(player) -- kill the timer when the player leaves the colshape killTimer(colshapeTimer[player]) end addEventHandler("onColShapeLeave",root,colShapeLeave)
Now we will still receive a warning when a player enters the colshape, waits for the message and leaves it again:
- 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.
function colShapeHit(player) if (colshapeTimer == nil) then colshapeTimer = {} end -- add a debug message 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 colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!") end addEventHandler("onColShapeHit",getRootElement(),colShapeHit) function colShapeLeave(player) -- add a debug message outputDebugString("colShapeLeave") -- kill the timer when the player leaves the colshape killTimer(colshapeTimer[player]) end addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
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 ensure that the player variable actually holds a reference to a player element.
function colShapeHit(player) if (colshapeTimer == nil) then colshapeTimer = {} end -- add a debug message, with the element type 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 colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!") end addEventHandler("onColShapeHit",getRootElement(),colShapeHit) function colShapeLeave(player) -- add a debug message, with the element type outputDebugString("colShapeLeave "..getElementType(player)) -- kill the timer when the player leaves the colshape killTimer(colshapeTimer[player]) end addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
The debug messages tell us that one of the player variables is a player and that the other one is 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.
function colShapeHit(player) if (colshapeTimer == nil) then colshapeTimer = {} end -- add a check for the element type if (getElementType(player) ~= "player") then return end -- add a debug message, with the element type 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 colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!") end addEventHandler("onColShapeHit",getRootElement(),colShapeHit) function colShapeLeave(player) -- add a check for the element type if (getElementType(player) ~= "player") then return end -- add a debug message, with the element type outputDebugString("colShapeLeave "..getElementType(player)) -- kill the timer when the player leaves the colshape killTimer(colshapeTimer[player]) end addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
Now the script should work as desired, but it 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 has reached the 10 seconds (and therefore executed after the 10th second has completed). 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 exists). One way would be to check if the timer referenced in the table really exists. To do this, we need to use isTimer, which we will use when we kill the timer:
if (isTimer(colshapeTimer[player])) then killTimer(colshapeTimer[player]) end
So the complete working code would be:
function colShapeHit(player) if (colshapeTimer == nil) then colshapeTimer = {} end -- add a check for the element type if (getElementType(player) ~= "player") then return end -- add a debug message, with the element type 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 colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!") end addEventHandler("onColShapeHit",getRootElement(),colShapeHit) function colShapeLeave(player) -- add a check for the element type if (getElementType(player) ~= "player") then return end -- add a debug message, with the element type outputDebugString("colShapeLeave "..getElementType(player)) -- kill the timer when the player leaves the colshape if (isTimer(colshapeTimer[player])) then killTimer(colshapeTimer[player]) end end addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
Debugging Performance Issues
If your server is using up more resources than it should or you just want to make sure your scripts are efficient, you can find the source of the issue by using a great tool that comes with the default resource package called performancebrowser. You can start it with 'start performancebrowser'. If it doesn't exist then you can get the latest resources from the GitHub repository. This tool provides an incredible amount of information for performance debugging. Memory leaks, element leaks and CPU intensive scripts are all easily findable via performancebrowser. If you use the 'd' option in Lua timing you can see which functions are using up the CPU.
To access performancebrowser you will need to go to your web browser and enter the address: http://serverIPHere:serverHTTPPortHere/performancebrowser/ Note that the / at the end is required. So for example: http://127.0.0.1:22005/performancebrowser/ You will then need to login with an in-game admin account or any account that has access to 'resource.performancebrowser.http' and 'resource.ajax.http'. Most of the information you will need are in the categories Lua timing and Lua memory, look for values that are much higher than other values.
Examples of scripts that could cause performance problems
Adding data to a table but never removing it. This would take months/years before it causes a problem though.
local someData = {} function storeData() someData[source] = true -- There is no handling for when a player quits, this is considered a memory leak -- Using the Lua timing tab you can detect the RAM usage of each resource. end addEventHandler("onPlayerJoin", root, storeData)
Element leaking is possible if you use temporary colshapes for whatever reason and may not destroy them. This would cause bandwidth, CPU and memory performance issues over time.
function useTemporaryCol() local col = createColCircle(some code here) if (normally this should happen) then destroyElement(col) end -- But sometimes it didn't so the script ended but the collision area remained and over time -- you may end up with hundreds to thousands of pointless collision areas. -- The Lua timing tab allows you to see the amount of elements each script has created. end
High CPU usage resulting in the server FPS dropping so much that the server is unplayable. In under 24 hours this can create havoc on a very busy server. The amount of "refs" in the Lua timing detect this type of build up, surprisingly the Lua timing tab didn't help in this case but Lua memory did.
addEventHandler("onPlayerJoin", root, function() -- Code for joiner addEventHandler("onPlayerQuit", root, function() -- Code for when they have quit -- See the problem? It's bound to root which the event handler is being added again and again and again end) end)
A function uses up a lot of your CPU because whatever it does takes a long time. This is just some function that takes a long time to complete. Without performancebrowser you'd have no idea its the cause but with performancebrowser you can see that a resource is using lots of CPU in the Lua timing tab. If you then enter: 'd' into the options edit box it will even tell you what file name and first line of the function that is using up so much CPU.
function someDodgyCode() for i=1, 100000 do -- some code end end
Fordította
- Kevin
- Surge