Engine:CVAR module

From AddOn Studio
Revision as of 23:21, 16 October 2023 by Bear (talk | contribs) (→‎Details)
Jump to navigation Jump to search
Console commands
Base name for 'world' module, without platform postfix or extensions.
set module 'game'

Arguments

  • name - 'module'
  • value - module name to load

Associations

  • Is by default placed in the 'global' context.

Details

Name of the world native library to load.

'World' in this context means a graphically or otherwise conceptually interactive environment, and is apart from any regular 2D UI environment, or may have no direct user interfaces.

This library typically loads when the 'world' loads and provides support for managing discrete world components how they interact and can act as a sink and/or source for messaging with other systems.

Library load name and path

The actual load path for the world library set with CVAR lib_path, and final library file name will be calculated from the 'module' name and the platform suffixes. See CVAR lib_path for the list of suffixes and explanation.

Examples

Default values

For the path executable path 'd:\install\engine.exe', and a 'lib_path' of './lib/' on windows running 64-bit Engine:

set module 'game'
becomes: ./lib/gamex64.dll
with install in: d:\install\engine
effective OS load: d:\install\engine\lib\gamex86.dll

Notes

See also