Client Configuration Values

From HEWIKI
Jump to: navigation, search

He server.png Documentation on this page is intended for customers of HeroEngine managing their own server(s).

This page is about editing client configuration values. For editing server values, see Editing configuration values.

Master Control includes configuration values used for clients that connect to HeroEngine as well as the server process configuration values. These values are sent to the client by the Service Directory, that the client connects to when selecting a world for logging into.

The Master Control Console has an editor for modifying these configurations.

Contents

Opening the Client Configuration Value Editor

First open the configuration value editor with the toolbar button "Edit Config".

MasterControlConsoleEditConfigValues.gif

Then, open the client configuration value editor with the Edit Client Config button.

MasterControlConsoleEditClientConfigValues.png

Selecting a World

Each world can have separate configuration values defined. Also, there is a base level of configuration that all worlds inherit from. The base level configuration is named (BASE) and is selectable from the drop down list of worlds:

MasterControlConsoleClientBaseConfigs.gif

If you want to edit a value that is specific to only one world, select that world from the list and it will show values specific for that world:

MasterControlConsoleClientWorldSpecificConfigs.gif

Important: After changing the values for a world, or the base level values, press the "Save" button to save your changes.

Configurable values

Parm Name Parm Type Description Default value
ArtDirectory string Case sensitive string which is stripped from texture paths to generate repository FQNs \HE\
AltArtDirectory string Case sensitive string which is used if the ArtDirectory string was not found in the texture path for an FQN (none)
CacheFilePath string Subdirectory under the Local Application Data Directory in which to store computed AABBs if the computation time exceeds the load from disk time.

Note: This will most like be unused after the Physics SDK takes over the collision system

Note: Though named similarly to ClientCachePath, this configuration controls entirely separate systems.
HeroEngine
ClientCachePath string This configuration controls where the Local Repository Cache is stored. If the string is empty, a directory will be chosen based on the Universe ID of the world. This default directory is:

<Local Application Data Directory> \HeroEngine\Repository\ <UniverseID>.

If the configuration value is set, two special strings will be replaced to form the final directory. "REPLACEWITHLOCALAPPDATAPATH" will be replaced with the Local Application Data Directory, and "REPLACEWITHUNIVERSEID" will be replaced with the universe ID.
Note: Local Repository Cache refactoring is underway, and when complete will allow multiple universes to coexist in the same cache.
Note: Though named similarly to CacheFilePath, this configuration controls entirely separate systems.
* LOCALPATH\
Play.net\Repository\LOCALUNIVERSEID
* LOCALPATH\HeroEngine\Repository\ID
* LOCALPATH\PLAYNET\Repository\GAMEID
cmdScriptActivity string If this configuration value is not set to "off", this string is to the server on the playerCommand channel whenever the client accesses the script compiler servers to indicate that the client is not AFK. /afk off script
ConsoleBufferSize Integer Controls the total number of lines stored within the Console Panel's buffer. The buffer can be made unlimited by setting this configuration to 0, but this does run the risk of running out of running out of process memory over time or under extreme levels of output. 1000
DefaultAudioPath string No longer used. Default audio directory. /Engine/Standard3D.aud
DynamicDetailTexturePath string Initial directory for the Repository file selector dialog when selecting heightmap dynamic detail billboard textures. The name is the description used for the alternate path selection in the dialog. /World/LiveContent/
DynamicDetails/Textures
DynamicDetailAltTexturePath string Initial directory for the Repository file selector dialog when selecting heightmap dynamic detail billboard textures. The name is the description used for the alternate path selection in the dialog. /World/Segment/DemoLand/Resources/DynamicDetails/Textures
DynamicDetailAltPathName string Initial directory for the Repository file selector dialog when selecting heightmap dynamic detail billboard textures. The name is the description used for the alternate path selection in the dialog. Use DemoLand (development) folder
EnableEnvTimeline string If this configuration value is any non-empty string, the Dynamic Sky timeline editing tools in the Environment panel are enabled.
(null)
EnableSmallPacketHeartbeat string Toggles a small packet heartbeat from the client to prevent disconnects by firewalls closing idle connections (generally the repository connection). Set the value to 1 to enable, 0 disables the heartbeat. 0
GameKeybindingsPath string FQN of a keybinding file to load along with the Clean Engine keybinding file /DefaultKeyBindings.ini
GlobalEnvironmentSchemePath string Determines the location in which Global Environment Schemes will be saved in the repository. Typically configured to be "/World/LiveContent/GlobalEnviroSchemes" Root Directory
HeightmapBillboardPath string Initial directory for the Repository file selector dialog when selecting heightmap billboard textures. /Engine/CleanGame/
HeightmapBillboardAltPath string Alternate directory for the Repository file selector dialog when selecting heightmap billboard textures. To access this directory, click in the checkbox (null)
HeightmapBillboardAltPathName string Text to display next to the Alt Path checkbox in the Repository file selector dialog when selecting heightmap billboard textures. (null)
HeightmapDefaultBrushTexture string Initial texture brush for texture-based painting via the Terrain panel. This also provides the initial directory for the file selector when changing the Brush Texture /engine/defaultcheckered.dds
HeightmapTerrainMeshPath string Initial directory for the Repository file selector dialog when selecting heightmap dynamic detail objects. (null)
HeightmapTerrainMeshAltPath string Initial directory for the Repository file selector dialog when selecting heightmap dynamic detail objects. (null)
HeightmapTerrainMeshAltPathName string Initial directory for the Repository file selector dialog when selecting heightmap dynamic detail objects. (null)
HeightmapTexturePath string Initial directory for the Repository file selector dialog when selecting heightmap textures. (null)
HeightmapTextureAltPath string Initial directory for the Repository file selector dialog when selecting heightmap textures. (null)
HeightmapTextureAltPathName string Initial directory for the Repository file selector dialog when selecting heightmap textures. (null)
HeroEngineScriptWarning string String displayed at the top of Clean HeroEngine scripts and XML when loaded into the editor. (null)
InputSystemProfilesPath string Specifies the path in which keybinding profiles will be stored in the documents folder. HeroEngine
KNOWN_ISSUES_URL string The string the shell is asked to start when the known issues menu option is selected. Usually, this is an http address, for which the shell will launch the default web browser. If it is the empty string, nothing is executed. (null)
SplashLogoPath string Image that the renderer displays when in faded out mode, ie login, before area activation /heroengine_splash.png
STATUS_HOST string If both STATUS_HOST and STATUS_SERVER_PORT have values, the client will establish a connection to the status server host on the specified port and listen for announcements. hjreference.heroengine.com
STATUS_SERVER_PORT string (see above) 90000
VERSION_NOTES_URL string The string the shell is asked to start when the version notes menu option is selected. Usually, this is an http address, for which the shell will launch the default web browser. If it is the empty string, nothing is executed. (null)
WriteTimeout integer The amount of time allowable to not be able to write to a connection. A connection is put into the unable to write state if it has data pending to be written but no bytes were written to the connection by a non-blocking write. After being in this state for more than the timeout, the client assumes the connection has been closed. 60000 milliseconds
MaxValidMeshRadius float The maximum allowed spherical volume in meters for meshes to be rendered by the client. Meshes exceeding this value will not be rendered and an error message will be displayed in the console/errors windows. 99.9 meters (i.e. 9.99 units)
ScriptErrorBufferSize integer The maximum number of script errors displayed in HeroBlade's Script Errors Panel. The buffer can be made unlimited by setting this configuration to 0, but this does run the risk of running out of running out of process memory over time or under extreme levels of output. 100
IsLocalRepositoryCacheAuthoritative integer This config value tell the client to assume any files it has in the LRC are up to date and not to download newer revisions. Files that are needed but not in the LRC are still downloaded on demand.
0

See also

Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox