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

Constructors

constructor

Methods

fname line_count line_exist r_bool r_clsid r_float r_line r_s32 r_string r_string_wb r_string_wq r_token r_u32 r_vector remove_line save_as save_at_end section_count section_exist section_for_each set_override_names set_readonly w_bool w_color w_fcolor w_float w_fvector2 w_fvector3 w_fvector4 w_s16 w_s32 w_s64 w_s8 w_string w_u16 w_u32 w_u64 w_u8

Constructors

constructor

  • new ini_file(): ini_file

  • Returns ini_file

  • new ini_file(path: string): 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

  • new ini_file(initial: string, path: string): 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

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: string): number

  • Parameters

    • section: string

      target section to check lines count

    Returns number

    count of lines for provided section

line_exist

  • line_exist(section: string, field: string): 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

r_bool

  • r_bool(section: string, field: string): boolean

  • Parameters

    • section: string
    • field: string

    Returns boolean

r_clsid

  • r_clsid(section: string, field: string): number

  • Parameters

    • section: string
    • field: string

    Returns number

r_float

  • r_float(section: string, field: string): number

  • Parameters

    • section: string
    • field: string

    Returns number

r_line

  • r_line<T extends string = string, P extends string = string>(
        section: string,
        line_number: number,
        c: string,
        d: string,
    ): 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.

r_s32

  • r_s32(section: string, field: string): number

  • Parameters

    • section: string
    • field: string

    Returns number

r_string

  • r_string(section: string, field: string): string

  • Parameters

    • section: string

      ini file section

    • field: string

      ini section field

    Returns string

    raw string from ltx file without spaces in it

r_string_wb

  • r_string_wb(section: string, field: string): 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

r_string_wq

  • r_string_wq(section: string, field: string): string

  • Parameters

    • section: string
    • field: string

    Returns string

r_token

r_u32

  • r_u32(section: string, field: string): number

  • Parameters

    • section: string
    • field: string

    Returns number

r_vector

remove_line

  • remove_line(section: string, field: string): void

  • Remove ini file section field.

    Parameters

    • section: string

      target section to modify

    • field: string

      target section field to remove

    Returns void

save_as

save_at_end

  • save_at_end(should_save: boolean): void

  • Adjust saving on file closing/destructor calls.

    Parameters

    • should_save: boolean

      whether ini file should be saved when destructor is called

    Returns void

section_count

section_exist

  • section_exist(section: string): boolean

  • Parameters

    • section: string

    Returns boolean

section_for_each

  • section_for_each(cb: (this: void, name: string) => void): void

  • Iterate over ini file sections. Calls provided callback for each ini section in file.

    Parameters

    • cb: (this: void, name: string) => void

      callback to call on each ini file section, where name is section name

    Returns void

set_override_names

  • set_override_names(override: boolean): void

  • Parameters

    • override: boolean

    Returns void

set_readonly

  • set_readonly(is_readonly: boolean): void

  • Parameters

    • is_readonly: boolean

    Returns void

w_bool

  • w_bool(section: string, field: string, bool: boolean, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • bool: boolean
    • Optionalcomment: string

    Returns void

w_color

  • w_color(section: string, field: string, color: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • color: number
    • Optionalcomment: string

    Returns void

w_fcolor

  • w_fcolor(section: string, field: string, color: fcolor, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • color: fcolor
    • Optionalcomment: string

    Returns void

w_float

  • w_float(section: string, field: string, float: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • float: number
    • Optionalcomment: string

    Returns void

w_fvector2

  • w_fvector2(
        section: string,
        field: string,
        vector: vector2,
        comment?: string,
    ): void

  • Parameters

    • section: string
    • field: string
    • vector: vector2
    • Optionalcomment: string

    Returns void

w_fvector3

  • w_fvector3(
        section: string,
        field: string,
        vector: vector,
        comment?: string,
    ): void

  • Parameters

    • section: string
    • field: string
    • vector: vector
    • Optionalcomment: string

    Returns void

w_fvector4

  • w_fvector4(
        section: string,
        field: string,
        vector: never,
        comment?: string,
    ): void

  • Parameters

    • section: string
    • field: string
    • vector: never
    • Optionalcomment: string

    Returns void

w_s16

  • w_s16(section: string, field: string, sshort: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • sshort: number
    • Optionalcomment: string

    Returns void

w_s32

  • w_s32(section: string, field: string, sint: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • sint: number
    • Optionalcomment: string

    Returns void

w_s64

  • w_s64(section: string, field: string, sint: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • sint: number
    • Optionalcomment: string

    Returns void

w_s8

  • w_s8(section: string, field: string, uchar: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • uchar: number
    • Optionalcomment: string

    Returns void

w_string

  • w_string(section: string, field: string, string: string, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • string: string
    • Optionalcomment: string

    Returns void

w_u16

  • w_u16(section: string, field: string, ushort: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • ushort: number
    • Optionalcomment: string

    Returns void

w_u32

  • w_u32(section: string, field: string, uint: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • uint: number
    • Optionalcomment: string

    Returns void

w_u64

  • w_u64(section: string, field: string, uint: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • uint: number
    • Optionalcomment: string

    Returns void

w_u8

  • w_u8(section: string, field: string, uchar: number, comment?: string): void

  • Parameters

    • section: string
    • field: string
    • uchar: number
    • Optionalcomment: string

    Returns void

Settings

Member Visibility

On This Page

Constructors
Methods