fallout2sfall/sfall
0
0
Fork 0
mirror of https://github.com/sfall-team/sfall.git synced 2026-07-27 16:52:34 -07:00
Code Issues Packages Projects Releases Wiki Activity

Docs: Clarification about get_ini_* function return values

Browse Source 
- Also updated lib.strings.h
This commit is contained in:
phobos2077
2023-06-04 20:32:43 +02:00
parent ac1abf71f8
commit 21fe99a297
3 changed files with 15 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/scripting/functions.yml
+8 -3
View File
@@ -1818,15 +1818,20 @@
- name: get_ini_setting
detail: int get_ini_setting(string setting)
doc: |
- Reads an integer value from an ini file in the fallout directory.
- It only takes a single argument; seperate the file name, section and key with a "\|" character; e.g. `myvar:=get_ini_setting("myini.ini|mysec|var1")` If the file or key cannot be found, -1 is returned.
Reads an integer value from an ini file in the fallout directory.
- It only takes a single argument; seperate the file name, section and key with a "\|" character; e.g. `myvar:=get_ini_setting("myini.ini|mysec|var1")`
- If the file or key cannot be found, -1 is returned.
- If setting argument is in invalid format, -1 is also returned.
- The file name is limited to 63 chars, including the extension.
- The section name is limited to 32 characters.
- It can also be used to get sfall's settings, by using `ddraw.ini` as the file name.
opcode: 0x81ac
- name: get_ini_string
detail: string get_ini_string(string setting)
doc: Reads a string value from an ini file in the fallout directory.
doc: |
Reads a string value from an ini file in the fallout directory.
- If file or key cannot be found, an empty string is returned.
- If setting argument is in invalid format, -1 (integer) is returned.
opcode: 0x81eb
- name: get_ini_section
detail: array get_ini_section(string file, string sect)