Client Load Progress

From HEWIKI
Jump to: navigation, search

New functionality is provided in HeroEngine 1.44.0.4400 that provides the Player Client executable feedback during the load progress:

PROGRESS CALLBACK

The progress callback provides information regarding the initial load (of the splash screen, of client.gom, of the scripts.list file), as well as the progress of loading each area.

The data provided is in the form of a string:

DONE
The most recent area has completed loading
Initial Load,3,1
The initial load process, with 3 total steps, and on the first step
Loading Area,11,1
The loading of an area, with 11 current total steps and on the first step.


Note that the "current total steps" increases as .DAT files are loaded and the number of additional files continues to grow.

FILE REQUEST & RESPONSE CALLBACK

The file requests and response callbacks detailed information about each file requested from the local repository cache (and the remote server, if it was unavailable from the local cache).

FILE REQUEST: data is provided in the form of a comma-delimited string:

$SOURCE_LINE,$REQUEST_TYPE,$FQN
$SOURCE_LINE - is useful for source code customers, and should not be relied upon by customer implementations
$REQUEST_TYPE is one of:
GET - asynchronous get
CACHE - used to assure that the resource is in the local repository cache sometime in the future
SYNCGET - the "wait for it" get, this is generally a blocking call
SETONDEMAND - Setting up LOADONDEMAND for future success. Initiates download of current revision from the server, if not available in the local repository cache.
LOADONDEMAND - An immediate retrieval of data, usually Script Code.
$FQN - the fully qualified name of the resource being retrieved


FILE RESPONSE - data is provided in the form of a string:

$SOURCE_LINE,$FQN,$HEX_CODE,$RESULT
$SOURCE_LINE - is useful for source code customers, and should not be relied upon by customer implementations
$FQN - the fully qualified name of the resource being retrieved
$HEX_CODE - the FSRESULT returned, of use only to source code customers
$RESULT - the resulting short code
NOTFOUND - File does not exist in the repository or not available when requested via SYNCGET
SUCCESS - File successfully retrieved
CHANGED - Resource update notification
FAILED - There was an error while attempting to retrieve the file
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox