EngineErrorCodes.wiki
author nemo
Wed, 12 Dec 2018 15:23:51 -0500
changeset 1682 22a1cfe0eaf3
parent 1483 26ce5d1ea7c1
child 1873 0b0c0a66ebf7
permissions -rw-r--r--
another regex
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1469
2bec529b425b EngineErrorCodes: more headers
Wuzzy
parents: 1468
diff changeset
     1
#summary Description and list of engine error codes
1467
d1e1cd742563 EngineErrorCodes: Add empty line
Wuzzy
parents: 1465
diff changeset
     2
1469
2bec529b425b EngineErrorCodes: more headers
Wuzzy
parents: 1468
diff changeset
     3
= Engine error codes =
2bec529b425b EngineErrorCodes: more headers
Wuzzy
parents: 1468
diff changeset
     4
When the Hedgewars engine (`hwengine`) crashes or is closed, it returns an exit code (or error code) which can be used to further analyze the problem.
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     5
1469
2bec529b425b EngineErrorCodes: more headers
Wuzzy
parents: 1468
diff changeset
     6
== List of engine error codes ==
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     7
This is the list of all possible error codes:
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     8
1468
cb87eed7b3d9 EngineErrorCodes: Bold text for headers
Wuzzy
parents: 1467
diff changeset
     9
|| *Exit code* || *Meaning* || *Description* || *Solution* ||
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
|| 0 || No error || Engine exited normally || N/A ||
1471
69fb97fee814 EngineErrorCodes: fix typo 2
Wuzzy
parents: 1470
diff changeset
    11
|| 51 || Usage error || The engine was launched with invalid command line arguments || Check your command-line arguments. Type `hwengine --help` in a command line for help ||
1482
3587d7d6ed1d EngineErrorCodes: shorten error 52 desc
Wuzzy
parents: 1481
diff changeset
    12
|| 52 || Fatal error || Generic error for critical errors at runtime || Check the error message or the end of `Logs/game0.log` in your [http://hedgewars.org/wiki/User_directory user directory] for clues ||
1472
55cfbaec4484 EngineErrorCodes: error 53
Wuzzy
parents: 1471
diff changeset
    13
|| 53 || Startup error || Failure while initializing stuff on startup, like graphics, shader, OpenGL stuff, etc. || Check your [Dependencies dependencies] and if you have the latest video drivers installed and update them as needed ||
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    14
|| 54 || Fatal error, no IPC socket || Similar to error 52, but the IPC socket is not working for some reason || Check the end of `Logs/game0.log` in your [http://hedgewars.org/wiki/User_directory user directory] for clues ||
1483
26ce5d1ea7c1 EngineErrorCodes: clarify error 55
Wuzzy
parents: 1482
diff changeset
    15
|| 55 || Video encoding error || Error while a video recording is being encoded, might be an initialization or file access error || Check the end of `Logs/rec0.log` in your [http://hedgewars.org/wiki/User_directory user directory] for more information ||
1473
d4847497949d EngineErrorCodes: problem in yuor system
Wuzzy
parents: 1472
diff changeset
    16
|| Other || Free Pascal run-time error, see [https://www.freepascal.org/docs-html/user/userap4.html here] || This is probably a bug. Or it might be a problem in your system. || If you believe this is a bug, [http://www.hedgewars.org/bugs report a bug], then someone should fix it ||
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    17
1469
2bec529b425b EngineErrorCodes: more headers
Wuzzy
parents: 1468
diff changeset
    18
== Error codes when performing engine test cases ==
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    19
When the engine is used to perform [EngineTestCases test cases], the follwing additional codes are used:
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    20
1468
cb87eed7b3d9 EngineErrorCodes: Bold text for headers
Wuzzy
parents: 1467
diff changeset
    21
|| *Exit code* || *Meaning* || *Solution* ||
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    22
|| 0 || Test succeeded || N/A ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    23
|| 60 || Test failed || Fix the engine ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    24
|| 61 || Lua error in test case || Fix the Lua code of the test case ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    25
|| 62 || Unexpected error while testing || Debug ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    26
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    27
= Source code =
1474
b4729a383c9c EngineErrorCodes: fix source link
Wuzzy
parents: 1473
diff changeset
    28
The exit codes are defined in the source code file [https://hg.hedgewars.org/hedgewars/file/tip/hedgewars/uConsts.pas hedgewars/uConsts.pas].