### Lua ISInventoryPage: ongamestart() Method

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISInventoryPage

Initializes the inventory page at the start of the game. This static method is triggered once when the game begins, allowing the inventory UI to perform any necessary setup or data loading. It does not require any input parameters.

```APIDOC
Class: ISInventoryPage
Method: ongamestart
Signature: static void ongamestart()
Description: Called at the very beginning of the game to initialize the inventory page.
Parameters: None
Returns: void
```

--------------------------------

### Lua API Reference: TutorialSetup.yml Module

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/TutorialSetup_8yml

This section provides an API reference for the `TutorialSetup.yml` module in Project Zomboid's Lua documentation. It details available classes and functions, including their signatures and return types, for interacting with tutorial-related functionalities. This module is crucial for managing in-game tutorial processes.

```APIDOC
Module: TutorialSetup.yml

Classes:
- Name: TutorialData
  Type: class
  Description: Represents tutorial-related data and configurations.
  Reference: classTutorialData.html

Functions:
- Name: preLoadTutorialInit
  Signature: void preLoadTutorialInit()
  Description: Initializes tutorial data and settings before the main game load. This function prepares the environment for tutorial execution.
  Return: void
  Parameters: []

- Name: doTutorialDraw
  Signature: void doTutorialDraw()
  Description: Handles the rendering and drawing operations for the active tutorial elements on screen. It is typically called during the game's rendering loop.
  Return: void
  Parameters: []

- Name: doTutorialInit
  Signature: void doTutorialInit()
  Description: Performs the primary initialization for the tutorial system. This includes setting up game states and resources specific to the tutorial.
  Return: void
  Parameters: []

- Name: savePlayerInFile
  Signature: void savePlayerInFile()
  Description: Saves the current player's state and progress to a file during the tutorial. This ensures persistence of tutorial progress.
  Return: void
  Parameters: []

- Name: doTutorialCreatePlayer
  Signature: void doTutorialCreatePlayer()
  Description: Creates and initializes a player character specifically for the tutorial scenario. This function sets up the player's initial conditions and inventory.
  Return: void
  Parameters: []
```

--------------------------------

### Lua ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISWidgetTooltipInput

Retrieves the delay in milliseconds before joypad navigation starts. This method returns a numerical value representing the delay.

```APIDOC
class ISUIElement {
  getJoypadNavigateStartDelay(): number;
  // Returns: number - The delay in milliseconds.
}
```

--------------------------------

### JoyPadSetup.yml API Reference

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/JoyPadSetup_8yml

This section provides API documentation for the JoyPadSetup.yml file, detailing classes and functions related to joypad management in Project Zomboid's Lua environment. It includes definitions for managing joypad state, controllers, and UI focus.

```APIDOC
{
  "file": "JoyPadSetup.yml",
  "description": "Defines classes and functions for managing joypad input and UI focus within Project Zomboid's Lua environment.",
  "classes": [
    {"name": "JoypadState", "description": "Represents the state of a joypad.", "link": "classJoypadState.html"},
    {"name": "Joypad", "description": "Main class for joypad interaction.", "link": "classJoypad.html"},
    {"name": "joypad", "description": "Another class related to joypad functionality (possibly a singleton or utility).", "link": "classjoypad.html"},
    {"name": "JoypadControllerData", "description": "Data structure for a specific joypad controller.", "link": "classJoypadControllerData.html"},
    {"name": "JoypadData", "description": "Comprehensive data structure for joypad information.", "link": "classJoypadData.html"}
  ],
  "functions": [
    {
      "name": "getFocusForPlayer",
      "return_type": "ISUIElement",
      "parameters": [],
      "description": "Retrieves the current UI element that has joypad focus for the player."
    },
    {
      "name": "isJoypadFocusOnElementOrDescendant",
      "return_type": "boolean",
      "parameters": [
        {"name": "ui", "type": "ISUIElement", "description": "The UI element to check focus against."}
      ],
      "description": "Checks if the joypad focus is currently on the specified UI element or any of its descendants."
    },
    {
      "name": "getJoypadData",
      "return_type": "JoypadData",
      "parameters": [],
      "description": "Retrieves the comprehensive joypad data object."
    },
    {
      "name": "getJoypadFocus",
      "return_type": "ISUIElement",
      "parameters": [],
      "description": "Retrieves the UI element that currently has joypad focus."
    },
    {
      "name": "setJoypadFocus",
      "return_type": "void",
      "parameters": [
        {"name": "control", "type": "ISUIElement", "description": "The UI element to set as the new joypad focus."}
      ],
      "description": "Sets the joypad focus to a specific UI element."
    },
    {
      "name": "setPrevFocusForPlayer",
      "return_type": "void",
      "parameters": [],
      "description": "Sets the joypad focus to the previously focused element for the player."
    },
    {
      "name": "setPrevPrevFocusForPlayer",
      "return_type": "void",
      "parameters": [],
      "description": "Sets the joypad focus to the element focused before the previous one for the player."
    },
    {
      "name": "updateJoypadFocus",
      "return_type": "void",
      "parameters": [],
      "description": "Updates the current joypad focus based on internal logic."
    },
    {
      "name": "onJoypadRenderTick",
      "return_type": "void",
      "parameters": [],
      "description": "Callback function invoked on each render tick related to joypad."
    },
    {
      "name": "onJoypadActivate",
      "return_type": "void",
      "parameters": [],
      "description": "Callback function invoked when a joypad is activated."
    },
    {
      "name": "onJoypadActivateUI",
      "return_type": "void",
      "parameters": [],
      "description": "Callback function invoked when joypad UI activation occurs."
    },
    {
      "name": "onJoypadBeforeDeactivate",
      "return_type": "void",
      "parameters": [],
      "description": "Callback function invoked before a joypad is deactivated."
    },
    {
      "name": "onJoypadDeactivate",
      "return_type": "void",
      "parameters": [],
      "description": "Callback function invoked when a joypad is deactivated."
    },
    {
      "name": "onJoypadBeforeReactivate",
      "return_type": "void",
      "parameters": [],
      "description": "Callback function invoked before a joypad is reactivated."
    },
    {
      "name": "onJoypadReactivate",
      "return_type": "void",
      "parameters": [],
      "description": "Callback function invoked when a joypad is reactivated."
    }
  ]
}
```

--------------------------------

### ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISDemoPopup

This method retrieves the delay in milliseconds before joypad navigation starts. It returns a number representing the delay. This can be used to fine-tune the responsiveness of joypad navigation.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### Lua API: doTutorialInit()

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/globals_d

This API function initializes the tutorial setup in Project Zomboid. It is part of the unofficial Lua documentation for the game.

```Lua
doTutorialInit() -- From TutorialSetup.yml
```

--------------------------------

### Lua ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISCraftRecipeTooltip

Retrieves the delay in seconds before joypad navigation starts on this UI element. This method returns a number. It helps control the responsiveness of joypad navigation.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### ISUIElement: Get Joypad Navigate Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classGlobalModDataDebug

Retrieves the delay in milliseconds before joypad navigation starts. This method returns a number. It can be used to implement a brief pause before navigation becomes active.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### Initialize and Prepare Project Zomboid's Turn-based Engine

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/TurnBasedMain_8yml

This snippet documents two essential functions, `InitTurnbasedEngine` and `PrepareTurnbasedEngine`, responsible for setting up and readying the turn-based game mechanics. `InitTurnbasedEngine` performs the initial setup, while `PrepareTurnbasedEngine` ensures the engine is ready for operation, likely handling pre-turn logic or state preparation.

```APIDOC
function InitTurnbasedEngine(): void {
  // Initializes the turn-based engine for Project Zomboid.
}

function PrepareTurnbasedEngine(): void {
  // Prepares the turn-based engine for operation, handling pre-turn logic.
}
```

--------------------------------

### Lua Tutorial1::PreloadInit() Method

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classTutorial1

Performs pre-initialization tasks for the Tutorial1 class. This method is typically called before Init() to load assets or set up systems that are required very early in the game's loading process. It takes no parameters.

```APIDOC
Class: Tutorial1
Method: PreloadInit
Static: Yes
Return Type: void
Parameters: None
```

--------------------------------

### Get Joypad Navigation Start Delay (ISUIElement)

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISVehicleRoadtripDebug

This method retrieves the delay value associated with the joypad navigation start action. The returned number represents the duration of the delay.

```APIDOC
function getJoypadNavigateStartDelay(): number
-- Parameters:
-- None
-- Returns:
-- number - The delay in milliseconds or a similar unit.
```

--------------------------------

### ISBuildWindow: Initialize Window

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISBuildWindow

Performs initial setup and configuration for the ISBuildWindow. This method prepares the window for use after its creation, setting up its initial state.

```APIDOC
void ISBuildWindow::initialise()
```

--------------------------------

### Get Joypad Navigation Start Delay (ISUIElement)

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classWorldMapEditorMode__Maps-members

Returns the delay in milliseconds before joypad navigation starts responding after initial input. This helps prevent accidental rapid navigation.

```APIDOC
ISUIElement.getJoypadNavigateStartDelay() -> number
```

--------------------------------

### Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISSurvivalGuideRightPanel

This method retrieves the delay in milliseconds before joypad navigation starts. This delay can be used to prevent accidental or rapid navigation inputs. It returns a numerical value.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### Lua: Perform Initial Setup for ISBuildingObject

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISBuildingObject

Performs initial setup routines for the ISBuildingObject instance. This method is often called once after the object is created to prepare it for use within the game environment. It does not require any parameters and returns no value.

```APIDOC
void ISBuildingObject::initialise()
```

--------------------------------

### APIDOC: doLastStandInit Function

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/LastStandSetup_8yml

Performs the main initialization for the Last Stand game mode, setting up the game environment. This function takes no parameters and returns void.

```APIDOC
function doLastStandInit(): void
```

--------------------------------

### Get ISUIElement Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISScriptViewWindow-members

This method retrieves the delay in milliseconds before joypad navigation starts for this ISUIElement. It returns a number. This helps fine-tune responsiveness for controller input.

```APIDOC
function ISUIElement:getJoypadNavigateStartDelay(): number
```

--------------------------------

### Lua ISPanelJoypad.initialise Method

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISMultiplayerZoneEditor-members

Initializes the ISPanelJoypad instance. This method is called to set up the joypad panel, preparing it for use. It takes no parameters and does not return any value.

```APIDOC
class ISPanelJoypad {
    initialise(): void
}
```

--------------------------------

### Lua ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISPlayerStatsWarningPointUI-members

Retrieves the delay in milliseconds before joypad navigation starts when focusing on this UI element. This helps prevent accidental rapid navigation.

```APIDOC
Class: ISUIElement
Method: getJoypadNavigateStartDelay
Description: Retrieves the delay before joypad navigation starts.
Parameters: None
Returns: number
```

--------------------------------

### Lua Tutorial1::Init() Method

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classTutorial1

Initializes the Tutorial1 class or related game systems. This method is crucial for setting up initial states, registering events, or loading necessary resources at the start of a game session or specific tutorial phase. It takes no parameters and returns void.

```APIDOC
Class: Tutorial1
Method: Init
Static: Yes
Return Type: void
Parameters: None
```

--------------------------------

### ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classRWMPanel

This method retrieves the delay in milliseconds before joypad navigation starts. It returns a number representing the delay. This can be used to fine-tune the responsiveness of joypad navigation.

```APIDOC
Method: getJoypadNavigateStartDelay
Return Type: number
Parameters: None
```

--------------------------------

### Lua: doTutorialInit() API Reference

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/globals_func_d

Provides API details for the Lua function `doTutorialInit()`. This function is defined in `TutorialSetup.yml` and is likely responsible for initializing the tutorial mode.

```Lua
function doTutorialInit() -- Defined in TutorialSetup.yml
```

--------------------------------

### Get ISFluidTransferAction Source Start Amount API

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISFluidTransferAction

This property holds a number representing the initial quantity of fluid at the source before the transfer operation begins. It can be used to track the starting volume for calculations.

```APIDOC
number ISFluidTransferAction::sourceStartAmount
```

--------------------------------

### CoopOptionsScreen::aboutToShow Method

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classCoopOptionsScreen

Executes logic just before the `CoopOptionsScreen` is displayed. This method can be used to perform any necessary setup or data loading prior to the screen becoming visible to the user.

```APIDOC
void CoopOptionsScreen::aboutToShow()
```

--------------------------------

### ISUIElement: Get Joypad Navigation Start Delay (getJoypadNavigateStartDelay)

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISCraftRecipeInfoBox

Retrieves the delay in milliseconds before joypad navigation starts. This method returns a numerical value representing the required delay for the navigation process.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISAttachedItemsUI

This method retrieves the delay in milliseconds before joypad navigation officially starts. It returns a number representing this delay, which can be used to fine-tune UI responsiveness.

```APIDOC
Method: getJoypadNavigateStartDelay
Return Type: number
Parameters: (none)
```

--------------------------------

### CoopOptionsScreen::initialise Method

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classCoopOptionsScreen

Performs initial setup and configuration for the `CoopOptionsScreen`. This method is typically called once to prepare the screen's internal state and dependencies.

```APIDOC
void CoopOptionsScreen::initialise()
```

--------------------------------

### Get Joypad Navigation Start Delay for ISUIElement

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classEditVehicleUI__EditWheel

This method retrieves the delay in milliseconds before joypad navigation starts for the current UI element. It returns a number representing the configured delay, allowing for fine-tuning of navigation responsiveness.

```APIDOC
Method: getJoypadNavigateStartDelay
Return Type: number
Parameters: None
```

--------------------------------

### Lua API: WelcomeStep Class Reference

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classWelcomeStep

Provides a comprehensive reference for the `WelcomeStep` class in Project Zomboid's Lua API, detailing its own methods, inherited methods from `TutorialStep` and `ISBaseObject`, and public attributes. This class is part of the tutorial system.

```APIDOC
class WelcomeStep extends TutorialStep, ISBaseObject {

    // Constructors
    WelcomeStep();

    // Public Member Functions
    void begin();
    boolean isComplete();
    void finish();

    // Static Public Attributes
    static boolean finished;

    // Inherited Public Member Functions from TutorialStep
    void TutorialStep(table type);
    void begin();
    boolean isComplete();
    void finish();
    void during();
    void onClose(nil message);
    void addMessage(string text, number x, number y);
    void doMessage();

    // Inherited Public Member Functions from ISBaseObject
    void ISBaseObject();
    void initialise();
    ISBaseObject derive(string type);
    void addEventListener(string _event, function _callback, unknown _target);
    void removeEventListener(string _event, function _callback);
    void triggerEvent(string _event, unknown ...);
    void clearEventListeners();

    // Inherited Public Attributes from TutorialStep
    LuaList messages;

    // Inherited Public Attributes from ISBaseObject
    string Type;
    table<string, table<function, unknown>> __eventListeners;
}
```

--------------------------------

### Lua ISInventoryPage:initialise() API Reference

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISInventoryPage

Performs initial setup and configuration for the ISInventoryPage. This method is called once when the inventory page is created to prepare its state and components. It takes no parameters and returns void.

```APIDOC
void ISInventoryPage::initialise()
```

--------------------------------

### ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classWorldMapEditorMode

This method retrieves the delay time before joypad navigation starts. This delay can be used to prevent accidental rapid navigation. It takes no parameters and returns a number.

```APIDOC
Method: getJoypadNavigateStartDelay
Return Type: number
Parameters:
  - None
```

--------------------------------

### Lua ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classPage3_1_1ChooseModsWindow

This method retrieves the delay time before joypad navigation starts. It allows customization of the responsiveness of joypad navigation. It returns a number representing the delay.

```APIDOC
Class: ISUIElement
Method: getJoypadNavigateStartDelay
Return Type: number
Parameters:
  (none)
```

--------------------------------

### ObjectViewer: Initialize Instance

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classObjectViewer

Performs initial setup for the ObjectViewer instance, preparing it for use. This method takes no parameters and returns void, ensuring the viewer is in a ready state.

```APIDOC
{"class": "ObjectViewer", "method": "initialise", "signature": "void ObjectViewer::initialise()", "parameters": [], "returns": {"type": "void"}}
```

--------------------------------

### ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISVehicleAnimalUI

This method returns a number representing the delay before joypad navigation starts. This delay can be configured to prevent accidental rapid navigation. It provides fine-grained control over navigation responsiveness.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### Lua TutorialStep Class API Reference

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classTutorialStep

This API documentation describes the 'TutorialStep' class, a core component in Project Zomboid's Lua environment for managing in-game tutorial sequences. It inherits functionality from 'ISBaseObject' and provides methods for step initialization, progress tracking, message display, and completion handling.

```APIDOC
class TutorialStep extends ISBaseObject {
  // Constructor
  new(type: table): TutorialStep;

  // Public Member Functions
  begin(): void;
  isComplete(): boolean;
  finish(): void;
  during(): void;
  onClose(message: nil): void;
  addMessage(text: string, x: number, y: number): void;
  doMessage(): void;

  // Public Attributes
  messages: LuaList;

  // Inherited Public Member Functions from ISBaseObject
  initialise(): void;
  derive(type: string): ISBaseObject;
  addEventListener(_event: string, _callback: function, _target: unknown): void;
  removeEventListener(_event: string, _callback: function): void;
  triggerEvent(_event: string, ...args: unknown[]): void;
  clearEventListeners(): void;
  new(): ISBaseObject; // Constructor for ISBaseObject

  // Inherited Public Attributes from ISBaseObject
  Type: string;
  __eventListeners: table<string, table<function, unknown>>;
}
```

--------------------------------

### Lua ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISCraftRecipeQueriesPanel

This method retrieves the delay, in milliseconds, before a joypad navigation start event is processed. This can be used to fine-tune the responsiveness of joypad navigation for the UI element.

```APIDOC
Method: getJoypadNavigateStartDelay
Class: ISUIElement
Return Type: number (The delay in milliseconds)
Parameters: None
```

--------------------------------

### ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISCharacterDebugUI

This method retrieves the delay in milliseconds before joypad navigation starts. This can be used to fine-tune the responsiveness of UI navigation. It returns a numerical value representing the delay.

```APIDOC
Method: getJoypadNavigateStartDelay
Return Type: number
Parameters: (none)
```

--------------------------------

### ServerSettingsScreen Class API Reference

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classServerSettingsScreen-members

Comprehensive API documentation for the ServerSettingsScreen class, including its own methods and properties, as well as those inherited from ISBaseObject, ISUIElement, and ISPanelJoypad. This reference details method signatures, parameter types, and return values.

```APIDOC
{
  "class": "ServerSettingsScreen",
  "description": "Represents the Server Settings screen in Project Zomboid's UI, inheriting from ISPanelJoypad.",
  "inherits": ["ISPanelJoypad"],
  "members": [
    {
      "name": "__eventListeners",
      "type": "property",
      "description": "Internal property for managing event listeners.",
      "dataType": "unknown",
      "inheritedFrom": "ISBaseObject"
    },
    {
      "name": "aboutToShow",
      "type": "method",
      "description": "Called when the ServerSettingsScreen is about to be displayed.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ServerSettingsScreen"
    },
    {
      "name": "addChild",
      "type": "method",
      "description": "Adds a child UI element to this element.",
      "parameters": [
        {"name": "otherElement", "type": "ISUIElement", "description": "The UI element to add as a child."}
      ],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "addEventListener",
      "type": "method",
      "description": "Registers an event listener for a specific event.",
      "parameters": [
        {"name": "_event", "type": "string", "description": "The name of the event to listen for."},
        {"name": "_callback", "type": "function", "description": "The function to call when the event occurs."},
        {"name": "_target", "type": "unknown", "description": "The target object for the callback function."}
      ],
      "returns": {"type": "void"},
      "inheritedFrom": "ISBaseObject"
    },
    {
      "name": "addScrollBars",
      "type": "method",
      "description": "Adds scroll bars to the UI element.",
      "parameters": [
        {"name": "addHorizontal", "type": "boolean", "description": "True to add horizontal scroll bars; otherwise, vertical."}
      ],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "addToUIManager",
      "type": "method",
      "description": "Adds the UI element to the UI manager for rendering.",
      "parameters": [],      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "anchorBottom",
      "type": "property",
      "description": "Defines the bottom anchoring behavior of the UI element.",
      "dataType": "unknown",
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "anchorLeft",
      "type": "property",
      "description": "Defines the left anchoring behavior of the UI element.",
      "dataType": "unknown",
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "anchorRight",
      "type": "property",
      "description": "Defines the right anchoring behavior of the UI element.",
      "dataType": "unknown",
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "anchorTop",
      "type": "property",
      "description": "Defines the top anchoring behavior of the UI element.",
      "dataType": "unknown",
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "background",
      "type": "property",
      "description": "The background setting for the panel.",
      "dataType": "unknown",
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "backgroundColor",
      "type": "property",
      "description": "The background color of the panel.",
      "dataType": "unknown",
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "backMost",
      "type": "method",
      "description": "Sends the UI element to the very back of the rendering order.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "borderColor",
      "type": "property",
      "description": "The border color of the panel.",
      "dataType": "unknown",
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "bringToTop",
      "type": "method",
      "description": "Brings the UI element to the very front of the rendering order.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "centerOnScreen",
      "type": "method",
      "description": "Centers the UI element on the screen for a specific player.",
      "parameters": [
        {"name": "playerNum", "type": "integer", "description": "The player number for whom to center the element."}
      ],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "children",
      "type": "property",
      "description": "A collection of child UI elements.",
      "dataType": "table",
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "clampStencilRectToParent",
      "type": "method",
      "description": "Clamps the stencil rectangle to the parent's boundaries.",
      "parameters": [
        {"name": "x", "type": "number", "description": "X coordinate of the stencil rectangle."},n        {"name": "y", "type": "number", "description": "Y coordinate of the stencil rectangle."},n        {"name": "w", "type": "number", "description": "Width of the stencil rectangle."},n        {"name": "h", "type": "number", "description": "Height of the stencil rectangle."}
      ],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "clearChildren",
      "type": "method",
      "description": "Removes all child UI elements from this element.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "clearEventListeners",
      "type": "method",
      "description": "Removes all registered event listeners from the object.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISBaseObject"
    },
    {
      "name": "clearISButtonA",
      "type": "method",
      "description": "Clears the state of the 'A' button for joypad input.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "clearISButtonB",
      "type": "method",
      "description": "Clears the state of the 'B' button for joypad input.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "clearISButtons",
      "type": "method",
      "description": "Clears the states of all joypad buttons.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "clearISButtonX",
      "type": "method",
      "description": "Clears the state of the 'X' button for joypad input.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "clearISButtonY",
      "type": "method",
      "description": "Clears the state of the 'Y' button for joypad input.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "clearJoypadFocus",
      "type": "method",
      "description": "Clears the joypad focus from this panel.",
      "parameters": [
        {"name": "joypadData", "type": "JoypadData", "description": "The joypad data object."}
      ],
      "returns": {"type": "void"},
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "clearMaxDrawHeight",
      "type": "method",
      "description": "Resets the maximum drawing height constraint for the UI element.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "clearStencilRect",
      "type": "method",
      "description": "Clears the current stencil rectangle.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "close",
      "type": "method",
      "description": "Closes the panel.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISPanelJoypad"
    },
    {
      "name": "containsPoint",
      "type": "method",
      "description": "Checks if a given screen point is within the bounds of the UI element.",
      "parameters": [
        {"name": "x", "type": "number", "description": "The X coordinate of the point."},n        {"name": "y", "type": "number", "description": "The Y coordinate of the point."}
      ],
      "returns": {"type": "boolean"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "containsPointLocal",
      "type": "method",
      "description": "Checks if a given local point is within the bounds of the UI element.",
      "parameters": [
        {"name": "x", "type": "number", "description": "The local X coordinate of the point."},n        {"name": "y", "type": "number", "description": "The local Y coordinate of the point."}
      ],
      "returns": {"type": "boolean"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "controller",
      "type": "property",
      "description": "The controller object associated with this UI element.",
      "dataType": "unknown",
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "create",
      "type": "method",
      "description": "Initializes the ServerSettingsScreen instance.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ServerSettingsScreen"
    },
    {
      "name": "createChildren",
      "type": "method",
      "description": "Creates and initializes child UI elements.",
      "parameters": [],
      "returns": {"type": "void"},
      "inheritedFrom": "ISUIElement"
    },
    {
      "name": "derive",
      "type": "method",
      "description": "Checks if the object is derived from a specified type.",
      "parameters": [
        {"name": "type", "type": "string", "description": "The type name to check against."}
      ],
      "returns": {"type": "boolean"},
      "inheritedFrom": "ISBaseObject"
    },
    {
      "name": "dock",
      "type": "property",
      "description": "Defines the docking behavior of the UI element.",
      "dataType": "unknown",
      "inheritedFrom": "ISUIElement"
    }
  ]
}
```

--------------------------------

### TutorialFocus Class Lua API Reference

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classTutorialFocus-members

Detailed API documentation for the Project Zomboid Lua 'TutorialFocus' class, outlining its available methods and properties.

```APIDOC
class TutorialFocus {
  -- Methods
  onRightMouseUp(x: number, y: number): void
  prerender(): void
  static set(x: number, y: number, w: number, h: number): void
}
```

--------------------------------

### Lua ISUIElement: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classISBuildRecipePanel

This method retrieves the delay in milliseconds before joypad navigation starts. It returns a number representing the delay. This can be used to fine-tune the responsiveness of joypad navigation.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### APIDOC: Get Joypad Navigation Start Delay

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classAnimationClipViewer__Timeline

Retrieves the delay time before joypad navigation starts. This method returns a numerical value representing the delay. It can be used to fine-tune the responsiveness of joypad navigation in the UI.

```APIDOC
number getJoypadNavigateStartDelay()
```

--------------------------------

### API Reference for umbrella::ServerSettingsScreen::StringSetting

Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/index.html/classumbrella_1_1ServerSettingsScreen_1_1StringSetting-members

Documents the properties available within the `umbrella::ServerSettingsScreen::StringSetting` class, including inherited members, as part of the Project Zomboid Lua API.

```APIDOC
umbrella::ServerSettingsScreen::StringSetting Class

Description: Represents a string setting within the server settings screen, part of the Project Zomboid Lua API.

Members:
- Property: text
  Type: string
  Description: The string value associated with this setting.

- Property: type
  Type: any
  Description: An identifier for the type of this setting.
```