### start() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISInstallVehiclePart-members.html Initiates the vehicle part installation process. ```APIDOC ## start() ### Description Starts the vehicle part installation. ### Method APIDOC ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response #### Success Response (N/A) N/A #### Response Example N/A ``` -------------------------------- ### start() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISGetOnBedAction-members.html Initiates the 'get on bed' action. ```APIDOC ## start() ### Description Starts the 'get on bed' timed action. This typically involves setting up animations and timers. ### Method This is a method of the ISGetOnBedAction class. ``` -------------------------------- ### onStart Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classdebugScenarios_1_1Trailer3Scenario__Fishing.html Callback function executed when the scenario or related system starts. Typically used for initial setup and configuration. ```APIDOC ## onStart() ### Description Initializes the scenario or related systems when the application starts. ### Method static void ### Parameters None. ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISTakeBricks.html Starts the ISTakeBricks action. ```APIDOC ## start() ### Description Initiates the ISTakeBricks action, beginning the process of taking bricks. ### Method POST ### Endpoint /ISTakeBricks/start ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISBuildAction.html Starts the build action. ```APIDOC ## start() void ISBuildAction::start | ( __| ) ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISQueueActionsAction-members.html Starts the queued actions. ```APIDOC ## start ### Description Starts the queued actions. ### Method `start()` ### Parameters None ``` -------------------------------- ### start() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISAddTakeDispenserBottle-members.html Starts the ISAddTakeDispenserBottle action. ```APIDOC ## start() ### Description Starts the ISAddTakeDispenserBottle action. ### Method APIDOC ### Endpoint N/A ### Parameters None ### Request Example ```APIDOC ISAddTakeDispenserBottle.start() ``` ### Response #### Success Response (N/A) No specific response documented. #### Response Example None ``` -------------------------------- ### begin() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classTutorialStep.html Starts the tutorial step. ```APIDOC ## ◆ begin() void TutorialStep::begin | ( | __| ) ``` -------------------------------- ### start() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISWaitWhileGettingUp.html Starts the 'wait while getting up' action. ```APIDOC ## ◆ start() void ISWaitWhileGettingUp::start | ( | __| ) | ``` -------------------------------- ### OnGameStart Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classSurvivalGuideManager.html Static function called when the game starts. Used for general game start initialization for the Survival Guide. ```APIDOC ## OnGameStart ### Description Static function called when the game starts. Used for general game start initialization for the Survival Guide. ### Method static void ### Parameters None ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISCollapsableWindow.html Performs initial setup for the window. ```APIDOC ## initialise() ### Description Sets up the initial state and properties of the collapsable window. ``` -------------------------------- ### startTutorial Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classMainScreen-members.html Starts the game tutorial. ```APIDOC ## startTutorial ### Description Starts the game tutorial. ### Method static void startTutorial() ### Endpoint N/A (Static method) ``` -------------------------------- ### ISGetHutchInfo.start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISGetHutchInfo-members.html Starts the process of getting hutch information. ```APIDOC ## ISGetHutchInfo.start() ### Description Initiates the process of getting hutch information. This method is typically called to begin the action. ### Returns (void) ``` -------------------------------- ### getJoypadNavigateStartDelay Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classBootstrapConnectPopup-members.html Gets the delay before joypad navigation starts. ```APIDOC ## getJoypadNavigateStartDelay() ### Description Returns the time delay in milliseconds before the joypad navigation actions begin to repeat when a direction is held down. This controls the responsiveness of navigation. ### Method ISUIElement ``` -------------------------------- ### begin() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classWelcomeStep.html Starts the WelcomeStep, typically called when the tutorial step is activated. ```APIDOC ## ◆ begin() void WelcomeStep::begin | ( | __| ) | ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISBuildPanel.html Performs initial setup for the build panel. ```APIDOC ## initialise() ### Description Executes the initial setup and configuration for the ISBuildPanel. This is typically called once after the panel is created. ``` -------------------------------- ### ongamestart Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classDebugScenarios-members.html A static function within DebugScenarios that is called when the game starts. It is intended for initialization or setup related to game start events. ```APIDOC ## ongamestart() ### Description Static function called automatically when the game begins. Used for game start initialization within DebugScenarios. ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISBaseIcon.html Performs initial setup for the icon. ```APIDOC ## initialise() ### Description Performs the initial setup and initialization procedures for the icon. ### Method `ISBaseIcon::initialise` ### Parameters None ### Return Value void ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISTutorialSetInfo.html Initializes the tutorial set. ```APIDOC ## initialise() ### Description Initializes the tutorial set. This might prepare the first page or set up internal states. ``` -------------------------------- ### getDuration Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISStartVehicleEngine.html Gets the remaining duration of the vehicle engine start action. ```APIDOC ## getDuration() ### Description Returns the remaining duration of the vehicle engine start action. ### Returns * (number) - The remaining time in seconds. ``` -------------------------------- ### ISFitnessAction::startMS Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISFitnessAction.html Gets the start time in milliseconds for the fitness action. ```APIDOC ## startMS number ISFitnessAction::startMS ### Description Gets the start time of the action in milliseconds. ### Return Value (number) The start time in milliseconds. ``` -------------------------------- ### startTutorial() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classMainScreen.html Initiates the tutorial sequence. ```APIDOC ## startTutorial() ### Description Initiates the tutorial sequence. ### Method void MainScreen::startTutorial() ``` -------------------------------- ### waitToStart() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISInstallVehiclePart-members.html Waits for the appropriate conditions to start the vehicle part installation. ```APIDOC ## waitToStart() ### Description Pauses the execution until the conditions are met to begin the vehicle part installation. ### Method APIDOC ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response #### Success Response (N/A) N/A #### Response Example N/A ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classLoadGameScreen.html Performs initial setup for the LoadGameScreen. ```APIDOC ## initialise ### Description Sets up the initial state and properties of the LoadGameScreen when it is first loaded or activated. ### Signature `LoadGameScreen:initialise()` ``` -------------------------------- ### Initialization and Setup Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classMainOptions.html Functions for initializing and setting up the main options interface. ```APIDOC ## initialise ### Description Initializes the main options interface. ### Method void ### Endpoint N/A ## instantiate ### Description Instantiates the main options. ### Method void ### Endpoint N/A ## setResolutionAndFullScreen ### Description Sets the game's resolution and fullscreen mode. ### Method void ### Endpoint N/A ``` -------------------------------- ### ISPanelJoypad::ISCollapsableWindowJoypad::getJoypadNavigateStartDelay Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISLiteratureUI-members.html Gets the delay before navigation starts with joypad input. ```APIDOC ## ISPanelJoypad::ISCollapsableWindowJoypad::getJoypadNavigateStartDelay ### Description Retrieves the configured delay in milliseconds before navigation actions are triggered by joypad input. ### Method (Implicitly a method call) ### Returns - **number**: The delay in milliseconds. ``` -------------------------------- ### ISPanelJoypad::getJoypadNavigateStartDelay Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISCollapsableWindowJoypad-members.html Gets the delay before navigation starts for joypad input. This method is part of the ISPanelJoypad class. ```APIDOC ## ISPanelJoypad::getJoypadNavigateStartDelay ### Description Gets the delay before navigation starts for joypad input. ### Method ``` ISPanelJoypad:getJoypadNavigateStartDelay() ``` ### Returns - **number**: The navigation start delay. ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classMainScreen.html Initializes the MainScreen. No parameters are documented. ```APIDOC ## initialise() ### Description Initializes the MainScreen component. This function does not take any parameters. ``` -------------------------------- ### getJoypadNavigateStartDelay Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISServerSandboxOptionsUI-members.html Gets the delay in milliseconds before navigation starts when a joypad button is held down. This controls the repeat rate of navigation. ```APIDOC ## getJoypadNavigateStartDelay ### Description Gets the delay in milliseconds before navigation starts when a joypad button is held down. ### Method ISUIElement.getJoypadNavigateStartDelay() ### Returns (number) The delay in milliseconds. ``` -------------------------------- ### ISScoreboard::initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISScoreboard.html Performs initial setup for the ISScoreboard. ```APIDOC ## initialise ### Description Initializes the ISScoreboard. This function should be called before using other methods. ### Method void initialise() ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISHandCraftPanel.html Performs initial setup and configuration for the panel. ```APIDOC ## initialise() ### Description Initializes the ISHandCraftPanel, setting up its state and potentially loading initial data. ### Returns void ``` -------------------------------- ### Studio::OnGameStart Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classStudio.html Handles events or setup that should occur when the game starts. This is likely called internally by the game loop. ```APIDOC ## Studio::OnGameStart ### Description Handles setup or events when the game starts. ### Method static void ### Parameters None ``` -------------------------------- ### serverStart Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISWallpaperAction.html Initiates the wallpaper action on the server. ```APIDOC ## serverStart() ### Description Starts the wallpaper action specifically on the server side. ``` -------------------------------- ### ISSplint Member Functions Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISSplint.html Public member functions available for the ISSplint class, including methods for checking validity, waiting to start, updating the action, starting, stopping, performing, completing, getting duration, and stopping sounds. ```APIDOC ## Member Function Documentation ## ◆ complete() boolean ISSplint::complete | ( | __| ) | ## ◆ getDuration() number ISSplint::getDuration | ( | __| ) | ## ◆ isValid() boolean ISSplint::isValid | ( | __| ) | ## ◆ perform() void ISSplint::perform | ( | __| ) | ## ◆ start() void ISSplint::start | ( | __| ) | ## ◆ stop() void ISSplint::stop | ( | __| ) | ## ◆ stopSound() void ISSplint::stopSound | ( | __| ) | ## ◆ update() void ISSplint::update | ( | __| ) | ## ◆ waitToStart() boolean ISSplint::waitToStart | ( | __| ) ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISAudioDebugPanel-members.html Initializes the ISAUDiodebugPanel. ```APIDOC ## initialise() ### Description Performs the initialization process for the ISAUDiodebugPanel. This method should be called before using other methods of the panel. ``` -------------------------------- ### start() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISOpenMechanicsUIAction-members.html Initiates the UI action. ```APIDOC ## start() ### Description Begins the execution of the ISOpenMechanicsUIAction. This method is responsible for setting up any necessary initial states or animations before the action's main logic is performed. ``` -------------------------------- ### ISRemoveAnimalFromTrailer Member Functions Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISRemoveAnimalFromTrailer.html Provides details on the public member functions available for the ISRemoveAnimalFromTrailer class, including methods for checking validity, waiting to start, updating the action's state, starting, stopping, performing, completing, and getting the duration. ```APIDOC ## boolean isValid() ### Description Checks if the current state of the action is valid. ## boolean waitToStart() ### Description Determines if the action should wait before starting. ## void update() ### Description Updates the state of the timed action. ## void start() ### Description Initiates the timed action. ## void stop() ### Description Stops the timed action. ## void perform() ### Description Executes the core logic of the timed action. ## boolean complete() ### Description Checks if the timed action has been completed. ## number getDuration() ### Description Returns the total duration of the timed action. ``` -------------------------------- ### OnNewGame Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classSurvivalGuideManager.html Static function called when a new game is started. Used for initializing Survival Guide related to new game states. ```APIDOC ## OnNewGame ### Description Static function called when a new game is started. Used for initializing Survival Guide related to new game states. ### Method static void ### Parameters None ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISSLEvent.html Performs initial setup for the ISSLEvent. ```APIDOC ## initialise() ### Description Sets up the initial state and configuration for the ISSLEvent. ### Parameters None. ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classRWMPower.html Performs initial setup for the RWMPower component. ```APIDOC ## initialise() ### Description Initializes the RWMPower component, setting up its initial state and configurations. ``` -------------------------------- ### Studio::OnNewGame Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classStudio.html Handles setup or events that should occur when a new game is started. This is distinct from OnGameStart, focusing on new game initialization. ```APIDOC ## Studio::OnNewGame ### Description Handles setup or events when a new game is started. ### Method static void ### Parameters None ``` -------------------------------- ### doTutorialInit Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/globals_func_d.html Initializes the tutorial. ```APIDOC ## doTutorialInit() ### Description Initializes the tutorial. ### Method N/A (Lua function) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response N/A ### File TutorialSetup.yml ``` -------------------------------- ### ISCleanGraffiti Member Functions Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISCleanGraffiti.html Provides details on the public member functions available for the ISCleanGraffiti class, including methods for checking validity, starting, updating, performing, stopping, completing, and getting the duration of the action. ```APIDOC ## Public Member Functions ### isValid() - **Returns**: boolean - **Description**: Checks if the current state of the action is valid. ### waitToStart() - **Returns**: boolean - **Description**: Determines if the action is ready to start. ### update() - **Description**: Updates the state of the graffiti cleaning action. ### start() - **Description**: Initiates the graffiti cleaning action. ### stop() - **Description**: Halts the graffiti cleaning action. ### perform() - **Description**: Executes a step of the graffiti cleaning action. ### complete() - **Returns**: boolean - **Description**: Marks the graffiti cleaning action as complete. ### getDuration() - **Returns**: number - **Description**: Retrieves the total duration of the graffiti cleaning action. ``` -------------------------------- ### ISAudioDebugPanel::initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISAudioDebugPanel.html Initializes the ISAudioDebugPanel. ```APIDOC ## ISAudioDebugPanel::initialise ### Description Initializes the ISAudioDebugPanel. ### Return Value void ### Signature void initialise () ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISToggleLightSourceAction.html Starts the ISToggleLightSourceAction. ```APIDOC ## start() ### Description Initiates the ISToggleLightSourceAction. This typically involves setting up the action and potentially starting animations or timers. ``` -------------------------------- ### Initialization Method Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISGameDebugPanel-members.html Performs the initial setup for the ISGameDebugPanel. ```APIDOC ## initialise() ### Description Initializes the ISGameDebugPanel. This method should be called after the panel has been created. ### Method `initialise()` ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISPickAxeGroundCoverItem-members.html Starts the ISPickAxeGroundCoverItem. ```APIDOC ## start() ### Description Starts the ISPickAxeGroundCoverItem. ### Signature start() ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classWatchWindow.html Initializes the watch window, performing setup operations. ```APIDOC ## initialise ### Description Performs the necessary initialization steps for the WatchWindow. This is typically called once after the window is created. ### Method `void initialise()` ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISCheckAnimalInsideTrailer.html Starts the action. ```APIDOC ## start() ### Description Initiates the action. This is called when the action begins. ``` -------------------------------- ### aboutToShowStartScreen Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classServerSettingsScreen_1_1ServerSettingsScreenWorkshopPanel.html Handles the display logic when transitioning to the start screen. ```APIDOC ## aboutToShowStartScreen() ### Description Handles the display logic when transitioning to the start screen. ### Method void ### Endpoint ServerSettingsScreen::ServerSettingsScreenWorkshopPanel::aboutToShowStartScreen ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISBBQLightFromKindle-members.html Starts the ISBBQLightFromKindle. ```APIDOC ## start ### Description Starts the ISBBQLightFromKindle. ### Method N/A (Method call) ### Signature start() ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISBBQLightFromLiterature-members.html Starts the light. ```APIDOC ## start ### Description Starts the light. ### Method N/A (Method call) ### Endpoint N/A ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISWallpaperAction.html Initiates the wallpaper action. ```APIDOC ## start() ### Description Begins the execution of the wallpaper action. ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISWearClothing.html Starts the clothing action. ```APIDOC ## ◆ start() void ISWearClothing::start | ( __| ) ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISWashYourself.html Starts the washing action. ```APIDOC ## start() ### Description Starts the washing action. This typically involves setting up animations and timers. ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISMultiStageBuild.html Initiates the multi-stage build action. ```APIDOC ## start() ### Description Begins the multi-stage build process. ``` -------------------------------- ### create Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classServerSettingsScreen.html Initializes the ServerSettingsScreen UI elements. ```APIDOC ## create() ### Description Sets up the UI elements and layout for the ServerSettingsScreen. ### Returns `void` ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISToggleClothingWasher.html Starts the ISToggleClothingWasher action. ```APIDOC ## start() ### Description Initiates the timed action, setting its initial state and starting timers. ### Returns - **void** ``` -------------------------------- ### initialise Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISDemoPopup.html Performs initial setup for the ISDemoPopup. ```APIDOC ## initialise() ### Description Sets up the initial state and properties of the ISDemoPopup after it has been created. ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISTakeGenerator.html Starts the ISTakeGenerator action. ```APIDOC ## start() ### Description Initiates the timed action managed by the ISTakeGenerator. ``` -------------------------------- ### serverStart Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISLightFromKindle-members.html Initiates the light source creation on the server. ```APIDOC ## serverStart() ### Description Starts the light source creation process on the server. ``` -------------------------------- ### start Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISTakeFuel-members.html Starts the ISTakeFuel action. ```APIDOC ## start ### Description Starts the ISTakeFuel action. ### Method N/A (This is a method call, not an HTTP endpoint) ### Endpoint N/A ### Parameters None explicitly documented. ### Request Example ```lua ISTakeFuel.start() ``` ### Response None explicitly documented. ``` -------------------------------- ### start() Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISPlantInfoAction-members.html Starts the plant info action. ```APIDOC ## start() ### Description Initiates the plant info action. ### Method `ISPlantInfoAction:start()` ``` -------------------------------- ### serverStart Source: https://demiurgequantified.github.io/ProjectZomboidLuaDocs/classISPetAnimal.html Starts the pet animal action on the server. ```APIDOC ## serverStart() ### Description Initiates the pet animal action specifically on the server side. ```