Engine:CVAR startup: Difference between revisions

From AddOn Studio
Jump to navigation Jump to search
(Created page with "{{dev/uicvar}} Path for the startup script file. <kua>set startup 'startup.cfg' </kua> == Arguments == * name - 'startup' * value - Relative asset path for the startup script file. Default value is unset. == Associations == * Is by default placed in the 'global' context. == Details == Set a script file to be run just after basic engine systems are started. If no value is set, no startup script will be run. The similar config script, 'config.cfg', file is run after ba...")
 
 
(2 intermediate revisions by the same user not shown)
Line 11: Line 11:


== Details ==
== Details ==
Set a script file to be run just after basic engine systems are started. If no value is set, no startup script will be run.
Set a script file to be run after basic engine systems are started. If no value is set, no startup script will be run.


The similar config script, 'config.cfg', file is run after basic module initialization, where variable commands and certain basic commands are available, but before module start. The startup script is run after module start.
The similar engine config script 'config.cfg' file is run after basic module initialization. The config file is a place where the startup script can be set.
 
This two-tier module initialization and start, allows all of the configuration to occur at once, either through script or between modules. Changes made during start


Startup stages:
Startup stages:
* Process load
* Process load
* Module initialization
* Modules initialization
** Commands and variables with default values are created
** Commands and variables with default values are created
* Config script is run  
* Config script is run 'config.cfg'
* Module start
* Modules start
** Use of default or config set variables or other changes
** Use of default or config set variables or other changes
* * Startup script is run
* '''Startup script is run 'startup.cfg''''
* Server module load
* Server module load
* Engine runs
* Engine run
 
=== Using ===
For example, the 'map' and 'module' load defaults can be unset, and then no map or module will be loaded. The setup script can then be used to provide a more sophisticated configuration. This includes choosing which services are inittially started, and so on.


== Examples ==
== Examples ==
=== Default values ===
=== Default values ===
<kua>
> startup
'startup' is ''
</kua>
In a config file named 'config.cfg'
In a config file named 'config.cfg'
<kua>
<kua>

Latest revision as of 17:31, 17 October 2023

← Console commands

Path for the startup script file. 

set startup 'startup.cfg'

Arguments[edit]

  • name - 'startup'
  • value - Relative asset path for the startup script file. Default value is unset.

Associations[edit]

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

Details[edit]

Set a script file to be run after basic engine systems are started. If no value is set, no startup script will be run.

The similar engine config script 'config.cfg' file is run after basic module initialization. The config file is a place where the startup script can be set.

Startup stages:

  • Process load
  • Modules initialization
    • Commands and variables with default values are created
  • Config script is run 'config.cfg'
  • Modules start
    • Use of default or config set variables or other changes
  • Startup script is run 'startup.cfg'
  • Server module load
  • Engine run

Using[edit]

For example, the 'map' and 'module' load defaults can be unset, and then no map or module will be loaded. The setup script can then be used to provide a more sophisticated configuration. This includes choosing which services are inittially started, and so on.

Examples[edit]

Default values[edit]

> startup
'startup' is ''

In a config file named 'config.cfg' 

...
startup startup.cfg

Notes[edit]

See also[edit]

Retrieved from "https://addonstudio.org/mw/index.php?title=Engine:CVAR_startup&oldid=21629"