> ## Documentation Index > Fetch the complete documentation index at: https://nonkit.rlaneth.com/llms.txt > Use this file to discover all available pages before exploring further. # Functions > Query player attributes, game state, and localization Functions return values from the game. Use them in conditions, expressions, and dialogue text. These function signatures are based on analysis of the game's files. Some behaviors and parameter descriptions are inferred and may not be fully accurate. Furthermore, the game is in Early Access and may change over time. ## Usage Syntax Functions can be used in several contexts: ```yarn theme={null} // In conditions <= 100>> // In set statements <> // In dialogue text (use curly braces) Player gold: {get_gold()} ``` ## Player State Functions ### get\_player\_attribute Returns a player attribute value. ```yarn theme={null} get_player_attribute("HP") get_player_attribute("STR") ``` | Parameter | Type | Description | | --------- | ------ | -------------- | | `name` | string | Attribute name | **Returns:** `float` Common attributes: `"HP"`, `"MaxHP"`, `"STR"`, `"DEX"`, `"INT"` ```yarn theme={null} <> Healer: You look injured. <> ``` ### get\_value Retrieves a stored game value by ID. ```yarn theme={null} get_value(1001) ``` | Parameter | Type | Description | | --------- | ---- | ----------- | | `id` | int | Value ID | **Returns:** `float` This function takes an **integer ID**, not a string key. Value IDs are defined in the game's data tables. ```yarn theme={null} <> NPC: I see you've already started the quest. <> ``` ### get\_gold Returns the player's current gold amount. ```yarn theme={null} get_gold() ``` **Returns:** `int` ```yarn theme={null} Merchant: You have {get_gold()} gold coins. <= 500>> -> Buy the rare sword <> ``` ### get\_item Returns the quantity of a specific item. ```yarn theme={null} get_item(10001) ``` | Parameter | Type | Description | | --------- | ---- | ----------- | | `itemID` | int | Item ID | **Returns:** `int` ```yarn theme={null} <= 3>> Alchemist: You have enough herbs. <> ``` ### get\_item\_count Alternative function to get item quantity. ```yarn theme={null} get_item_count(10001) ``` | Parameter | Type | Description | | --------- | ---- | ----------- | | `itemId` | int | Item ID | **Returns:** `int` ## Character Functions Character functions use integer IDs to identify characters: | ID | Character | | ---- | ------------ | | 1000 | Protagonist | | 1001 | Lilith (莉莉丝) | | 1002 | Karen (卡莲) | | 1003 | Sartre (夏特露) | | 1004 | Fouco (弗子) | | 1005 | Green (格林) | ### get\_character\_attribute Returns an attribute for a specific character. ```yarn theme={null} get_character_attribute(1001, "HP") ``` | Parameter | Type | Description | | ---------- | ------ | -------------- | | `id` | int | Character ID | | `attrName` | string | Attribute name | **Returns:** `float` The first parameter is an **integer** character ID, not a string name. ```yarn theme={null} <> // Lilith is low on health <> ``` ### get\_char\_attr Alias for `get_character_attribute`. ```yarn theme={null} get_char_attr(1001, "STR") ``` | Parameter | Type | Description | | ------------- | ------ | -------------- | | `characterID` | int | Character ID | | `attr` | string | Attribute name | **Returns:** `float` ### is\_character\_dead Checks if a character is dead. ```yarn theme={null} is_character_dead(1003) ``` | Parameter | Type | Description | | --------- | ---- | ------------ | | `id` | int | Character ID | **Returns:** `bool` ```yarn theme={null} <> Lilith: We lost Sartre in that battle... <> ``` ### is\_own\_character Checks if a character is in the player's party. ```yarn theme={null} is_own_character(1003) ``` | Parameter | Type | Description | | --------- | ---- | ------------ | | `id` | int | Character ID | **Returns:** `bool` ```yarn theme={null} <> -> Ask Sartre for help <> ``` ## Event Functions ### is\_event\_finished Checks if a specific event has been completed. ```yarn theme={null} is_event_finished(10084) ``` | Parameter | Type | Description | | --------- | ---- | ----------- | | `eventID` | int | Event ID | **Returns:** `bool` ```yarn theme={null} <> NPC: I heard you helped the merchant. <> ``` ## Global State Functions ### get\_global\_value Retrieves a global game state value. ```yarn theme={null} get_global_value("CurrentDay") get_global_value("CurrentPeriod") ``` | Parameter | Type | Description | | --------- | ------ | ----------------- | | `name` | string | Global value name | **Returns:** `string` ```yarn theme={null} Day {get_global_value("CurrentDay")} ``` ### g\_str Gets a global string value. ```yarn theme={null} g_str("SomeStringValue") ``` | Parameter | Type | Description | | --------- | ------ | ----------- | | `name` | string | Value name | **Returns:** `string` ### g\_num Gets a global numeric value. ```yarn theme={null} g_num("SomeNumericValue") ``` | Parameter | Type | Description | | --------- | ------ | ----------- | | `name` | string | Value name | **Returns:** `float` ## Localization Function ### l10n Retrieves a localized string by key. ```yarn theme={null} l10n("UI_Confirm") ``` | Parameter | Type | Description | | --------- | ------ | ---------------- | | `key` | string | Localization key | **Returns:** `string` **Standard dialogue localization** uses `#line:id` tags, not this function. The `l10n` function is for accessing the game's internal localization table (e.g., UI strings). ## Cooking Functions These functions are specific to the cooking system. ### has\_food\_ingredient Checks if player has food ingredients. ```yarn theme={null} has_food_ingredient() ``` **Returns:** `bool` ### get\_cook\_character Gets the current cooking character. ```yarn theme={null} get_cook_character() ``` **Returns:** `int` (character ID) ### get\_cook\_character\_dialog Gets cooking dialogue for a character. ```yarn theme={null} get_cook_character_dialog(1) ``` | Parameter | Type | Description | | --------- | ---- | ------------- | | `type` | int | Dialogue type | **Returns:** `string` ## Common Patterns ### Conditional Dialogue Based on Stats ```yarn theme={null} <= 15>> -> [Intelligence] I notice something hidden... <> <= 12>> -> [Strength] I'll force it open. <> ``` ### Inventory Checks ```yarn theme={null} <= 1>> Guard: Ah, you have the seal. Pass. <> <> Guard: No entry without authorization. <> ``` ### Gold Checks ```yarn theme={null} Merchant: That costs 50 gold. You have {get_gold()}. <= 50>> -> Pay 50 gold <> <> <> -> I'll come back later ``` ### Character State ```yarn theme={null} <> -> Ask Sartre for advice <> ``` ### Event Progression ```yarn theme={null} <> NPC: Thank you for your help before! <> NPC: I could use some assistance... <> ``` ## Important Notes **Common mistakes:** * `get_value` takes an **int ID**, not a string * Character functions take **int IDs**, not string names * Use `#line:id` tags for dialogue localization, not `l10n()` ## Related Pages Control backgrounds, characters, and effects. Modify game state with commands.