FR/Debugage - Revision history

Fabervox at 12:11, 29 September 2014

2014-09-29T12:11:08Z

← Older revision		Revision as of 12:11, 29 September 2014
Line 281:		Line 281:
	</syntaxhighlight>		</syntaxhighlight>

			[[Category:Translated/Scripting Concepts]]
	[[it:Guida al Debug]]		[[it:Guida al Debug]]
	~~[[Category:Scripting Concepts]]~~
	[[ru:Debugging]]		[[ru:Debugging]]

V1ncenzo: /* Une erreur un peu plus complexe */

2014-07-08T21:11:25Z

Une erreur un peu plus complexe

← Older revision		Revision as of 21:11, 8 July 2014
Line 170:		Line 170:
	colshapeTimer = {}		colshapeTimer = {}
	end		end
	-- ~~add a check for the element~~ type		-- vérification du type de l'élement
	if (getElementType(player) ~= "player") then return end		if (getElementType(player) ~= "player") then return end
	-- ~~add a debug~~ message~~, with the element~~ type		-- ajout d'un message avec le type de l'élement
	outputDebugString("colShapeHit "..getElementType(player))		outputDebugString("colShapeHit "..getElementType(player))
	-- ~~set a~~ timer ~~to output a~~ message (~~could as well execute another function~~)		-- ajout d'un timer pour afficher un message (peut aussi appeler une fonction)
	-- ~~store the~~ timer id ~~in a table, using the player as index~~		-- stockage du timer dans un tableau d'id en utilisant le joueur comme ordre de rangement
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")		colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
	end		end
Line 181:		Line 181:

	function colShapeLeave(player)		function colShapeLeave(player)
	-- ~~add a check for the element~~ type		-- vérification du type de l'élement
	if (getElementType(player) ~= "player") then return end		if (getElementType(player) ~= "player") then return end
	-- ~~add a debug~~ message~~, with the element~~ type		-- ajout d'un message avec le type de l'élement
	outputDebugString("colShapeLeave "..getElementType(player))		outputDebugString("colShapeLeave "..getElementType(player))
	-- ~~kill the~~ timer ~~when the player leaves the~~ colshape		-- arrête le timer quand le joueur quitte le colshape
	killTimer(colshapeTimer[player])		killTimer(colshapeTimer[player])
	end		end
Line 205:		Line 205:
	colshapeTimer = {}		colshapeTimer = {}
	end		end
	-- ~~add a check for the element~~ type		-- vérification du type de l'élement
	if (getElementType(player) ~= "player") then return end		if (getElementType(player) ~= "player") then return end
	-- ~~add a debug~~ message~~, with the element~~ type		-- ajout d'un message avec le type de l'élement
	outputDebugString("colShapeHit "..getElementType(player))		outputDebugString("colShapeHit "..getElementType(player))
	-- ~~set a~~ timer ~~to output a~~ message (~~could as well execute another function~~)		-- ajout d'un timer pour afficher un message (peut aussi appeler une fonction)
	-- ~~store the~~ timer id ~~in a table, using the player as index~~		-- stockage du timer dans un tableau d'id en utilisant le joueur comme ordre de rangement
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")		colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
	end		end
Line 216:		Line 216:

	function colShapeLeave(player)		function colShapeLeave(player)
	-- ~~add a check for the element~~ type		-- vérification du type de l'élement
	if (getElementType(player) ~= "player") then return end		if (getElementType(player) ~= "player") then return end
	-- ~~add a debug~~ message~~, with the element~~ type		-- ajout d'un message avec le type de l'élement
	outputDebugString("colShapeLeave "..getElementType(player))		outputDebugString("colShapeLeave "..getElementType(player))
	-- ~~kill the~~ timer ~~when the player leaves the~~ colshape		-- arrête le timer quand le joueur quitte le colshape
	if (isTimer(colshapeTimer[player])) then		if (isTimer(colshapeTimer[player])) then
	killTimer(colshapeTimer[player])		killTimer(colshapeTimer[player])

V1ncenzo: /* Une erreur un peu plus complexe */

2014-07-08T21:07:43Z

Une erreur un peu plus complexe

← Older revision		Revision as of 21:07, 8 July 2014
Line 148:		Line 148:
	-- ajout d'un message de debugage avec le type de l'élément		-- ajout d'un message de debugage avec le type de l'élément
	outputDebugString("colShapeHit "..getElementType(player))		outputDebugString("colShapeHit "..getElementType(player))
	-- ~~set a~~ timer ~~to output a~~ message (~~could as well execute another function~~)		-- ajout d'un timer pour afficher un message (peut aussi appeler une fonction)
	-- ~~store the~~ timer id ~~in a table, using the player as index~~		-- stockage du timer dans un tableau d'id en utilisant le joueur comme ordre de rangement
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")		colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
	end		end
Line 157:		Line 157:
	-- ajout d'un message de debugage avec le type de l'élément		-- ajout d'un message de debugage avec le type de l'élément
	outputDebugString("colShapeLeave "..getElementType(player))		outputDebugString("colShapeLeave "..getElementType(player))
	-- ~~kill the~~ timer ~~when the player leaves the~~ colshape		-- arrête le timer quand le joueur quitte le colshape
	killTimer(colshapeTimer[player])		killTimer(colshapeTimer[player])
	end		end

V1ncenzo: /* Une erreur un peu plus complexe */

2014-07-08T21:06:25Z

Une erreur un peu plus complexe

← Older revision		Revision as of 21:06, 8 July 2014
Line 125:		Line 125:
	-- ajout d'un message de debugage		-- ajout d'un message de debugage
	outputDebugString("colShapeHit")		outputDebugString("colShapeHit")
	-- ~~set a~~ timer ~~to output a~~ message (~~could as well execute another function~~)		-- ajout d'un timer pour afficher un message (peut aussi appeler une fonction)
	-- ~~store the~~ timer id ~~in a table, using the player as index~~		-- stockage du timer dans un tableau d'id en utilisant le joueur comme ordre de rangement
	colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")		colshapeTimer[player] = setTimer(outputChatBox,10000,1,"The player stayed 10 seconds in the colshape!")
	end		end
Line 134:		Line 134:
	-- ajout d'un message de debugage		-- ajout d'un message de debugage
	outputDebugString("colShapeLeave")		outputDebugString("colShapeLeave")
	-- ~~kill the~~ timer ~~when the player leaves the~~ colshape		-- arrête le timer quand le joueur quitte le colshape
	killTimer(colshapeTimer[player])		killTimer(colshapeTimer[player])
	end		end

V1ncenzo: /* Une erreur un peu plus complexe */

2014-07-08T21:02:25Z

Une erreur un peu plus complexe

← Older revision		Revision as of 21:02, 8 July 2014
Line 116:		Line 116:

	===Une erreur un peu plus complexe===		===Une erreur un peu plus complexe===
	Cependant, pour une quelconque raison le message est envoyé deux fois quand on reste dans le cercle de collision alors qu'on est dans un véhicule~~. Since it would appear some code is executed twice, we add debug messages to check this~~.Puisque c'est le cas on conclu qu'un code est exécuté deux fois, on va déboguer pour vérifier cela.		Cependant, pour une quelconque raison le message est envoyé deux fois quand on reste dans le cercle de collision alors qu'on est dans un véhicule. Puisque c'est le cas on conclu qu'un code est exécuté deux fois, on va déboguer pour vérifier cela.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">

V1ncenzo: /* Une erreur un peu plus complexe */

2014-07-08T21:01:56Z

Une erreur un peu plus complexe

← Older revision		Revision as of 21:01, 8 July 2014
Line 116:		Line 116:

	===Une erreur un peu plus complexe===		===Une erreur un peu plus complexe===
	Cependant, pour une quelconque raison le message est envoyé deux fois quand on reste dans le cercle de collision alors qu'on est dans un véhicule. Since it would appear some code is executed twice, we add debug messages to check this.		Cependant, pour une quelconque raison le message est envoyé deux fois quand on reste dans le cercle de collision alors qu'on est dans un véhicule. Since it would appear some code is executed twice, we add debug messages to check this.Puisque c'est le cas on conclu qu'un code est exécuté deux fois, on va déboguer pour vérifier cela.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 227:		Line 227:
	addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)		addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
	</syntaxhighlight>		</syntaxhighlight>


	==Debugging Performance Issues==		==Debugging Performance Issues==

V1ncenzo: /* Astuces de déboguage */

2014-07-08T20:57:24Z

Astuces de déboguage

← Older revision		Revision as of 20:57, 8 July 2014
Line 43:		Line 43:
	All debug messages will be appended to the specified file from now on. To turn logging off, replace that line with an empty tag again.		All debug messages will be appended to the specified file from now on. To turn logging off, replace that line with an empty tag again.

	==~~Debug strategies~~==		==Astuces de déboguage==
	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.
	Au lieu de foncer tête baisser dans votre code, il existe d'autres stratégies pour débusquer les erreurs. La plupart d'entres elles utilisent des messages/sorties (au niveau de la console) de ~~déboggage~~ qui sont différent suivant les situations.		Au lieu de foncer tête baisser dans votre code, il existe d'autres stratégies pour débusquer les erreurs. La plupart d'entres elles utilisent des messages/sorties (au niveau de la console) de déboguage qui sont différent suivant les situations.

	===Fonctions Utiles===		===Fonctions Utiles===

V1ncenzo: /* Astuces de Déboggage */

2014-07-08T20:55:59Z

Astuces de Déboggage

← Older revision		Revision as of 20:55, 8 July 2014
Line 45:		Line 45:
	==Debug strategies==		==Debug strategies==
	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.		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.
			Au lieu de foncer tête baisser dans votre code, il existe d'autres stratégies pour débusquer les erreurs. La plupart d'entres elles utilisent des messages/sorties (au niveau de la console) de déboggage qui sont différent suivant les situations.

	===Fonctions Utiles===		===Fonctions Utiles===

Vincenzo: /* Debugging Performance Issues */

2013-04-18T15:57:25Z

Debugging Performance Issues

← Older revision		Revision as of 15:57, 18 April 2013
Line 230:		Line 230:
	==Debugging Performance Issues==		==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 cause using a great tool that comes with MTA SA server~~, performancebrowser. ~~Make sure that its started with~~ "start performancebrowser" ~~if it doesn~~'~~t exist then get it from the default resources that come with the server~~. ~~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~~ -d ~~option in Lua timing you can see which functions are using up the~~ CPU.		Si vous serveur utilise plus de ressource qu'il ne devrait ou si vous voulez vous assurez que votre code est efficace, vous pourrez trouver les brebis galeuses avec l'outil ''performancebrowser''. Pour le lancer taper dans votre console "start performancebrowser" si cette ressource n'exite pas assurer de bien la posséder à l'emplacement adequat. Cet outil fourni un bon nombre d'information sur le debugage de perfomance. Fuite de mémoire, perte d'éléments et utilisation intensive du CPU sont facilement décelable via cet outil. Si vous utilisez l'option -d vous pourrez voir quelles fonctions utilisent de manière excéssive le 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~~ "general.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~~.		Pour accèder au ''performancebrowser'' vous devez entrer cette adresse dans votre navigateur de recherche: http://serverIPHere:serverHTTPPortHere/performancebrowser/ Noterque le / à la fin est obligatoire. Donc par exemple: http://127.0.0.1:22005/performancebrowser/ . Ensuite, vous devez vous logguer en jeu avec un compte administrateur ou un compte ayant accès à la ressource "general.HTTP" . La plupart des informations dont vous aurez besoin se trouvent dans les catégories "Lua timing" et "Lua memory". Chercher les valeurs qui sont plus élevées que les autres.

	===Exemples de code qui posent des problèmes de performances===		===Exemples de code qui posent des problèmes de performances===

	~~Adding data to a table but never removing it. This would take months/years before it causes a problem though~~.		L'ajout de données à un tableau sans les supprimer ensuite, même si ça prendra quelques mois ou années avant de poser des problèmes.
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	local someData = {}		local someData = {}
Line 242:		Line 242:
	function storeData()		function storeData()
	someData[source] = true		someData[source] = true
	-- ~~There is no handling for when a player quits~~, ~~this is considered a memory leak~~		-- Rien ne gère le moment ou le joueur quitte le jeu, c'est donc considéré comme une perte de mémoire.
	-- Using the Lua timing tab you can detect the RAM usage of each resource.		-- Using the Lua timing tab you can detect the RAM usage of each resource.
	end		end

Vincenzo at 15:33, 18 April 2013

2013-04-18T15:33:16Z

← Older revision		Revision as of 15:33, 18 April 2013
Line 112:		Line 112:
	{{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~~.		À part ceci (nous en parlerons plus tard) tous semble bien fonctionner. Un joueur entre dans le ''colshape'', le timer se lance, si il reste un message s'affiche, si il quitte le ''colshape'' le timer est arrêté.

	===~~A more inconspicuous error~~===		===Une erreur un peu plus complexe===
	~~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.		Cependant, pour une quelconque raison le message est envoyé deux fois quand on reste dans le cercle de collision alors qu'on est dans un véhicule. Since it would appear some code is executed twice, we add debug messages to check this.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 122:		Line 122:
	colshapeTimer = {}		colshapeTimer = {}
	end		end
	-- ~~add a debug~~ message		-- ajout d'un message de debugage
	outputDebugString("colShapeHit")		outputDebugString("colShapeHit")
	-- set a timer to output a message (could as well execute another function)		-- set a timer to output a message (could as well execute another function)
Line 131:		Line 131:

	function colShapeLeave(player)		function colShapeLeave(player)
	-- ~~add a debug~~ message		-- ajout d'un message de debugage
	outputDebugString("colShapeLeave")		outputDebugString("colShapeLeave")
	-- kill the timer when the player leaves the colshape		-- kill the timer when the player leaves the colshape
Line 138:		Line 138:
	addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)		addEventHandler("onColShapeLeave",getRootElement(),colShapeLeave)
	</syntaxhighlight>		</syntaxhighlight>
			Nous remarquons que les deux fonctions rattachées aux événements sont éxécutées deux fois, mais seulement une lorsque qu'on est à pied. On peut donc penser que le véhicule déclenche aussi les événements. Pour confirmer cette théorie , nous allons vérifier la variable ''player'' qui '''devrait''' contenir un ''élément joueur''.
	~~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~~.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 146:		Line 145:
	colshapeTimer = {}		colshapeTimer = {}
	end		end
	-- ~~add a debug~~ message~~, with the element~~ type		-- ajout d'un message de debugage avec le type de l'élément
	outputDebugString("colShapeHit "..getElementType(player))		outputDebugString("colShapeHit "..getElementType(player))
	-- set a timer to output a message (could as well execute another function)		-- set a timer to output a message (could as well execute another function)
Line 155:		Line 154:

	function colShapeLeave(player)		function colShapeLeave(player)
	-- ~~add a debug~~ message~~, with the element~~ type		-- ajout d'un message de debugage avec le type de l'élément
	outputDebugString("colShapeLeave "..getElementType(player))		outputDebugString("colShapeLeave "..getElementType(player))
	-- kill the timer when the player leaves the colshape		-- kill the timer when the player leaves the colshape
Line 163:		Line 162:
	</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~~.		Le message de débugage nous informe que, l'une des variables ''player'' est un joueur, et que l'autre, est un véhicule. Si nous voulons éxecuter notre code seulement quand un joueur entre dans le ''colshape'', nous devons rajouter un ''if'' (condition) qui stoppera l'éxecution du code si ce n'est pas un joueur.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
Line 191:		Line 190:
	</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 to use~~ [[isTimer]]~~, which we will use when we kill the~~ timer:		Maintenant le code devrait fonctionner comme nous le souhaitions, mais nous avons toujours l'avertissement mentionné plus tôt. Cela est dû au fait que nous essayons d'arrêter un timer qui , quand le joueur est resté dans le colshape 10 secondes est éxecuté, n'existe plus. Il y a différentes façons de se débarasser de cet avertissement (si on part du principe qu'on sait qu'il n'existe plus à partir d'un certain moment et qu'on peut l'arrêter seulement si il ne s'est pas éxecuté).
			Une des méthodes serait de vérifier si le timer stocker dans le tableau existe. Pour faire cela, nous devons utiliser [[isTimer]] avant d'arrêter le timer.

	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	if (isTimer(colshapeTimer[player])) then		if (isTimer(colshapeTimer[player])) then
Line 197:		Line 198:
	end		end
	</syntaxhighlight>		</syntaxhighlight>
			Le code final ressemblerait à ceci:
	~~So the complete working~~ code ~~would be~~:
	<syntaxhighlight lang="lua">		<syntaxhighlight lang="lua">
	function colShapeHit(player)		function colShapeHit(player)
Line 234:		Line 234:
	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 "general.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.		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 "general.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~~===		===Exemples de code qui posent des problèmes de performances===

	Adding data to a table but never removing it. This would take months/years before it causes a problem though.		Adding data to a table but never removing it. This would take months/years before it causes a problem though.