Debugging Techniques - Revision history

Lou Montana: Text replacement - "{{Link|:Category:" to "{{Link|Category:"

2024-10-16T13:51:58Z

Text replacement - "{{Link|:Category:" to "{{Link|Category:"

← Older revision		Revision as of 15:51, 16 October 2024
Line 170:		Line 170:
	=== Code Editing ===		=== Code Editing ===

	See {{Link\|:Category:Community Tools#Code Editing}}.		See {{Link\|Category:Community Tools#Code Editing}}.

	=== Debug Console/System ===		=== Debug Console/System ===

	See {{Link\|:Category:Community Tools#Debug Console/System}}.		See {{Link\|Category:Community Tools#Debug Console/System}}.

	=== SQF and debug Tools ===		=== SQF and debug Tools ===

	See {{Link\|:Category:Community Tools#SQF and debug Tools}}.		See {{Link\|Category:Community Tools#SQF and debug Tools}}.


	[[Category:Scripting Topics]]		[[Category:Scripting Topics]]

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

2024-05-06T09:38:14Z

Text replacement - "[[Arma 3 " to "[[Arma 3: "

← Older revision		Revision as of 11:38, 6 May 2024
Line 43:		Line 43:

	To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem.		To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem.
	* Be sure to use [[Arma 3 Startup Parameters#Developer Options\|{{hl\|-showScriptErrors}} startup parameter]] to display the error on-screen when it happens		* Be sure to use [[Arma 3: Startup Parameters#Developer Options\|{{hl\|-showScriptErrors}} startup parameter]] to display the error on-screen when it happens
	* To learn about the location in your script use [[preprocessFileLineNumbers]] to [[preprocessFile]]		* To learn about the location in your script use [[preprocessFileLineNumbers]] to [[preprocessFile]]
	* Read [[Crash Files\|RPT files]] for more information (make sure [[Arma 3 Startup Parameters#Performance\|{{hl\|-noLogs}} startup parameter]] is '''not''' active - otherwise the log will empty)		* Read [[Crash Files\|RPT files]] for more information (make sure [[Arma 3: Startup Parameters#Performance\|{{hl\|-noLogs}} startup parameter]] is '''not''' active - otherwise the log will empty)
	** Scripts running on a server use the '''Arma''X''Server.RPT''' file which has varying location depending upon the type of server being run.		** Scripts running on a server use the '''Arma''X''Server.RPT''' file which has varying location depending upon the type of server being run.
	** Scripts running on a client use the '''Arma''X''.RPT''' file.		** Scripts running on a client use the '''Arma''X''.RPT''' file.

Lou Montana: Text replacement - "{{Feature|Informative|" to "{{Feature|informative|"

2024-02-01T23:24:28Z

Text replacement - "{{Feature|Informative|" to "{{Feature|informative|"

← Older revision		Revision as of 01:24, 2 February 2024
Line 40:		Line 40:
	Knowing this, you now can proceed to find the actual reason why that specific piece of code errored.		Knowing this, you now can proceed to find the actual reason why that specific piece of code errored.

	{{Feature\|~~Informative~~\|This information can also be found in the [[arma.RPT\|RPT log]].}}		{{Feature\|informative\|This information can also be found in the [[arma.RPT\|RPT log]].}}

	To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem.		To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem.
Line 88:		Line 88:
	The same can be done for non-critical errors like when a method is "just" computing the wrong values.		The same can be done for non-critical errors like when a method is "just" computing the wrong values.

	{{Feature\|~~Informative~~\|		{{Feature\|informative\|
	If you're having great difficulty solving a problem, the good way is to narrow down the issue to the simplest code block possible;		If you're having great difficulty solving a problem, the good way is to narrow down the issue to the simplest code block possible;
	or take the mission part that doesn't work, paste it into a new test mission and go from here.		or take the mission part that doesn't work, paste it into a new test mission and go from here.

Lou Montana: Fix link

2023-06-19T21:36:56Z

Fix link

← Older revision		Revision as of 23:36, 19 June 2023
Line 168:		Line 168:
	== Debugging Tools ==		== Debugging Tools ==

	=== Code ~~Edition~~ ===		=== Code Editing ===

	See {{Link\|:Category:Community Tools#Code ~~Edition~~}}.		See {{Link\|:Category:Community Tools#Code Editing}}.

	=== Debug Console/System ===		=== Debug Console/System ===

Lou Montana: Text replacement - "`" to ""`


2023-01-11T10:53:16Z
Text replacement - "<code>" to "<code style="display: block">"

				
				
				
				
				
				← Older revision
				Revision as of 12:53, 11 January 2023
				
Line 62:
Line 62:
|- |-
| {{GVI|arma3|1.00}} {{arma3}} | {{GVI|arma3|1.00}} {{arma3}}
| <code>'''%localappdata%'''\Arma 3</code> | <code style="display: block">'''%localappdata%'''\Arma 3</code>
| <code>Arma3_x64_yyyy-mm-dd_hh-mm-ss.rpt</code> | <code style="display: block">Arma3_x64_yyyy-mm-dd_hh-mm-ss.rpt</code>
|- |-
| {{GVI|arma2|1.00}} {{arma2}} | {{GVI|arma2|1.00}} {{arma2}}
| <code>'''%localappdata%'''\Arma 2</code> | <code style="display: block">'''%localappdata%'''\Arma 2</code>
| <code>arma2.rpt</code> | <code style="display: block">arma2.rpt</code>
|- |-
| {{GVI|arma1|1.00}} {{arma1}} | {{GVI|arma1|1.00}} {{arma1}}
| <code>'''%localappdata%'''\ArmA</code> | <code style="display: block">'''%localappdata%'''\ArmA</code>
| <code>arma.rpt</code> | <code style="display: block">arma.rpt</code>
|- |-
| {{GVI|ofp|1.00}} {{ofp}} | {{GVI|ofp|1.00}} {{ofp}}
| <code>'''''OFP root directory'''''</code> | <code style="display: block">'''''OFP root directory'''''</code>
| <code>flashpoint.rpt<br>context.bin</code> | <code style="display: block">flashpoint.rpt<br>context.bin</code>
|} |}



Lou Montana: Some wiki formatting
2022-07-25T12:26:48Z
Some wiki formatting

				
				
				
				
				
				← Older revision
				Revision as of 14:26, 25 July 2022
				
Line 37:
Line 37:
[[File:A3_ScriptErrorMsg.jpg|thumb|Script error message|center|500px]] [[File:A3_ScriptErrorMsg.jpg|thumb|Script error message|center|500px]]



It tells you what went wrong, shows a snippet of the code that failed and what file and line it occurred in (unless you used a command combination like eg. {{ic|[[compile]] [[loadFile]]}}). It tells you what went wrong, shows a snippet of the code that failed and what file and line it occurred in (unless you used a command combination like eg. <sqf inline>compile loadFile "filename";</sqf>).
Knowing this, you now can proceed to find the actual reason why that specific piece of code errored. Knowing this, you now can proceed to find the actual reason why that specific piece of code errored.



Line 104:
Line 104:
| |
* in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them. * in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them.
* a variable may have been ''undefined'' ({{ic|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it. * a variable may have been ''undefined'' (<sqf inline>_varName = nil;</sqf>). Unset it obviously ''after'' you are done using it.
|- |-
| {{hl|Error x elements provided, y is expected}} | {{hl|Error x elements provided, y is expected}}



Lou Montana: Some wiki formatting
2022-07-21T22:15:35Z
Some wiki formatting

				
				
				
				
				
				← Older revision
				Revision as of 00:15, 22 July 2022
				
Line 95:
Line 95:
==== Common errors ==== ==== Common errors ====
{| class="wikitable" {| class="wikitable"
!Error message ! Error message
!Cause ! Cause
!Solution ! Solution
|- |-
|{{hl|Error Undefined variable in expression: _varName}} | {{hl|Error Undefined variable in expression: _varName}}
|variable ''_varName'' has not been initialised properly in this context. | Variable ''_varName'' has not been initialised properly in this context.
<code>[[hint]] _nonExistentVar;</code> <sqf>hint _nonExistentVar;</sqf>
| |
* in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them. * in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them.
* a variable may have been ''undefined'' ({{ic|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it. * a variable may have been ''undefined'' ({{ic|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it.
|- |-
|{{hl|Error x elements provided, y is expected}} | {{hl|Error x elements provided, y is expected}}
|A wrong number of arguments in array was provided | A wrong number of arguments in array was provided
<code>_unit [[setPos]] [0]; {{cc|[[setPos]] only takes an array of 2 to 3 elements}}</code> <sqf>_unit setPos [0]; // setPos only takes an array of 2 to 3 elements</sqf>
|rowspan="2" align="center"|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page. |rowspan="2" align="center"|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page.
|- |-
|{{hl|Error type x, expected y}} | {{hl|Error type x, expected y}}
|An ill-typed argument was provided. | An ill-typed argument was provided.
<code>[[hint]] 5; {{cc|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code> <sqf>hint 5; // must be String or Structured Text, Number provided</sqf>
|- |-
|rowspan="2"|{{hl|Error Zero divisor}} | rowspan="2" | {{hl|Error Zero divisor}}
|Pretty self-explanatory, somewhere in the code is a division by zero. | Pretty self-explanatory, somewhere in the code is a division by zero.
<code>[[private]] _number = 0; <sqf>
[[private]] _result = 100/_number;</code> private _number = 0;
private _result = 100/_number;
</sqf>
| |
* Make sure to check that your divisor is different from zero before dividing. * Make sure to check that your divisor is different from zero before dividing.
<code>[[private]] _result = [100, 100/_number] [[select]] (_number != 0);</code> <sqf>private _result = if (_number != 0) then { 100 / _number } else { 100 };</sqf>
|- |-
|Also happens when using an invalid [[select]] index. | Also happens when using an invalid [[select]] index.
<code>["a","b","c"] [[select]] 20; {{cc|index can only be 0, 1 or 2}}</code> <sqf>["a", "b", "c"] select 20; // index can only be 0, 1 or 2</sqf>
| |
* Ensure your [[select]] happens within the array boundaries. * Ensure your [[select]] happens within the array boundaries.
* use [[selectRandom]] to pick a random item in an array. * Use [[selectRandom]] to pick a random item in an array.
|- |-
|{{hl|Local variable in global space}} | {{hl|Local variable in global space}}
|An attempt to [[private]] a public variable happened | An attempt to [[private]] a public variable happened
<code>[[private]] "myVar"; {{cc|should be "_myVar"}}</code> <sqf>private "myVar"; // should be "_myVar"</sqf>
| |
* Replace public variable usage with private variables. * Replace public variable usage with private variables.
|- |-
|rowspan="2"|{{hl|Error Generic error in expression}} | rowspan="2" | {{hl|Error Generic error in expression}}
|A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment|unscheduled environment]]. | A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment|unscheduled environment]].
<code>[[player]] [[addEventHandler]] ["Fired", { [[sleep]] 1; [[hint]] "bang"; }];</code> <sqf>player addEventHandler ["Fired", { sleep 1; hint "bang"; }];</sqf>
| |
* Do '''not''' use such suspending commands in unscheduled environment. * Do '''not''' use such suspending commands in unscheduled environment.
* For an '''FSM''' condition, a common workaround would be: * For an '''FSM''' condition, a common workaround would be:
<code>[[private]] _t = [[time]] + 5; {{cc|Code - having to wait for 5 seconds}}</code> <sqf>private _t = time + 5; // code - having to wait for 5 seconds</sqf>
<code>[[time]] > _t {{cc|Condition}}</code> <sqf>time > _t // condition</sqf>
* [[spawn]] code: * [[spawn]] code: <sqf>player addEventHandler ["Fired", { 0 spawn { sleep 1; hint "bang"; }; }];</sqf>
<code>[[player]] [[addEventHandler]] ["Fired", { [] [[spawn]] { [[sleep]] 1; [[hint]] "bang"; }; }];</code> 
|- |-
|Further code reading is required. | Further code reading is required.
| |
* cut your code in smaller pieces and locate the concerned line(s). * Cut your code in smaller pieces and locate the concerned line(s).
|} |}



Line 169:
Line 170:
=== Code Edition === === Code Edition ===



See [[:Category:Community Tools#Code Edition|Community Tools - Code Edition]]. See {{Link|:Category:Community Tools#Code Edition}}.



=== Debug Console/System === === Debug Console/System ===



See [[:Category:Community Tools#Debug Console/System|Community Tools - Debug Console/System]]. See {{Link|:Category:Community Tools#Debug Console/System}}.



=== SQF and debug Tools === === SQF and debug Tools ===



See [[:Category:Community Tools#SQF and debug Tools|Community Tools - SQF and debug Tools]]. See {{Link|:Category:Community Tools#SQF and debug Tools}}.
 



[[Category:Scripting Topics]] [[Category:Scripting Topics]]



Lou Montana: Text replacement - "([^=
]+)<\/tt>" to "{{hl|$1}}"

2021-11-15T23:16:23Z
Text replacement - "<tt>([^= ]+)<\/tt>" to "{{hl|$1}}"

				
				
				
				
				
				← Older revision
				Revision as of 01:16, 16 November 2021
				
Line 99:
Line 99:
!Solution !Solution
|- |-
|<tt>Error Undefined variable in expression: _varName</tt> |{{hl|Error Undefined variable in expression: _varName}}
|variable ''_varName'' has not been initialised properly in this context. |variable ''_varName'' has not been initialised properly in this context.
<code>[[hint]] _nonExistentVar;</code> <code>[[hint]] _nonExistentVar;</code>
Line 106:
Line 106:
* a variable may have been ''undefined'' ({{ic|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it. * a variable may have been ''undefined'' ({{ic|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it.
|- |-
|<tt>Error x elements provided, y is expected</tt> |{{hl|Error x elements provided, y is expected}}
|A wrong number of arguments in array was provided |A wrong number of arguments in array was provided
<code>_unit [[setPos]] [0]; {{cc|[[setPos]] only takes an array of 2 to 3 elements}}</code> <code>_unit [[setPos]] [0]; {{cc|[[setPos]] only takes an array of 2 to 3 elements}}</code>
|rowspan="2" align="center"|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page. |rowspan="2" align="center"|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page.
|- |-
|<tt>Error type x, expected y</tt> |{{hl|Error type x, expected y}}
|An ill-typed argument was provided. |An ill-typed argument was provided.
<code>[[hint]] 5; {{cc|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code> <code>[[hint]] 5; {{cc|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code>



Lou Montana: Text replacement - "([a-zA-Z0-9\. _"\\'=-]+)<\/tt>" to "{{hl|$1}}"

2021-11-15T22:56:58Z
Text replacement - "<tt>([a-zA-Z0-9\. _"\\'=-]+)<\/tt>" to "{{hl|$1}}"

				
				
				
				
				
				← Older revision
				Revision as of 00:56, 16 November 2021
				
Line 43:
Line 43:



To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem. To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem.
* Be sure to use [[Arma 3 Startup Parameters#Developer Options|<tt>-showScriptErrors</tt>&nbsp;startup&nbsp;parameter]] to display the error on-screen when it happens * Be sure to use [[Arma 3 Startup Parameters#Developer Options|{{hl|-showScriptErrors}}&nbsp;startup&nbsp;parameter]] to display the error on-screen when it happens
* To learn about the location in your script use [[preprocessFileLineNumbers]] to [[preprocessFile]] * To learn about the location in your script use [[preprocessFileLineNumbers]] to [[preprocessFile]]
* Read [[Crash Files|RPT files]] for more information (make sure [[Arma 3 Startup Parameters#Performance|<tt>-noLogs</tt> startup parameter]] is '''not''' active - otherwise the log will empty) * Read [[Crash Files|RPT files]] for more information (make sure [[Arma 3 Startup Parameters#Performance|{{hl|-noLogs}} startup parameter]] is '''not''' active - otherwise the log will empty)
** Scripts running on a server use the '''Arma''X''Server.RPT''' file which has varying location depending upon the type of server being run. ** Scripts running on a server use the '''Arma''X''Server.RPT''' file which has varying location depending upon the type of server being run.
** Scripts running on a client use the '''Arma''X''.RPT''' file. ** Scripts running on a client use the '''Arma''X''.RPT''' file.



Lou Montana: Text replacement - "([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"

2021-11-15T22:55:20Z
Text replacement - "<tt>([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"

				
				
				
				
				
				← Older revision
				Revision as of 00:55, 16 November 2021
				
Line 115:
Line 115:
<code>[[hint]] 5; {{cc|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code> <code>[[hint]] 5; {{cc|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code>
|- |-
|rowspan="2"|<tt>Error Zero divisor</tt> |rowspan="2"|{{hl|Error Zero divisor}}
|Pretty self-explanatory, somewhere in the code is a division by zero. |Pretty self-explanatory, somewhere in the code is a division by zero.
<code>[[private]] _number = 0; <code>[[private]] _number = 0;
Line 129:
Line 129:
* use [[selectRandom]] to pick a random item in an array. * use [[selectRandom]] to pick a random item in an array.
|- |-
|<tt>Local variable in global space</tt> |{{hl|Local variable in global space}}
|An attempt to [[private]] a public variable happened |An attempt to [[private]] a public variable happened
<code>[[private]] "myVar"; {{cc|should be "_myVar"}}</code> <code>[[private]] "myVar"; {{cc|should be "_myVar"}}</code>
Line 135:
Line 135:
* Replace public variable usage with private variables. * Replace public variable usage with private variables.
|- |-
|rowspan="2"|<tt>Error Generic error in expression</tt> |rowspan="2"|{{hl|Error Generic error in expression}}
|A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment|unscheduled environment]]. |A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment|unscheduled environment]].
<code>[[player]] [[addEventHandler]] ["Fired", { [[sleep]] 1; [[hint]] "bang"; }];</code> <code>[[player]] [[addEventHandler]] ["Fired", { [[sleep]] 1; [[hint]] "bang"; }];</code>

Debugging Techniques - Revision history

Lou Montana: Text replacement - "{{Link|:Category:" to "{{Link|Category:"

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

Lou Montana: Text replacement - "{{Feature|Informative|" to "{{Feature|informative|"

Lou Montana: Fix link

Lou Montana: Text replacement - "`" to ""`

Lou Montana: Some wiki formatting

Lou Montana: Some wiki formatting

Lou Montana: Text replacement - "`([^= ]+)<\/tt>" to "{{hl|$1}}"`

Lou Montana: Text replacement - "`([a-zA-Z0-9\. _"\\'=-]+)<\/tt>" to "{{hl|$1}}"`

Lou Montana: Text replacement - "`([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"`

← Older revision		Revision as of 12:53, 11 January 2023
Line 62:		Line 62:
	\|-		\|-
	\| {{GVI\|arma3\|1.00}} {{arma3}}		\| {{GVI\|arma3\|1.00}} {{arma3}}
	\| <code>'''%localappdata%'''\Arma 3</code>		\| <code style="display: block">'''%localappdata%'''\Arma 3</code>
	\| <code>Arma3_x64_yyyy-mm-dd_hh-mm-ss.rpt</code>		\| <code style="display: block">Arma3_x64_yyyy-mm-dd_hh-mm-ss.rpt</code>
	\|-		\|-
	\| {{GVI\|arma2\|1.00}} {{arma2}}		\| {{GVI\|arma2\|1.00}} {{arma2}}
	\| <code>'''%localappdata%'''\Arma 2</code>		\| <code style="display: block">'''%localappdata%'''\Arma 2</code>
	\| <code>arma2.rpt</code>		\| <code style="display: block">arma2.rpt</code>
	\|-		\|-
	\| {{GVI\|arma1\|1.00}} {{arma1}}		\| {{GVI\|arma1\|1.00}} {{arma1}}
	\| <code>'''%localappdata%'''\ArmA</code>		\| <code style="display: block">'''%localappdata%'''\ArmA</code>
	\| <code>arma.rpt</code>		\| <code style="display: block">arma.rpt</code>
	\|-		\|-
	\| {{GVI\|ofp\|1.00}} {{ofp}}		\| {{GVI\|ofp\|1.00}} {{ofp}}
	\| <code>'''''OFP root directory'''''</code>		\| <code style="display: block">'''''OFP root directory'''''</code>
	\| <code>flashpoint.rpt<br>context.bin</code>		\| <code style="display: block">flashpoint.rpt<br>context.bin</code>
	\|}		\|}

← Older revision		Revision as of 14:26, 25 July 2022
Line 37:		Line 37:
	[[File:A3_ScriptErrorMsg.jpg\|thumb\|Script error message\|center\|500px]]		[[File:A3_ScriptErrorMsg.jpg\|thumb\|Script error message\|center\|500px]]

	It tells you what went wrong, shows a snippet of the code that failed and what file and line it occurred in (unless you used a command combination like eg. ~~{{ic\|[[~~compile~~]] [[~~loadFile~~]]}}~~).		It tells you what went wrong, shows a snippet of the code that failed and what file and line it occurred in (unless you used a command combination like eg. <sqf inline>compile loadFile "filename";</sqf>).
	Knowing this, you now can proceed to find the actual reason why that specific piece of code errored.		Knowing this, you now can proceed to find the actual reason why that specific piece of code errored.

Line 104:		Line 104:
	\|		\|
	* in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them.		* in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them.
	* a variable may have been ''undefined'' (~~{{ic\|~~_varName {{=~~}} [[~~nil~~]]}}~~). Unset it ''after'' you are done using it.		* a variable may have been ''undefined'' (<sqf inline>_varName = nil;</sqf>). Unset it obviously ''after'' you are done using it.
	\|-		\|-
	\| {{hl\|Error x elements provided, y is expected}}		\| {{hl\|Error x elements provided, y is expected}}

← Older revision		Revision as of 00:15, 22 July 2022
Line 95:		Line 95:
	==== Common errors ====		==== Common errors ====
	{\| class="wikitable"		{\| class="wikitable"
	!Error message		! Error message
	!Cause		! Cause
	!Solution		! Solution
	\|-		\|-
	\|{{hl\|Error Undefined variable in expression: _varName}}		\| {{hl\|Error Undefined variable in expression: _varName}}
	\|~~variable~~ ''_varName'' has not been initialised properly in this context.		\| Variable ''_varName'' has not been initialised properly in this context.
	<~~code~~>[[hint]] _nonExistentVar;</~~code~~>		<sqf>hint _nonExistentVar;</sqf>
	\|		\|
	* in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them.		* in the case of a [[spawn]]ed code, previous local variables are '''not''' accessible and must be passed as arguments in order to access them.
	* a variable may have been ''undefined'' ({{ic\|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it.		* a variable may have been ''undefined'' ({{ic\|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it.
	\|-		\|-
	\|{{hl\|Error x elements provided, y is expected}}		\| {{hl\|Error x elements provided, y is expected}}
	\|A wrong number of arguments in array was provided		\| A wrong number of arguments in array was provided
	<~~code~~>_unit [[setPos]] [0]; ~~{{cc\|[[~~setPos]] only takes an array of 2 to 3 elements}}</~~code~~>		<sqf>_unit setPos [0]; // setPos only takes an array of 2 to 3 elements</sqf>
	\|rowspan="2" align="center"\|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page.		\|rowspan="2" align="center"\|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page.
	\|-		\|-
	\|{{hl\|Error type x, expected y}}		\| {{hl\|Error type x, expected y}}
	\|An ill-typed argument was provided.		\| An ill-typed argument was provided.
	<~~code~~>[[hint]] 5; ~~{{cc\|~~must be [[String]] or [[Structured Text]], [[Number]] provided}}</~~code~~>		<sqf>hint 5; // must be String or Structured Text, Number provided</sqf>
	\|-		\|-
	\|rowspan="2"\|{{hl\|Error Zero divisor}}		\| rowspan="2" \| {{hl\|Error Zero divisor}}
	\|Pretty self-explanatory, somewhere in the code is a division by zero.		\| Pretty self-explanatory, somewhere in the code is a division by zero.
	<~~code~~>[[private]] _number = 0;		<sqf>
	[[private]] _result = 100/_number;</~~code~~>		private _number = 0;
			private _result = 100/_number;
			</sqf>
	\|		\|
	* Make sure to check that your divisor is different from zero before dividing.		* Make sure to check that your divisor is different from zero before dividing.
	<~~code~~>[[private]] _result = ~~[100, 100/_number] [[select]]~~ (_number != 0);</~~code~~>		<sqf>private _result = if (_number != 0) then { 100 / _number } else { 100 };</sqf>
	\|-		\|-
	\|Also happens when using an invalid [[select]] index.		\| Also happens when using an invalid [[select]] index.
	<~~code~~>["a","b","c"] [[select]] 20; ~~{{cc\|~~index can only be 0, 1 or 2}}</~~code~~>		<sqf>["a", "b", "c"] select 20; // index can only be 0, 1 or 2</sqf>
	\|		\|
	* Ensure your [[select]] happens within the array boundaries.		* Ensure your [[select]] happens within the array boundaries.
	* ~~use~~ [[selectRandom]] to pick a random item in an array.		* Use [[selectRandom]] to pick a random item in an array.
	\|-		\|-
	\|{{hl\|Local variable in global space}}		\| {{hl\|Local variable in global space}}
	\|An attempt to [[private]] a public variable happened		\| An attempt to [[private]] a public variable happened
	<~~code~~>[[private]] "myVar"; ~~{{cc\|~~should be "_myVar"}}</~~code~~>		<sqf>private "myVar"; // should be "_myVar"</sqf>
	\|		\|
	* Replace public variable usage with private variables.		* Replace public variable usage with private variables.
	\|-		\|-
	\|rowspan="2"\|{{hl\|Error Generic error in expression}}		\| rowspan="2" \| {{hl\|Error Generic error in expression}}
	\|A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment\|unscheduled environment]].		\| A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment\|unscheduled environment]].
	<~~code~~>[[player~~]] [[~~addEventHandler]] ["Fired", { [[sleep]] 1; [[hint]] "bang"; }];</~~code~~>		<sqf>player addEventHandler ["Fired", { sleep 1; hint "bang"; }];</sqf>
	\|		\|
	* Do '''not''' use such suspending commands in unscheduled environment.		* Do '''not''' use such suspending commands in unscheduled environment.
	* For an '''FSM''' condition, a common workaround would be:		* For an '''FSM''' condition, a common workaround would be:
	<~~code~~>[[private]] _t = [[time]] + 5; ~~{{cc\|Code~~ - having to wait for 5 seconds}}</~~code~~>		<sqf>private _t = time + 5; // code - having to wait for 5 seconds</sqf>
	<~~code~~>[[time]] > _t ~~{{cc\|Condition}}~~</~~code~~>		<sqf>time > _t // condition</sqf>
	* [[spawn]] code:		* [[spawn]] code: <sqf>player addEventHandler ["Fired", { 0 spawn { sleep 1; hint "bang"; }; }];</sqf>
	<~~code~~>[[player~~]] [[~~addEventHandler]] ["Fired", { ~~[] [[~~spawn]] { [[sleep]] 1; [[hint]] "bang"; }; }];</~~code~~>
	\|-		\|-
	\|Further code reading is required.		\| Further code reading is required.
	\|		\|
	* ~~cut~~ your code in smaller pieces and locate the concerned line(s).		* Cut your code in smaller pieces and locate the concerned line(s).
	\|}		\|}

Line 169:		Line 170:
	=== Code Edition ===		=== Code Edition ===

	See [[:Category:Community Tools#Code Edition~~\|Community Tools - Code Edition]]~~.		See {{Link\|:Category:Community Tools#Code Edition}}.

	=== Debug Console/System ===		=== Debug Console/System ===

	See [[:Category:Community Tools#Debug Console/System~~\|Community Tools - Debug Console/System]]~~.		See {{Link\|:Category:Community Tools#Debug Console/System}}.

	=== SQF and debug Tools ===		=== SQF and debug Tools ===

	See [[:Category:Community Tools#SQF and debug Tools~~\|Community Tools - SQF and debug Tools]]~~.		See {{Link\|:Category:Community Tools#SQF and debug Tools}}.


	[[Category:Scripting Topics]]		[[Category:Scripting Topics]]

← Older revision		Revision as of 01:16, 16 November 2021
Line 99:		Line 99:
	!Solution		!Solution
	\|-		\|-
	\|~~<tt>~~Error Undefined variable in expression: _varName~~</tt>~~		\|{{hl\|Error Undefined variable in expression: _varName}}
	\|variable ''_varName'' has not been initialised properly in this context.		\|variable ''_varName'' has not been initialised properly in this context.
	<code>[[hint]] _nonExistentVar;</code>		<code>[[hint]] _nonExistentVar;</code>
Line 106:		Line 106:
	* a variable may have been ''undefined'' ({{ic\|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it.		* a variable may have been ''undefined'' ({{ic\|_varName {{=}} [[nil]]}}). Unset it ''after'' you are done using it.
	\|-		\|-
	\|~~<tt>~~Error x elements provided, y is expected~~</tt>~~		\|{{hl\|Error x elements provided, y is expected}}
	\|A wrong number of arguments in array was provided		\|A wrong number of arguments in array was provided
	<code>_unit [[setPos]] [0]; {{cc\|[[setPos]] only takes an array of 2 to 3 elements}}</code>		<code>_unit [[setPos]] [0]; {{cc\|[[setPos]] only takes an array of 2 to 3 elements}}</code>
	\|rowspan="2" align="center"\|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page.		\|rowspan="2" align="center"\|'''Read the wiki about said command'''.<br><br>Use [[typeName]] to output a variable type and compare it to the command's wiki page.
	\|-		\|-
	\|~~<tt>~~Error type x, expected y~~</tt>~~		\|{{hl\|Error type x, expected y}}
	\|An ill-typed argument was provided.		\|An ill-typed argument was provided.
	<code>[[hint]] 5; {{cc\|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code>		<code>[[hint]] 5; {{cc\|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code>

← Older revision		Revision as of 00:56, 16 November 2021
Line 43:		Line 43:

	To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem.		To solve an issue, you must first to became aware that of it. Aside from your script not having the desired result/effect (if any), an error message can tell you about the problem.
	* Be sure to use [[Arma 3 Startup Parameters#Developer Options\|~~<tt>~~-showScriptErrors~~</tt>~~ startup parameter]] to display the error on-screen when it happens		* Be sure to use [[Arma 3 Startup Parameters#Developer Options\|{{hl\|-showScriptErrors}} startup parameter]] to display the error on-screen when it happens
	* To learn about the location in your script use [[preprocessFileLineNumbers]] to [[preprocessFile]]		* To learn about the location in your script use [[preprocessFileLineNumbers]] to [[preprocessFile]]
	* Read [[Crash Files\|RPT files]] for more information (make sure [[Arma 3 Startup Parameters#Performance\|~~<tt>~~-noLogs~~</tt>~~ startup parameter]] is '''not''' active - otherwise the log will empty)		* Read [[Crash Files\|RPT files]] for more information (make sure [[Arma 3 Startup Parameters#Performance\|{{hl\|-noLogs}} startup parameter]] is '''not''' active - otherwise the log will empty)
	** Scripts running on a server use the '''Arma''X''Server.RPT''' file which has varying location depending upon the type of server being run.		** Scripts running on a server use the '''Arma''X''Server.RPT''' file which has varying location depending upon the type of server being run.
	** Scripts running on a client use the '''Arma''X''.RPT''' file.		** Scripts running on a client use the '''Arma''X''.RPT''' file.

← Older revision		Revision as of 00:55, 16 November 2021
Line 115:		Line 115:
	<code>[[hint]] 5; {{cc\|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code>		<code>[[hint]] 5; {{cc\|must be [[String]] or [[Structured Text]], [[Number]] provided}}</code>
	\|-		\|-
	\|rowspan="2"\|~~<tt>~~Error Zero divisor~~</tt>~~		\|rowspan="2"\|{{hl\|Error Zero divisor}}
	\|Pretty self-explanatory, somewhere in the code is a division by zero.		\|Pretty self-explanatory, somewhere in the code is a division by zero.
	<code>[[private]] _number = 0;		<code>[[private]] _number = 0;
Line 129:		Line 129:
	* use [[selectRandom]] to pick a random item in an array.		* use [[selectRandom]] to pick a random item in an array.
	\|-		\|-
	\|~~<tt>~~Local variable in global space~~</tt>~~		\|{{hl\|Local variable in global space}}
	\|An attempt to [[private]] a public variable happened		\|An attempt to [[private]] a public variable happened
	<code>[[private]] "myVar"; {{cc\|should be "_myVar"}}</code>		<code>[[private]] "myVar"; {{cc\|should be "_myVar"}}</code>
Line 135:		Line 135:
	* Replace public variable usage with private variables.		* Replace public variable usage with private variables.
	\|-		\|-
	\|rowspan="2"\|~~<tt>~~Error Generic error in expression~~</tt>~~		\|rowspan="2"\|{{hl\|Error Generic error in expression}}
	\|A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment\|unscheduled environment]].		\|A [[sleep]]/[[uiSleep]]/[[waitUntil]] command has been used in an [[Scheduler#Unscheduled Environment\|unscheduled environment]].
	<code>[[player]] [[addEventHandler]] ["Fired", { [[sleep]] 1; [[hint]] "bang"; }];</code>		<code>[[player]] [[addEventHandler]] ["Fired", { [[sleep]] 1; [[hint]] "bang"; }];</code>

Debugging Techniques - Revision history

Lou Montana: Text replacement - "{{Link|:Category:" to "{{Link|Category:"

Lou Montana: Text replacement - "[[Arma 3 " to "[[Arma 3: "

Lou Montana: Text replacement - "{{Feature|Informative|" to "{{Feature|informative|"

Lou Montana: Fix link

Lou Montana: Text replacement - "" to ""

Lou Montana: Some wiki formatting

Lou Montana: Some wiki formatting

Lou Montana: Text replacement - "([^= ]+)<\/tt>" to "{{hl|$1}}"

Lou Montana: Text replacement - "([a-zA-Z0-9\. _"\\'=-]+)<\/tt>" to "{{hl|$1}}"

Lou Montana: Text replacement - "([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"

Lou Montana: Text replacement - "`" to ""`

Lou Montana: Text replacement - "`([^= ]+)<\/tt>" to "{{hl|$1}}"`

Lou Montana: Text replacement - "`([a-zA-Z0-9\. _"\\'=-]+)<\/tt>" to "{{hl|$1}}"`

Lou Montana: Text replacement - "`([a-zA-Z0-9\. _"\\']+)<\/tt>" to "{{hl|$1}}"`