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

Header lib: refactor inven_as_array and add proper jsdoc defs to all comments

Browse Source 
- inven_as_array was allocating blocks of 100 items which was unnecessary
This commit is contained in:
phobos2077
2024-05-20 12:41:02 +02:00
parent 037269c940
commit 6b818e797e
6 changed files with 237 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files
artifacts/scripting/headers/lib.misc.h
+15 -4
View File
@@ -23,7 +23,9 @@ end*/
end*/
/**
Parses keyboard shortcut definition (key code + optional modifier key) from a string into an integer for later use in other hotkey procedures.
* Parses keyboard shortcut definition (key code + optional modifier key) from a string into an integer for later use in other hotkey procedures.
* @arg {string} string
* @ret {int}
*/
procedure parse_hotkey(variable string) begin
variable lst;
@@ -38,7 +40,9 @@ procedure parse_hotkey(variable string) begin
end
/**
Checks if a given shortcut is currently pressed (see parse_hotkey).
* Checks if a given shortcut is currently pressed (see parse_hotkey).
* @arg {int} n - hotkey data parsed with *parse_hotkey*
* @ret {bool}
*/
procedure hotkey_pressed(variable n) begin
if (n < 0x10000) then
@@ -48,7 +52,10 @@ procedure hotkey_pressed(variable n) begin
end
/**
Checks if a shortcut is currently pressed, given that *key* is already pressed.
* Checks if a shortcut is currently pressed, given that *key* is already pressed.
* @arg {int} n - hotkey data parsed with *parse_hotkey*
* @arg {int} key - DX scancode
* @ret {bool}
*/
procedure hotkey_pressed_now(variable n, variable key) begin
if (n < 0x10000) then
@@ -66,7 +73,11 @@ procedure hotkey_pressed_now(variable n, variable key) begin
end
/**
Loads ini section as map of keys and values parsed as integers (0 values will be skipped!)
* Loads ini section as map of keys and values parsed as integers (0 values will be skipped!)
* @arg {string} file
* @arg {string} section
* @arg {bool} [fixArray=false] - if true, *fix_array* will be called automatically on resulting array
* @ret {map}
*/
procedure get_ini_section_int_to_int(variable file, variable section, variable fixArray := false) begin
variable ar, ar2 := temp_array_map, k, v;