Differences

This shows you the differences between two versions of the page.

--- es:orx:config:main [2012/03/01 13:14 (13 years ago)] – created zera
+++ es:orx:config:main [2020/08/19 21:15 (5 years ago)] (current) – Old content sausage
@@ Line 1: / Line 1: @@
-====== Configuración ======
-This section is dedicated to the config system used by [[http://orx-project.org|orx]], an opensource, portable, lightweight, data-driven & 2D-oriented game engine.
-===== Introducción =====
-The config system is part of orx's core modules. It's the main module that makes orx a data-driven game engine.\\
-As it permits to do on-the-fly tweaks and modifications, it is one of the most important modules to learn.\\
-When you get comfortable with it, your development time will be drastically shortened.
-Its format is basically the one used in [[wp>INI_file|INI files]]. However, some concepts such as inheritance and overriding have been added.\\
-A couple of specific operators have also been added ((for handling lists, randoms or included files, for example)) and will be covered in the [[syntax|syntax section]].
-===== Información General =====
-When orx is initialized, it will use the executable name to deduce the main config file name.\\
-Basically it will remove the extension from your executable name, if any, and add the ''.ini'' extension. If you're using orx launcher (''orx.exe/orx''), the main config file will be orx.ini.\\
-In the same way, if your program is called ''MyNewGame.exe'', the main config file that will be loaded when orx is initialized will the ''MyNewGame.ini''.
-In that file you can include as many other config files ((with any kind of extension, ''.ini'' isn't mandatory)) you want.\\
-You can also load config files directly in code.
-<code c>orxConfig_Load("MyConfigFile.cfg");</code>
-Once a config file is loaded, accessing its information will be done in memory, the file won't be read from disk again unless specifically asked with calls to ''orxConfig_Load()'' or ''orxConfig_ReloadHistory()''.
-You can even save the content of the config to a file, either completely or partially. Here's the function you need to call in order to do so:
-<code c>orxConfig_Save("MyConfigFile.cfg", bEncrypt, MySaveFilter);</code>
-''MySaveFilter'' is a callback that will be called for every section and every key to let you decide if you want to save this info to the file or not.\\
-If you pass ''orxNULL'' instead of a valid callback, every single key/value pair will be saved.\\
-Please note that the original comments of originally loaded files won't be saved as they're ignored during the loading and never stored in memory.
-In your ''MySaveFilter'' callback, when provided with a name for a section and ''orxNULL'' as a key, it is for you to decide if you want to save some parts of this section (by returning ''orxTRUE'') or if you'd rather skip the whole section completely (by returning ''orxFALSE'').\\
-In the first case, you will then be asked for each key/value pair of this section if you want to save it or not.
-This filter system is very handy when you want to save partial data, like for handling save games as you'll see in [[savegame|the savegame section]].
-You can find the config module API in doxygen format via [[http://doc.orx-project.org|orx's doxygen doc page]] or directly [[http://doc.orx-project.org/group__orx_config.html|here]].\\
-We believe the API is self explanatory and shouldn't be much troublesome to learn.
-Config's module use, data-wise, is thoroughly described in below sections.\\
-The last section shows how to adapt it for handling save games.
-There are many ways in which the config module can be helpful: for example, it already is the base for the localization module.\\
-It's now up to you to find other clever ways of using it depending on your needs. =)
-===== Secciones =====
-  * [[Syntax]]
-  * [[en:orx:config:settings_main:main|Ajustes principales de orx]]
-  * [[en:orx:config:settings_structure:main|Ajustes estructurales de orx]]
-  * [[encryption|Encriptación & Programa orxCrypt]]
-  * [[savegame|Usando el modulo configuración para salvar juegos]]

Orx Learning

User Tools

Site Tools

Differences

Page Tools