EngineErrorCodes.wiki
author Wuzzy
Sun, 15 Jul 2018 16:06:39 +0100
changeset 1470 00be2c8b4d5d
parent 1469 2bec529b425b
child 1471 69fb97fee814
permissions -rw-r--r--
EngineErrorCodes: command line
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 ||
1470
00be2c8b4d5d EngineErrorCodes: command line
Wuzzy
parents: 1469
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 a list ||
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    12
|| 52 || Fatal error || Generic error for critical errors. Commonly happens when a critical file like an image was not found || Check the error message or the end of `Logs/game0.log` in your [http://hedgewars.org/wiki/User_directory user directory] for clues ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    13
|| 53 || Startup error || Failure while initializing stuff on startup, like graphics, shader, OpenGL stuff, etc. || Check your [Dependencies] and if you have the latest drivers installed and update them as needed ||
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 ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    15
|| Other || Free Pascal run-time error. This is probably a bug || See [https://www.freepascal.org/docs-html/user/userap4.html Free Pascal run-time errors] || [http://www.hedgewars.org/bugs Report a bug], then someone should fix it ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    16
1469
2bec529b425b EngineErrorCodes: more headers
Wuzzy
parents: 1468
diff changeset
    17
== Error codes when performing engine test cases ==
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    18
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
    19
1468
cb87eed7b3d9 EngineErrorCodes: Bold text for headers
Wuzzy
parents: 1467
diff changeset
    20
|| *Exit code* || *Meaning* || *Solution* ||
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    21
|| 0 || Test succeeded || N/A ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    22
|| 60 || Test failed || Fix the engine ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    23
|| 61 || Lua error in test case || Fix the Lua code of the test case ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    24
|| 62 || Unexpected error while testing || Debug ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    25
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    26
= Source code =
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    27
The exit codes are defined in `[https://hg.hedgewars.org/hedgewars/file/tip/hedgewars/uConsts.pas hedgewars/uConsts.pas]`.