EngineErrorCodes.wiki
author Wuzzy
Sun, 15 Jul 2018 16:04:27 +0100
changeset 1467 d1e1cd742563
parent 1465 5cad5459ba1b
child 1468 cb87eed7b3d9
permissions -rw-r--r--
EngineErrorCodes: Add empty line
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     1
#summary List of engine error codes
1467
d1e1cd742563 EngineErrorCodes: Add empty line
Wuzzy
parents: 1465
diff changeset
     2
1465
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     3
When the engine crashes or is closed, it returns an exit code (or error code) which can be used to further analyze the problem.
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     4
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     5
= List of engine error codes =
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     6
This is the list of all possible error codes:
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     7
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     8
|| Exit code || Meaning || Description || Solution ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
     9
|| 0 || No error || Engine exited normally || N/A ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    10
|| 51 || Usage error || The engine was launched with invalid command line arguments || Check your command-line arguments. Use `hwengine --help` for a list ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    11
|| 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
    12
|| 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
    13
|| 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
    14
|| 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
    15
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    16
= Error codes when performing engine test cases =
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    17
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
    18
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    19
|| Exit code || Meaning || Solution ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    20
|| 0 || Test succeeded || N/A ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    21
|| 60 || Test failed || Fix the engine ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    22
|| 61 || Lua error in test case || Fix the Lua code of the test case ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    23
|| 62 || Unexpected error while testing || Debug ||
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    24
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    25
= Source code =
5cad5459ba1b Add EngineErrorCodes
Wuzzy <almikes@aol.com>
parents:
diff changeset
    26
The exit codes are defined in `[https://hg.hedgewars.org/hedgewars/file/tip/hedgewars/uConsts.pas hedgewars/uConsts.pas]`.