Engine:CVAR lib path: Difference between revisions
(Created page with "{{dev/uicvar}} Path for loading native 'world' libraries. <kua>set lib_path './lib/'</kua> == Arguments == * name - 'lib_path' * value - Full or start folder relative path that contains loadable native world libraries. == Associations == * Is by default placed in the 'global' context. == Details == These libraries are platform native libs, with name suffixes by platform and operating system. Modules will load by finding the correct one by name, platform, and OS. [na...") |
|||
(14 intermediate revisions by the same user not shown) | |||
Line 5: | Line 5: | ||
== Arguments == | == Arguments == | ||
* name - 'lib_path' | * name - 'lib_path' | ||
* value - Full or start folder relative path that contains loadable native world libraries. | * value - Full or start folder relative path that contains loadable native world libraries. Default value is './lib/'. | ||
== Associations == | == Associations == | ||
Line 11: | Line 11: | ||
== Details == | == Details == | ||
Path to the platform native libraries for the world. | |||
The library file name format uses name suffixes to distinguish between versions of the same library compiled for different platforms. Modules will load by finding the correct one by name, platform, OS, and OS module type extension. | |||
[name][platform][.os][.extension] | [name][platform][.os][.extension] | ||
namex86.dll | |||
Platform names: | Platform names: | ||
* x86 - | * x86 - 32-bit x86 platform | ||
* x64 - | * x64 - 64-bit x64 platform | ||
* a64 - | * a64 - 64-bit ARM platform | ||
OS names: | OS names: | ||
Line 24: | Line 27: | ||
* .linux - Linux, using the '.so' extension | * .linux - Linux, using the '.so' extension | ||
* .osx - Mac OS, using the '.so' extension | * .osx - Mac OS, using the '.so' extension | ||
The path is either a full OS file system path to the library location, or a path relative to the launch location, which is the location of the executable for the engine. | |||
In some configurations the path is relative to the current directory and not necessarily the actual engine start location. The 'lib_path' will be concatenated verbatim to the calculated library file name to create the final library load path. | |||
set lib_path './lib/' | |||
becomes: ./lib/namex86.dll | |||
with install in: d:\install\engine | |||
effective OS load: d:\install\engine\lib\namex86.dll | |||
== Examples == | == Examples == | ||
=== Default values === | === Default values === | ||
For the path executable path 'd:\install\engine.exe', and a 'lib_path' of './lib/': | |||
\install | |||
engine.exe | |||
lib | |||
gamex86.dll | |||
gamex64.dll | |||
data | |||
... | |||
=== Formatted names === | |||
<pre> | <pre> | ||
gamex86.dll | |||
gamex64.dll | |||
gamex64.linux.so | |||
gamex64.osx.so | |||
gamea64.osx.so | |||
</pre> | </pre> | ||
== Notes == | == Notes == |
Latest revision as of 19:52, 16 October 2023
Path for loading native 'world' libraries.
set lib_path './lib/'
Arguments[edit]
- name - 'lib_path'
- value - Full or start folder relative path that contains loadable native world libraries. Default value is './lib/'.
Associations[edit]
- Is by default placed in the 'global' context.
Details[edit]
Path to the platform native libraries for the world.
The library file name format uses name suffixes to distinguish between versions of the same library compiled for different platforms. Modules will load by finding the correct one by name, platform, OS, and OS module type extension.
[name][platform][.os][.extension] namex86.dll
Platform names:
- x86 - 32-bit x86 platform
- x64 - 64-bit x64 platform
- a64 - 64-bit ARM platform
OS names:
- (none) - Windows, using the '.dll' extension
- .linux - Linux, using the '.so' extension
- .osx - Mac OS, using the '.so' extension
The path is either a full OS file system path to the library location, or a path relative to the launch location, which is the location of the executable for the engine.
In some configurations the path is relative to the current directory and not necessarily the actual engine start location. The 'lib_path' will be concatenated verbatim to the calculated library file name to create the final library load path.
set lib_path './lib/' becomes: ./lib/namex86.dll with install in: d:\install\engine effective OS load: d:\install\engine\lib\namex86.dll
Examples[edit]
Default values[edit]
For the path executable path 'd:\install\engine.exe', and a 'lib_path' of './lib/':
\install engine.exe lib gamex86.dll gamex64.dll data ...
Formatted names[edit]
gamex86.dll
gamex64.dll
gamex64.linux.so
gamex64.osx.so
gamea64.osx.so