Class ini_file

Implementation of streaming ini file container. Allows reading / writing field in file by section/field.

Supports custom extension with section overriding and custom #include statements.

Source

C++ class ini_file

Custom Constructor

ini_file

Hierarchy

ini_file

Constructors

constructor

new ini_file(): ini_file
Returns ini_file
- Defined in xr_lib/xr_ini.d.ts:13
new ini_file(path): ini_file
Create ini file representation based on file name. Full path is limited to 520 chars.
Parameters
- path: string
  
  file name and relative path to gamedata configs folder
Returns ini_file
- Defined in xr_lib/xr_ini.d.ts:20
new ini_file(initial, path): ini_file
Create ini file representation based on file name. Full path is limited to 520 chars.
Parameters
- initial: string
  
  base to count relative path from, $game_data$ is an example
- path: string
  
  file name and relative path from initial entrypoint
Returns ini_file
- Defined in xr_lib/xr_ini.d.ts:28

Methods

fname

fname(): string

Get file name and path of ini file.

Returns string

full path to ini file

Example

`f:\applications\steam\steamapps\common\stalker call of pripyat\gamedata\configs\misc\task_manager.ltx`

line_count

line_count(section): number
Parameters
- section: string
  
  target section to check lines count
Returns number
count of lines for provided section
- Defined in xr_lib/xr_ini.d.ts:34

line_exist

line_exist(section, field): boolean
Check if line exists in the file by section and field.
Parameters
- section: string
  
  target section to check
- field: string
  
  section field to check
Returns boolean
whether line exists
- Defined in xr_lib/xr_ini.d.ts:100

r_bool

r_bool(section, field): boolean
Parameters
- section: string
- field: string
Returns boolean
- Defined in xr_lib/xr_ini.d.ts:49

r_clsid

r_clsid(section, field): number
Parameters
- section: string
- field: string
Returns number
- Defined in xr_lib/xr_ini.d.ts:55

r_float

r_float(section, field): number
Parameters
- section: string
- field: string
Returns number
- Defined in xr_lib/xr_ini.d.ts:53

r_line

r_line<T, P>(section, line_number, c, d): LuaMultiReturn<[boolean, T, P]>
Read text line from ini config file.
Type Parameters
- T extends string = string
- P extends string = string
Parameters
- section: string
- line_number: number
- c: string
- d: string
Returns LuaMultiReturn<[boolean, T, P]>
tuple with three elements, where first is success status, second is key, third is value.
- Defined in xr_lib/xr_ini.d.ts:64

r_s32

r_s32(section, field): number
Parameters
- section: string
- field: string
Returns number
- Defined in xr_lib/xr_ini.d.ts:57

r_string

r_string(section, field): string
Parameters
- section: string
  
  ini file section
- field: string
  
  ini section field
Returns string
raw string from ltx file without spaces in it
- Defined in xr_lib/xr_ini.d.ts:91

r_string_wb

r_string_wb(section, field): string
Parameters
- section: string
  
  ini file section
- field: string
  
  ini section field
Returns string
if quoted, parsed string data inside quotes including spaces, else is same data as with r_string
- Defined in xr_lib/xr_ini.d.ts:84

r_string_wq

r_string_wq(section, field): string
Parameters
- section: string
- field: string
Returns string
- Defined in xr_lib/xr_ini.d.ts:77

r_token

r_token(section, field, list): number
Parameters
- section: string
- field: string
- list: token_list
Returns number
- Defined in xr_lib/xr_ini.d.ts:71

r_u32

r_u32(section, field): number
Parameters
- section: string
- field: string
Returns number
- Defined in xr_lib/xr_ini.d.ts:75

r_vector

r_vector(section, field): vector
Parameters
- section: string
- field: string
Returns vector
- Defined in xr_lib/xr_ini.d.ts:73

remove_line

remove_line(section, field): void
Remove ini file section field.
Parameters
- section: string
  
  target section to modify
- field: string
  
  target section field to remove
Returns void
- Defined in xr_lib/xr_ini.d.ts:47

save_as

save_as(path): boolean
Parameters
- path: string
Returns boolean
- Defined in xr_lib/xr_ini.d.ts:147

save_at_end

save_at_end(should_save): void
Adjust saving on file closing/destructor calls.
Parameters
- should_save: boolean
  
  whether ini file should be saved when destructor is called
Returns void
- Defined in xr_lib/xr_ini.d.ts:154

section_count

section_count(): number
Returns number
sections count for ini file
- Defined in xr_lib/xr_ini.d.ts:39

section_exist

section_exist(section): boolean
Parameters
- section: string
Returns boolean
- Defined in xr_lib/xr_ini.d.ts:51

section_for_each

section_for_each(cb): void
Iterate over ini file sections. Calls provided callback for each ini section in file.
Parameters
- cb: ((this, name) => void)
  
  callback to call on each ini file section, where name is section name
  - - (this, name): void
    - Parameters
      
      this: void
      
      name: string
      
      Returns void
Returns void
- Defined in xr_lib/xr_ini.d.ts:162

set_override_names

set_override_names(override): void
Parameters
- override: boolean
Returns void
- Defined in xr_lib/xr_ini.d.ts:145

set_readonly

set_readonly(is_readonly): void
Parameters
- is_readonly: boolean
Returns void
- Defined in xr_lib/xr_ini.d.ts:143

w_bool

w_bool(section, field, bool, comment?): void
Parameters
- section: string
- field: string
- bool: boolean
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:112

w_color

w_color(section, field, color, comment?): void
Parameters
- section: string
- field: string
- color: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:110

w_fcolor

w_fcolor(section, field, color, comment?): void
Parameters
- section: string
- field: string
- color: fcolor
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:108

w_float

w_float(section, field, float, comment?): void
Parameters
- section: string
- field: string
- float: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:130

w_fvector2

w_fvector2(section, field, vector, comment?): void
Parameters
- section: string
- field: string
- vector: vector2
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:102

w_fvector3

w_fvector3(section, field, vector, comment?): void
Parameters
- section: string
- field: string
- vector: vector
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:104

w_fvector4

w_fvector4(section, field, vector, comment?): void
Parameters
- section: string
- field: string
- vector: never
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:106

w_s16

w_s16(section, field, sshort, comment?): void
Parameters
- section: string
- field: string
- sshort: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:118

w_s32

w_s32(section, field, sint, comment?): void
Parameters
- section: string
- field: string
- sint: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:122

w_s64

w_s64(section, field, sint, comment?): void
Parameters
- section: string
- field: string
- sint: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:126

w_s8

w_s8(section, field, uchar, comment?): void
Parameters
- section: string
- field: string
- uchar: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:114

w_string

w_string(section, field, string, comment?): void
Parameters
- section: string
- field: string
- string: string
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:132

w_u16

w_u16(section, field, ushort, comment?): void
Parameters
- section: string
- field: string
- ushort: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:120

w_u32

w_u32(section, field, uint, comment?): void
Parameters
- section: string
- field: string
- uint: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:124

w_u64

w_u64(section, field, uint, comment?): void
Parameters
- section: string
- field: string
- uint: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:128

w_u8

w_u8(section, field, uchar, comment?): void
Parameters
- section: string
- field: string
- uchar: number
- Optional comment: string
Returns void
- Defined in xr_lib/xr_ini.d.ts:116

Class ini_file

Source

Custom Constructor

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns ini_file

Parameters

path: string

Returns ini_file

Parameters

initial: string

path: string

Returns ini_file

Methods

fname

Returns string

Example

line_count

Parameters

section: string

Returns number

line_exist

Parameters

section: string

field: string

Returns boolean

r_bool

Parameters

section: string

field: string

Returns boolean

r_clsid

Parameters

section: string

field: string

Returns number

r_float

Parameters

section: string

field: string

Returns number

r_line

Type Parameters

T extends string = string

P extends string = string

Parameters

section: string

line_number: number

c: string

d: string

Returns LuaMultiReturn<[boolean, T, P]>

r_s32

Parameters

section: string

field: string

Returns number

r_string

Parameters

section: string

field: string

Returns string

r_string_wb

Parameters

section: string

field: string

Returns string

r_string_wq

Parameters

section: string

field: string

Returns string

r_token

Parameters

section: string

field: string

list: token_list

`Optional` comment: string

`Optional` comment: string

`Optional` comment: string