### Start Drawing Method Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/viewCone/ViewConeTextureFBO.html Initiates the drawing process. No specific setup is required. ```java public void startDrawing() ``` -------------------------------- ### Get Texture Y Start Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/textures/Texture.html Retrieves the starting Y coordinate of the texture. ```java float [getYStart](#getYStart )() ``` -------------------------------- ### setup Methods Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Documentation for various 'setup' methods across different classes. ```APIDOC ## setup(float, float, byte, Float) ### Description Sets up hit reaction network AI with specified parameters. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java HitReactionNetworkAI.setup(1.0f, 2.0f, (byte)1, 3.0f); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## SetupBones(ModelMesh) ### Description Sets up bones for a given ModelMesh in the Shader class. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java Shader.SetupBones(modelMesh); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## setupCoop() ### Description Sets up cooperative mode for the game server. ### Method Static method ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java GameServer.setupCoop(); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## setupFloorDepth(IsoSprite) ### Description Sets up floor depth for a given IsoSprite. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java TileDepthModifier.setupFloorDepth(isoSprite); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## setupFloorDepth(IsoSprite, TileSeamManager.Tiles) ### Description Sets up floor depth for an IsoSprite considering TileSeamManager.Tiles. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java TileSeamModifier.setupFloorDepth(isoSprite, tiles); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## setupFloorDepth(IsoSprite, TileSeamManager.Tiles, TileDepthTexture) ### Description Sets up floor depth for an IsoSprite with TileSeamManager.Tiles and TileDepthTexture. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java TileSeamModifier.setupFloorDepth(isoSprite, tiles, depthTexture); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## SetupInstancedData() ### Description Sets up instanced data for the Shader. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java Shader.SetupInstancedData(); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## setupLastSave() ### Description Sets up the last save information in AccountDBHelper. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java AccountDBHelper.setupLastSave(); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## setupRole(String, String, Color, ArrayList) ### Description Sets up a role with specified string identifiers, color, and an ArrayList. ### Method Static method ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java Roles.setupRole("roleName", "description", Color.RED, new ArrayList<>()); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## setupRole(Role, String, Color, KahluaTable) ### Description Sets up a role using a Role object, string, color, and KahluaTable. ### Method Static method ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java LuaManager.GlobalObject.setupRole(roleObject, "roleDesc", Color.BLUE, kahluaTable); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` ```APIDOC ## SetupRole ### Description Enum constant representing the setup role command. ### Method Enum constant ### Endpoint Not applicable ### Parameters None ### Request Example ```java RolesEditPacket.Command.SetupRole ``` ### Response #### Success Response (200) None #### Response Example None ``` ```APIDOC ## setupState() ### Description Sets up the current state for an AbstractStyle. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java AbstractStyle.setupState(); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` -------------------------------- ### Get Texture Start Y-Coordinate Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/interfaces/ITexture.html Returns the start Y-coordinate of the texture region. ```java float getYStart() ``` -------------------------------- ### ExampleSystem Constructor Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/entity/system/ExampleSystem.html Initializes a new instance of the ExampleSystem class. ```APIDOC ## ExampleSystem Constructor ### Description Initializes a new instance of the ExampleSystem class. ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### Get Texture Start X-Coordinate Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/interfaces/ITexture.html Returns the start X-coordinate of the texture region. ```java float getXStart() ``` -------------------------------- ### ExampleSystem Constructor Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/entity/system/ExampleSystem.html Initializes an ExampleSystem with a specified update priority. This is part of the core system setup. ```java public ExampleSystem(int updatePriority) ``` -------------------------------- ### Get Texture X Start Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/textures/Texture.html Retrieves the starting X coordinate of the texture. ```java float [getXStart](#getXStart )() ``` -------------------------------- ### Initialization and Setup Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/randomizedWorld/randomizedBuilding/RBBurntCorpse.html Methods for initializing game systems and data. ```APIDOC ## init ### Description Initializes the RandomizedBuildingBase system. ### Method Not specified ### Endpoint N/A ## initAllRBMapChance ### Description Initializes the map chance for all RandomizedBuildingBase elements. ### Method Not specified ### Endpoint N/A ``` -------------------------------- ### Get IP from GUID Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/raknet/RakNetPeerInterface.html Retrieves the IP address associated with a given GUID. ```APIDOC ## getIPFromGUID ### Description Retrieves the IP address string associated with a specific network GUID. ### Method public String getIPFromGUID ### Parameters #### Path Parameters - **guid** (long) - Required - The GUID for which to retrieve the IP address. ### Response #### Success Response (200) - **String** - The IP address of the GUID. ``` -------------------------------- ### Initialization and Setup Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/characters/IsoGameCharacter.html Methods for initializing character components and sprites. ```APIDOC ## initAttachedItems ### Description Initializes attached items for the character based on a group name. ### Method POST (assumed, as it initializes) ### Endpoint /character/initAttachedItems ### Parameters #### Query Parameters - **groupName** (String) - Required - The name of the group for attached items. ### Response #### Success Response (200) - **void** (void) - Indicates the action was performed. ## initLightInfo2 ### Description Initializes the light information for the character. ### Method POST (assumed) ### Endpoint /character/initLightInfo2 ### Parameters None ### Response #### Success Response (200) - **void** (void) - Indicates the action was performed. ## InitSpriteParts ### Description Initializes the sprite parts for the character based on their description. ### Method POST (assumed) ### Endpoint /character/InitSpriteParts ### Parameters #### Query Parameters - **desc** (SurvivorDesc) - Required - The character's description. ### Response #### Success Response (200) - **void** (void) - Indicates the action was performed. ## initSpritePartsEmpty ### Description Initializes the character's sprite parts to an empty state. ### Method POST (assumed) ### Endpoint /character/initSpritePartsEmpty ### Parameters None ### Response #### Success Response (200) - **void** (void) - Indicates the action was performed. ``` -------------------------------- ### ExampleSystem Class Documentation Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/entity/system/ExampleSystem.html Provides details on the ExampleSystem class, its constructors, and methods. ```APIDOC ## Class ExampleSystem ### Description Represents an example system within the game engine, extending the base EngineSystem. ### Class Hierarchy - java.lang.Object - zombie.entity.EngineSystem - zombie.entity.system.ExampleSystem ### Constructor Summary | Constructor | Description | |---|---| | `ExampleSystem(int updatePriority)` | Initializes a new instance of the `ExampleSystem` class with a specified update priority. | ### Method Summary | Modifier and Type | Method | Description | |---|---|---| | `void` | `addedToEngine(Engine engine)` | Called when the system is added to the engine. | | `void` | `update()` | Updates the system's state. | | `void` | `updateSimulation()` | Updates the simulation aspects of the system. | ### Inherited Methods from EngineSystem - `getEngine()` - `getRenderLastPriority()` - `getUpdatePriority()` - `getUpdateSimulationPriority()` - `isEnabled()` - `isRenderer()` - `isSimulationUpdater()` - `isUpdater()` - `removedFromEngine(Engine engine)` - `renderLast()` - `setEnabled(boolean enabled)` - `setRenderer(boolean renderer)` - `setSimulationUpdater(boolean simulationUpdater)` - `setUpdater(boolean updater)` ### Constructor Details #### ExampleSystem(int updatePriority) Initializes a new instance of the `ExampleSystem` class with a specified update priority. ### Method Details #### addedToEngine(Engine engine) Called when the system is added to the engine. #### update() Updates the system's state. #### updateSimulation() Updates the simulation aspects of the system. ``` -------------------------------- ### Get GUID of Packet Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/raknet/RakNetPeerInterface.html Retrieves the GUID associated with the current packet being processed. ```APIDOC ## getGuidOfPacket ### Description Retrieves the GUID of the packet currently being processed. ### Method public long getGuidOfPacket ### Response #### Success Response (200) - **long** - The GUID of the current packet. ``` -------------------------------- ### Get GUID from Index Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/raknet/RakNetPeerInterface.html Retrieves the unique GUID associated with a given index. ```APIDOC ## getGuidFromIndex ### Description Retrieves the unique network identifier (GUID) for a given index. ### Method public long getGuidFromIndex ### Parameters #### Path Parameters - **id** (int) - Required - The index for which to retrieve the GUID. ### Response #### Success Response (200) - **long** - The GUID associated with the provided index. ``` -------------------------------- ### setupSteamGameServer Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/network/GameServer.html Sets up the game server for Steam integration. ```APIDOC ## setupSteamGameServer ### Description Sets up the game server for Steam integration. ### Method `public static void setupSteamGameServer()` ``` -------------------------------- ### Fire Starting Properties Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/iso/objects/IsoTrap.html Methods to get and set fire starting energy and chance. ```APIDOC ## GET /api/fireStartingEnergy ### Description Retrieves the current fire starting energy. ### Method GET ### Endpoint /api/fireStartingEnergy ### Response #### Success Response (200) - **energy** (int) - The fire starting energy value. #### Response Example ```json { "energy": 10 } ``` ## POST /api/fireStartingEnergy ### Description Sets the fire starting energy. ### Method POST ### Endpoint /api/fireStartingEnergy ### Parameters #### Request Body - **fireStartingEnergy** (int) - The new value for fire starting energy. ### Request Example ```json { "fireStartingEnergy": 15 } ``` ## GET /api/fireStartingChance ### Description Retrieves the current fire starting chance. ### Method GET ### Endpoint /api/fireStartingChance ### Response #### Success Response (200) - **chance** (int) - The fire starting chance value. #### Response Example ```json { "chance": 50 } ``` ## POST /api/fireStartingChance ### Description Sets the fire starting chance. ### Method POST ### Endpoint /api/fireStartingChance ### Parameters #### Request Body - **fireStartingChance** (int) - The new value for fire starting chance. ### Request Example ```json { "fireStartingChance": 75 } ``` ``` -------------------------------- ### startServer Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/network/GameServer.html Starts the game server. This method may throw a ConnectException. ```APIDOC ## startServer ### Description Starts the game server. ### Method `public static void startServer()` ### Throws `ConnectException` - If the server fails to start due to a connection issue. ``` -------------------------------- ### On Startup Options Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/Core.html Methods to get and set options that run on startup. ```APIDOC ## GET /api/options/onStartup ### Description Retrieves an option that runs on startup. ### Method GET ### Endpoint /api/options/onStartup ### Parameters #### Query Parameters - **key** (string) - Required - The key of the option to retrieve. ### Response #### Success Response (200) - **value** (string) - The value of the requested startup option. #### Response Example ```json { "value": "load_game" } ``` ## POST /api/options/onStartup ### Description Sets an option that runs on startup. ### Method POST ### Endpoint /api/options/onStartup ### Parameters #### Request Body - **key** (string) - Required - The key of the option to set. - **value** (object) - Required - The value to set for the option. ### Request Example ```json { "key": "last_save", "value": "my_save_file" } ``` #### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "On startup option updated successfully." } ``` ``` -------------------------------- ### Matrix2fc get (ByteBuffer with offset) Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/org/joml/Matrix2f.html Gets the matrix elements into a ByteBuffer starting at the specified offset. ```APIDOC ## POST /api/matrix2fc/get/bytebuffer/{offset} ### Description Gets the matrix elements and stores them into the provided ByteBuffer, starting at the specified offset. ### Method POST ### Endpoint /api/matrix2fc/get/bytebuffer/{offset} ### Parameters #### Path Parameters - **offset** (int) - Required - The starting offset in the ByteBuffer. #### Request Body - **byteBuffer** (ByteBuffer) - Required - The ByteBuffer to store the matrix elements. ### Request Example ```json { "offset": 10, "byteBuffer": "[buffer_data]" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the operation was successful. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### Matrix2fc get (FloatBuffer with offset) Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/org/joml/Matrix2f.html Gets the matrix elements into a FloatBuffer starting at the specified offset. ```APIDOC ## POST /api/matrix2fc/get/floatbuffer/{offset} ### Description Gets the matrix elements and stores them into the provided FloatBuffer, starting at the specified offset. ### Method POST ### Endpoint /api/matrix2fc/get/floatbuffer/{offset} ### Parameters #### Path Parameters - **offset** (int) - Required - The starting offset in the FloatBuffer. #### Request Body - **floatBuffer** (FloatBuffer) - Required - The FloatBuffer to store the matrix elements. ### Request Example ```json { "offset": 10, "floatBuffer": "[buffer_data]" } ``` ### Response #### Success Response (200) - **status** (string) - Indicates the operation was successful. #### Response Example ```json { "status": "success" } ``` ``` -------------------------------- ### setUpdate Methods Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Documentation for 'setUpdate' methods. ```APIDOC ## setUpdate(IsoPlayer, IsoPlayer, ByteBuffer) ### Description Updates body damage information for players using a ByteBuffer. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java BodyDamageUpdatePacket.setUpdate(player1, player2, byteBuffer); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` -------------------------------- ### Rendering Matrix and Setup Utilities Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/iso/fboRenderChunk/FBORenderChunkCamera.html Provides methods for managing rendering matrices and setting up the rendering environment. ```APIDOC ## set ### Description Sets up rendering for a specific chunk with position and angle. ### Method void ### Parameters #### Path Parameters - **renderChunk** (FBORenderChunk) - Required - The chunk to render. - **x** (float) - Required - The x-coordinate. - **y** (float) - Required - The y-coordinate. - **z** (float) - Required - The z-coordinate. - **angle** (float) - Required - The rotation angle. ## pushProjectionMatrix ### Description Pushes the current projection matrix onto the stack. ### Method void ## pushModelViewMatrix ### Description Pushes the model-view matrix onto the stack with specified origin and angle, optionally for vehicles. ### Method void ### Parameters #### Path Parameters - **ox** (float) - Required - The origin x-coordinate. - **oy** (float) - Required - The origin y-coordinate. - **oz** (float) - Required - The origin z-coordinate. - **useangle** (float) - Required - The angle to use. - **vehicle** (boolean) - Required - Whether this is for a vehicle. ## DoPushIsoStuff ### Description Performs the necessary push operations for ISO rendering, including matrix transformations. ### Method void ### Parameters #### Path Parameters - **ox** (float) - Required - The origin x-coordinate. - **oy** (float) - Required - The origin y-coordinate. - **oz** (float) - Required - The origin z-coordinate. - **useangle** (float) - Required - The angle to use. - **vehicle** (boolean) - Required - Whether this is for a vehicle. ## DoPopIsoStuff ### Description Performs the necessary pop operations for ISO rendering, restoring previous states. ### Method void ## Begin ### Description Begins the rendering process. Specified by `[Begin](../../core/opengl/IModelCamera.html#Begin())` in interface `[IModelCamera](../../core/opengl/IModelCamera.html "interface in zombie.core.opengl")`. ### Method void ## End ### Description Ends the rendering process. Specified by `[End](../../core/opengl/IModelCamera.html#End())` in interface `[IModelCamera](../../core/opengl/IModelCamera.html "interface in zombie.core.opengl")`. ### Method void ``` -------------------------------- ### Show Survival Guide Options Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/Core.html Methods to get and set the option to show the survival guide. ```APIDOC ## GET /api/options/showSurvivalGuide ### Description Retrieves the current setting for showing the survival guide. ### Method GET ### Endpoint /api/options/showSurvivalGuide ### Response #### Success Response (200) - **enabled** (boolean) - Indicates if the survival guide is shown. #### Response Example ```json { "enabled": true } ``` ## POST /api/options/showSurvivalGuide ### Description Sets the option to show the survival guide. ### Method POST ### Endpoint /api/options/showSurvivalGuide ### Parameters #### Request Body - **enabled** (boolean) - Required - Set to true to show, false to hide. ### Request Example ```json { "enabled": false } ``` #### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Show survival guide option updated successfully." } ``` ``` -------------------------------- ### Eject Ammo Start Sound API Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/inventory/types/HandWeapon.html Method to get the eject ammo start sound name. ```APIDOC ## GET /api/ejectAmmoStartSound ### Description Retrieves the name of the eject ammo start sound. ### Method GET ### Endpoint /api/ejectAmmoStartSound ### Response #### Success Response (200) - **ejectAmmoStartSound** (string) - The name of the eject ammo start sound. #### Response Example ```json { "ejectAmmoStartSound": "start_sound.wav" } ``` ``` -------------------------------- ### ZomboidFileSystem init() Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-9.html Initializes the ZomboidFileSystem. ```APIDOC ## ZomboidFileSystem init() ### Description Initializes the ZomboidFileSystem. ### Method Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ### Response Example None ``` -------------------------------- ### Fire Starting Chance API Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/inventory/types/HandWeapon.html Methods to get and set the player's fire starting chance. ```APIDOC ## GET /api/fireStartingChance ### Description Retrieves the current fire starting chance. ### Method GET ### Endpoint /api/fireStartingChance ### Response #### Success Response (200) - **fireStartingChance** (int) - The player's fire starting chance. #### Response Example ```json { "fireStartingChance": 50 } ``` ## POST /api/fireStartingChance ### Description Sets the player's fire starting chance. ### Method POST ### Endpoint /api/fireStartingChance ### Parameters #### Request Body - **fireStartingChance** (int) - Required - The new fire starting chance value. ### Request Example ```json { "fireStartingChance": 75 } ``` ### Response #### Success Response (200) - **message** (string) - Confirmation message. #### Response Example ```json { "message": "Fire starting chance updated successfully." } ``` ``` -------------------------------- ### RakNetPeerInterface Startup Method Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Details the Startup method for initializing the RakNetPeerInterface. ```APIDOC ## RakNetPeerInterface Startup(int) ### Description Initializes the RakNetPeerInterface with a specified integer value. ### Method Method ### Endpoint N/A (Method within a class) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Parameters - **port** (int) - Description of the integer parameter for startup. ### Request Example N/A ### Response #### Success Response (200) N/A #### Response Example N/A ``` -------------------------------- ### Initialization and Configuration Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/debug/DebugLog.html Methods for initializing the system and loading debug configurations. ```APIDOC ## POST /api/init ### Description Initializes the system. This method should be called before other operations. ### Method POST ### Endpoint /api/init ### Response #### Success Response (200) (No specific response body defined, typically indicates success) #### Response Example ```json { "status": "initialized" } ``` ``` ```APIDOC ## POST /api/debug/config/load ### Description Loads the debug configuration from a specified file path. ### Method POST ### Endpoint /api/debug/config/load ### Parameters #### Request Body - **filepath** (String) - Required - The path to the debug configuration file. ### Request Example ```json { "filepath": "/path/to/debug.config" } ``` ### Response #### Success Response (200) (No specific response body defined, typically indicates success) #### Response Example ```json { "status": "config_loaded" } ``` ``` -------------------------------- ### Fire Starting and Noise Properties Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/inventory/types/HandWeapon.html Methods for getting and setting fire starting chance and noise range/duration. ```APIDOC ## GET /api/fireStartingChance ### Description Retrieves the current fire starting chance. ### Method GET ### Endpoint /api/fireStartingChance ### Response #### Success Response (200) - **chance** (float) - The fire starting chance. #### Response Example ```json { "chance": 0.5 } ``` ## POST /api/fireStartingChance ### Description Sets the fire starting chance. ### Method POST ### Endpoint /api/fireStartingChance ### Parameters #### Request Body - **chance** (float) - The new fire starting chance. ### Request Example ```json { "chance": 0.7 } ``` ## GET /api/noiseRange ### Description Retrieves the current noise range. ### Method GET ### Endpoint /api/noiseRange ### Response #### Success Response (200) - **range** (int) - The noise range. #### Response Example ```json { "range": 10 } ``` ## POST /api/noiseRange ### Description Sets the noise range. ### Method POST ### Endpoint /api/noiseRange ### Parameters #### Request Body - **range** (int) - The new noise range. ### Request Example ```json { "range": 15 } ``` ## GET /api/noiseDuration ### Description Retrieves the current noise duration. ### Method GET ### Endpoint /api/noiseDuration ### Response #### Success Response (200) - **duration** (int) - The noise duration. #### Response Example ```json { "duration": 5 } ``` ``` -------------------------------- ### Get Distance Of Point From Start Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/characters/animals/pathfind/NestedPath.html Retrieves the distance of a specified point from the starting point in the game world. ```APIDOC ## GET /api/game/point/distance ### Description Retrieves the distance of a specified point from the starting point. ### Method GET ### Endpoint /api/game/point/distance ### Parameters #### Query Parameters - **pointIndex** (int) - Required - The index of the point to measure the distance from. ### Response #### Success Response (200) - **distance** (float) - The calculated distance from the start point. ``` -------------------------------- ### GameServer - startServer Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Starts the game server. ```APIDOC ## startServer() ### Description Starts the game server. ### Method Static method ### Endpoint (Not applicable, this is a Java method) ### Parameters #### Path Parameters (None) #### Query Parameters (None) #### Request Body (None) ### Request Example (None) ### Response #### Success Response (200) (Not specified) #### Response Example (None) ``` -------------------------------- ### Style Setup Methods Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Methods for setting up rendering states for different style types. ```APIDOC ## setupState() ### Description Called to set up GL rendering state before actual drawing is done. ### Method Various (e.g., AdditiveStyle, LightingStyle, TransparentStyle, UIFBOStyle) ### Endpoint N/A (Internal method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### Mechanic Skill Installer and Mod Data Methods Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/vehicles/VehiclePart.html Methods for getting mechanic skill installer and mod data. ```APIDOC ## getMechanicSkillInstaller ### Description Retrieves the mechanic skill installer, likely related to crafting or repair. ### Method (Implicitly a method call, signature provided) ### Endpoint N/A (Java method reference) ### Parameters None specified. ## getModData ### Description Retrieves mod-specific data associated with an object. ### Method (Implicitly a method call, signature provided) ### Endpoint N/A (Java method reference) ### Parameters None specified. ``` -------------------------------- ### Game Start Month API Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/GameTime.html Methods to get and set the starting month of the year for the game, as defined by sandbox options. ```APIDOC ## GET /api/game/startMonth ### Description Retrieves the starting month of the year for the game, as defined by sandbox options. This value can change if sandbox options are modified. ### Method GET ### Endpoint /api/game/startMonth ### Response #### Success Response (200) - **startMonth** (int) - 0-indexed month of the year the game started on. #### Response Example ```json { "startMonth": 3 } ``` ## POST /api/game/startMonth ### Description Sets the starting month of the year for the game, as defined by sandbox options. Changing this value does not affect the overall age of the world. ### Method POST ### Endpoint /api/game/startMonth ### Parameters #### Request Body - **startMonth** (int) - Required - 0-indexed month of the year the game started on. ### Request Example ```json { "startMonth": 7 } ``` ``` -------------------------------- ### setUpdater Method Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Documentation for the 'setUpdater' method. ```APIDOC ## setUpdater(boolean) ### Description Enables or disables the updater for an EngineSystem. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java EngineSystem.setUpdater(true); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` -------------------------------- ### Game Start Day API Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/GameTime.html Methods to get and set the starting day of the month for the game, as defined by sandbox options. ```APIDOC ## GET /api/game/startDay ### Description Retrieves the starting day of the month for the game, as defined by sandbox options. This value can change if sandbox options are modified. ### Method GET ### Endpoint /api/game/startDay ### Response #### Success Response (200) - **startDay** (int) - 0-indexed day of the month the game started on. #### Response Example ```json { "startDay": 0 } ``` ## POST /api/game/startDay ### Description Sets the starting day of the month for the game, as defined by sandbox options. Changing this value does not affect the overall age of the world. ### Method POST ### Endpoint /api/game/startDay ### Parameters #### Request Body - **startDay** (int) - Required - 0-indexed day of the month the game started on. ### Request Example ```json { "startDay": 5 } ``` ``` -------------------------------- ### setUpdatePeriod Method Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Documentation for the 'setUpdatePeriod' method. ```APIDOC ## setUpdatePeriod(long) ### Description Sets the update period for an UpdateLimit object. ### Method Not specified (assumed Java method call) ### Endpoint Not applicable (Java method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java UpdateLimit.setUpdatePeriod(1000L); ``` ### Response #### Success Response (200) None (void method) #### Response Example None ``` -------------------------------- ### Game Start Time of Day API Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/GameTime.html Methods to get and set the starting time of day for the game, as defined by sandbox options. ```APIDOC ## GET /api/game/startTimeOfDay ### Description Retrieves the starting time of day for the game, as defined by sandbox options. This value can change if sandbox options are modified. ### Method GET ### Endpoint /api/game/startTimeOfDay ### Response #### Success Response (200) - **startTimeOfDay** (float) - The time of day in hours the game started at. #### Response Example ```json { "startTimeOfDay": 8.5 } ``` ## POST /api/game/startTimeOfDay ### Description Sets the starting time of day for the game, as defined by sandbox options. ### Method POST ### Endpoint /api/game/startTimeOfDay ### Parameters #### Request Body - **startTimeOfDay** (float) - Required - The time of day in hours the game started at. ### Request Example ```json { "startTimeOfDay": 14.0 } ``` ``` -------------------------------- ### Game Server Setup Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Method for setting up the Steam game server. ```APIDOC ## setupSteamGameServer() ### Description Sets up the Steam game server. ### Method Static ### Endpoint N/A (Internal method) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### Get Installed Item Mods Folders Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/ZomboidFileSystem.html Retrieves a list of mod folders for installed item mods. The output is populated into the provided ArrayList. ```Java public void getInstalledItemModsFolders(ArrayList out) ``` -------------------------------- ### Server Initialization and Configuration Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/znet/SteamGameServer.html Methods for initializing the server and configuring its properties. ```APIDOC ## Init ### Description Initializes the server with specified parameters. ### Method `public static boolean Init(String var0, int var1, int var2, int var3, String var4)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (boolean) Returns true if initialization is successful. #### Response Example `true` ``` ```APIDOC ## SetProduct ### Description Sets the product name for the server. ### Method `public static void SetProduct(String var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetGameDescription ### Description Sets the description for the game server. ### Method `public static void SetGameDescription(String var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetModDir ### Description Sets the directory for mods. ### Method `public static void SetModDir(String var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetDedicatedServer ### Description Configures the server as a dedicated server. ### Method `public static void SetDedicatedServer(boolean var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## EnableHeartBeats ### Description Enables or disables heartbeats for the server. ### Method `public static void EnableHeartBeats(boolean var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetMaxPlayerCount ### Description Sets the maximum number of players allowed on the server. ### Method `public static void SetMaxPlayerCount(int var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetServerName ### Description Sets the name of the server. ### Method `public static void SetServerName(String var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetMapName ### Description Sets the name of the map being used by the server. ### Method `public static void SetMapName(String var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetKeyValue ### Description Sets a key-value pair for server configuration. ### Method `public static void SetKeyValue(String var0, String var1)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetGameTags ### Description Sets the tags for the game server. ### Method `public static void SetGameTags(String var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` ```APIDOC ## SetRegion ### Description Sets the region for the game server. ### Method `public static void SetRegion(String var0)` ### Endpoint N/A (Static method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (void) No return value. #### Response Example None ``` -------------------------------- ### GameClient startLocalServer Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Method to start a local server. ```APIDOC ## GameClient startLocalServer ### Description Method in the zombie.network.GameClient class to start a local server. ### Method `Method` ### Endpoint `zombie.network.GameClient#startLocalServer()` ### Parameters #### Path Parameters - None #### Query Parameters - None #### Request Body - None ### Response #### Success Response (200) - None specified. ``` -------------------------------- ### Get Connection Type Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/raknet/RakNetPeerInterface.html Retrieves the type of connection for a specific GUID. ```APIDOC ## GetConnectionType ### Description Retrieves the type of network connection for a given GUID. ### Method public byte GetConnectionType ### Parameters #### Path Parameters - **guid** (long) - Required - The GUID of the connection. ### Response #### Success Response (200) - **byte** - The type of connection. ``` -------------------------------- ### Core Methods Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-19.html Methods for controlling tutorial visibility and welcome message settings. ```APIDOC ## Core Methods ### Description Methods to control tutorial visibility and welcome message settings. ### Method `setShowFirstTimeSearchTutorial(boolean)` `setShowFirstTimeSneakTutorial(boolean)` `setShowFirstTimeVehicleTutorial(boolean)` `setShowFirstTimeWeatherTutorial(boolean)` `setShownWelcomeMessageVersion(double)` ### Endpoint N/A (Java Methods) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) None #### Response Example None ``` -------------------------------- ### Get Delay Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/utils/UpdateLimit.html Retrieves the delay. No specific setup or constraints are mentioned. ```Java public long getDelay() ``` -------------------------------- ### Get Building Y Coordinate Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/core/stash/Stash.html Retrieves the Y-coordinate of the building. No setup required. ```java public int getBuildingY() ``` -------------------------------- ### ZombieSpawnRecorder init() Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-9.html Initializes the ZombieSpawnRecorder. ```APIDOC ## ZombieSpawnRecorder init() ### Description Initializes the ZombieSpawnRecorder. ### Method Method ### Endpoint N/A ### Parameters None ### Request Example None ### Response None ### Response Example None ``` -------------------------------- ### ExampleSystem Update Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/index-files/index-21.html The update() method in ExampleSystem is a placeholder or example method for system updates. ```APIDOC ## ExampleSystem.update() ### Description An example update method for a system. ### Method update() ### Endpoint N/A (Method within a class) ### Parameters None ### Request Example N/A ### Response N/A ``` -------------------------------- ### Get Tab String Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/worldMap/symbols/MapSymbolDefinitions.MapSymbolDefinition.html Returns the tab as a String. No setup or imports are required. ```java public String getTab() ``` -------------------------------- ### Get Height of Object Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/worldMap/symbols/MapSymbolDefinitions.MapSymbolDefinition.html Returns the height of the object. No setup or imports are required. ```java public int getHeight() ``` -------------------------------- ### Get Width of Object Source: https://github.com/demiurgequantified/projectzomboidjavadocs/blob/develop/zombie/worldMap/symbols/MapSymbolDefinitions.MapSymbolDefinition.html Returns the width of the object. No setup or imports are required. ```java public int getWidth() ```