### lambda$setup$0 Event Handler Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html Handles the LoadAssetEvent for setup. ```APIDOC ## private void lambda$setup$0 ### Description Handles the `LoadAssetEvent` during the server setup process. ### Method `private void` ### Endpoint N/A (Internal Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example N/A ### Response #### Success Response (void) This method returns void. #### Response Example N/A ``` -------------------------------- ### lambda$setup$1 Event Handler Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html Handles the AssetPackRegisterEvent for setup. ```APIDOC ## private void lambda$setup$1 ### Description Handles the `AssetPackRegisterEvent` during the server setup process. ### Method `private void` ### Endpoint N/A (Internal Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example N/A ### Response #### Success Response (void) This method returns void. #### Response Example N/A ``` -------------------------------- ### WorldLocationConditionPlugin setup Method Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/WorldLocationConditionPlugin.html The setup() method for WorldLocationConditionPlugin. ```APIDOC ## WorldLocationConditionPlugin setup Method ### Description The `setup()` method is called during the plugin initialization process. ### Method `protected void` ### Endpoint N/A (Method within a class) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```json { "action": "call setup method" } ``` ### Response #### Success Response (Method Execution) - **status** (string) - Indicates successful execution of the setup method. #### Response Example ```json { "status": "setup method executed successfully" } ``` ``` -------------------------------- ### NPCPlugin Protected Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/NPCPlugin.html These snippets define protected methods 'setup()' and 'start()' within the NPCPlugin class, intended for internal initialization and startup routines. ```java protected void setup() protected void start() ``` -------------------------------- ### On Paste Start Method Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BuilderToolsPlugin.html Handles the initiation of a pasting operation. This static method likely performs setup or validation before a prefab is placed in the world. ```Java public static boolean onPasteStart(int, [ComponentAccessor](ComponentAccessor.html)<[EntityStore](EntityStore.html)>) ``` -------------------------------- ### lambda$setup$3 Event Handler Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html Handles the LoadedAssetsEvent for setup. ```APIDOC ## private void lambda$setup$3 ### Description Handles the `LoadedAssetsEvent` during the server setup process. ### Method `private void` ### Endpoint N/A (Internal Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example N/A ### Response #### Success Response (void) This method returns void. #### Response Example N/A ``` -------------------------------- ### lambda$setup$2 Event Handler Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html Handles the AssetPackUnregisterEvent for setup. ```APIDOC ## private static void lambda$setup$2 ### Description Handles the `AssetPackUnregisterEvent` during the server setup process. ### Method `private static void` ### Endpoint N/A (Internal Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example N/A ### Response #### Success Response (void) This method returns void. #### Response Example N/A ``` -------------------------------- ### Setup Lambda Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/LegacyModule.html Internal server setup method, likely used for initialization. ```APIDOC ## POST /api/server/setup/lambda ### Description Executes the internal setup lambda function for server initialization. This is a private method and typically not intended for direct external use. ### Method POST ### Endpoint /api/server/setup/lambda ### Parameters #### Query Parameters None ### Request Example ```json {} ``` ### Response #### Success Response (200) - **status** (string) - Indicates the success of the setup operation. #### Response Example ```json { "status": "Setup lambda executed successfully." } ``` ``` -------------------------------- ### Lambda Setup Method Signature (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ReputationPlugin.html This snippet shows the private static method signature for lambda$setup$0. This method appears to be involved in the setup process and returns a ReputationGroupComponent. ```java private static ReputationGroupComponent lambda$setup$0() ``` -------------------------------- ### lambda$setup$4 Utility Method Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html A static utility method used during setup, likely for block type processing. ```APIDOC ## private static void lambda$setup$4 ### Description A static utility method called during setup, taking a Map and a BlockType as arguments. Its specific function is related to block type processing. ### Method `private static void` ### Endpoint N/A (Internal Method) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example N/A ### Response #### Success Response (void) This method returns void. #### Response Example N/A ``` -------------------------------- ### SpawningPlugin Lifecycle Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html These public methods represent the lifecycle management of the SpawningPlugin. 'setup()' is likely for initial configuration, 'start()' for activation, and 'shutdown()' for deactivation and cleanup. ```Java public void setup() public void start() public void shutdown() ``` -------------------------------- ### ServerManager Lifecycle Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ServerManager.html Contains protected methods for managing the server's lifecycle: setup(), start(), and shutdown(). These methods are intended to be overridden by subclasses or called by the framework to control the server's operational phases. The lambda$setup$0 method handles shutdown event logic. ```java protected void setup() protected void start() protected void shutdown() private void lambda$setup$0(ShutdownEvent) ``` -------------------------------- ### Lambda for setup (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html Another private static lambda function for the setup process. It returns a `SpatialStructure`, contributing to the initialization or provision of spatial data structures. This is a utility for setup. ```Java private static [SpatialStructure](SpatialStructure.html) lambda$setup$3() ``` -------------------------------- ### Lambda for setup (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html This private static lambda function is part of a setup process. It returns a `ChunkSuppressionEntry`, indicating it's involved in configuring or initializing data related to chunk suppression. This is a helper for setup routines. ```Java private static [ChunkSuppressionEntry](ChunkSuppressionEntry.html) lambda$setup$6() ``` -------------------------------- ### Lambda for setup (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html This private static lambda function is used during the setup phase. It returns a `SpatialStructure`, indicating it's responsible for initializing or providing a spatial data structure. This is a helper for setup operations. ```Java private static [SpatialStructure](SpatialStructure.html) lambda$setup$4() ``` -------------------------------- ### BuilderToolsPlugin - lambda$setup$1 Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BuilderToolsPlugin.html Internal setup method for the plugin. ```APIDOC ## POST /henry-bonikowsky/hytale-docs/lambda$setup$1 ### Description An internal private static method used during the plugin's setup process. ### Method POST ### Endpoint /henry-bonikowsky/hytale-docs/lambda$setup$1 ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **arg0** (PlayerRef) - The PlayerRef object. - **arg1** (PrefabSpawnerState) - The PrefabSpawnerState object. ### Response #### Success Response (200) - **return_value** (CustomUIPage) - A CustomUIPage object. #### Response Example ```json { "return_value": { "page_title": "Custom UI Page" } } ``` ``` -------------------------------- ### Private Static Lambda Method: lambda$setup$5 Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/InteractionModule.html Represents the private static lambda method `lambda$setup$5`. It takes PlayerRef and Ref as parameters and returns a CustomUIPage. This method is likely part of an internal setup process. ```java private static CustomUIPage lambda$setup$5(PlayerRef playerRef, Ref ref) ``` -------------------------------- ### Lambda Expression for Setup (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ObjectiveTask.html A private static method, potentially a lambda, used during the setup phase. It returns a boolean value, possibly indicating success or status. ```java private static boolean lambda$setup$0() ``` -------------------------------- ### Utility and Setup Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html Contains utility methods for configuration and setup processes within the game. ```APIDOC ## Utility and Setup Methods ### Description This section details utility methods used for game setup and configuration, including rebuilding spawn configurations and various lambda functions used internally. ### Methods - `setUpWithAllRoles` - `rebuildBeaconSpawnConfigurations` ### Parameters - `rebuildBeaconSpawnConfigurations` accepts an `IntSet` representing a set of integers. ### Request Example (No direct request examples available for these utility methods) ### Response (No direct response examples available for these utility methods) ``` -------------------------------- ### Lambda for setup (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html This private static lambda function is also part of a setup process. It returns a `FloodFillPositionSelector`, suggesting it's involved in initializing or configuring spatial selection logic. This is a utility for setup. ```Java private static [FloodFillPositionSelector](FloodFillPositionSelector.html) lambda$setup$5() ``` -------------------------------- ### Lambda for Setup Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/InstancesPlugin.html An internal lambda function likely executed during the setup phase of the server. It returns a Holder object. ```java private static Holder lambda$setup$0() ``` -------------------------------- ### BuilderToolsPlugin - lambda$setup$0 Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BuilderToolsPlugin.html Internal setup method for the plugin. ```APIDOC ## POST /henry-bonikowsky/hytale-docs/lambda$setup$0 ### Description An internal private static method used during the plugin's setup process, likely related to event handling. ### Method POST ### Endpoint /henry-bonikowsky/hytale-docs/lambda$setup$0 ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body - **arg0** (AddWorldEvent) - An AddWorldEvent object. ### Response #### Success Response (200) - **return_value** (void) - This method does not return a value. #### Response Example ```json { "message": "Operation completed successfully." } ``` ``` -------------------------------- ### Lambda for setup (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html This private static lambda function is part of the setup routine. It returns a `SpatialStructure`, indicating its role in initializing or providing a spatial data structure. This is a helper method for setup. ```Java private static [SpatialStructure](SpatialStructure.html) lambda$setup$2() ``` -------------------------------- ### Setup Plugin Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginManager.html Initializes and sets up a plugin. This private method takes a PluginBase object and returns a boolean indicating if the setup was successful. ```java private boolean setup(PluginBase pluginBase) ``` -------------------------------- ### Setup0 (Protected) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginBase.html Protected method for initial setup operations. This method is called before the main setup. ```Java protected void setup0() ``` -------------------------------- ### Lambda for Setup (0) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginManager.html A private static lambda method used in the setup process. It takes a HashMap and a PluginIdentifier. ```java private static void lambda$setup$0(HashMap hashMap, PluginIdentifier pluginIdentifier) ``` -------------------------------- ### FlockPlugin Static and Instance Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/FlockPlugin.html Provides static and instance methods for FlockPlugin, including getting the plugin instance, lifecycle management (setup, start, shutdown), and accessing component types. ```java public static FlockPlugin get() { // Implementation to get the singleton instance } public void setup() { // Setup logic } public void start() { // Start logic } public void shutdown() { // Shutdown logic } public ComponentType getFlockComponentType() { // Returns the Flock component type } public ComponentType getFlockMembershipComponentType() { // Returns the FlockMembership component type } public ComponentType getPersistentFlockDataComponentType() { // Returns the PersistentFlockData component type } ``` -------------------------------- ### Get Collision Start Point Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/StandardPhysicsProvider.html Retrieves the starting point of a collision event. This is a double getter method. ```java public double getCollisionStart() ``` -------------------------------- ### AStarBase Start and End Position Management Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/AStarBase.html This section details methods for setting and retrieving the start and end positions for pathfinding. It includes setting a `Vector3d` as the start position and retrieving it, as well as getting the computed end position. ```Java public class AStarBase { // Methods for position management public void setStartPosition(Vector3d startPosition) { // The setStartPosition() method. } public Vector3d getStartPosition() { // The getStartPosition() method. return null; // Placeholder } public Vector3d getEndPosition() { // The getEndPosition() method. return null; // Placeholder } } ``` -------------------------------- ### Get Start and End Points - Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/DistortedShape.html This Java code snippet demonstrates abstract methods to retrieve the start and end points of a geometric shape. These methods are part of an abstract class, implying they must be implemented by concrete subclasses. ```Java public abstract Vector3d getStart(); public abstract Vector3d getEnd(); ``` -------------------------------- ### Server Startup Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/Universe.html Methods related to the server's startup sequence. This includes initiating the server, handling configuration, and managing asynchronous operations using CompletableFuture and CompletionStage. ```java private static [CompletableFuture](#)[] lambda$start$2(int) ``` ```java private [CompletionStage](#) lambda$start$3([HytaleServerConfig](HytaleServerConfig.html), [Void](#)) ``` ```java private static void lambda$start$4() ``` ```java private [Void](#) lambda$start$1([String](#), [Throwable](#)) ``` -------------------------------- ### BlockTypeModule Setup and Get Block Physics Method Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BlockTypeModule.html Details the protected 'setup()' method for plugin initialization and the public 'getBlockPhysicsComponentType()' method for accessing the block physics component type. This component is used for managing chunk stores and block physics. ```java protected void setup() { // Method implementation } public ComponentType getBlockPhysicsComponentType() { // Method implementation } ``` -------------------------------- ### Setup API Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ReputationPlugin.html Provides methods for setting up server components, such as reputation group components. ```APIDOC ## POST /api/setup/reputation-group ### Description Sets up the reputation group component. ### Method POST ### Endpoint /api/setup/reputation-group ### Response #### Success Response (200) - **component** (ReputationGroupComponent) - The initialized reputation group component. #### Response Example ```json { "component": { "id": "reputation-component-123" } } ``` ``` -------------------------------- ### PathPlugin Lifecycle Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PathPlugin.html Protected methods for managing the lifecycle of the PathPlugin, including setup and start operations, as well as handling model changes. ```java protected void setup() { // Method implementation details omitted for brevity } ``` ```java protected void start() { // Method implementation details omitted for brevity } ``` ```java protected void onModelsChanged(LoadedAssetsEvent> event) { // Method implementation details omitted for brevity } ``` -------------------------------- ### Player Setup Method Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/Universe.html A private method for setting up players, returning a PlayerRef. This is likely part of the player initialization or management system. ```java private static [PlayerRef](PlayerRef.html) lambda$setup$2() ``` -------------------------------- ### Get Inventory Slot Information Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BuilderRole.html Retrieves the number of inventory slots, hotbar slots, and off-hand slots. These methods provide information about an entity's carrying capacity and equipment setup. ```java public int getInventorySlots() public int getHotbarSlots() public int getOffHandSlots() ``` -------------------------------- ### Handle Player Joining Setup Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/World.html The private `onSetupPlayerJoining()` method performs the initial setup for a player joining the world. It requires entity store, player, player reference, packet handler, transform, and two boolean flags for configuration. ```Java private void onSetupPlayerJoining(Holder, Player, PlayerRef, PacketHandler, Transform, boolean, boolean) ``` -------------------------------- ### SetupObjective Class Overview Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SetupObjective.html Provides details about the SetupObjective class, its fields, constructors, and methods. ```APIDOC ## Class: SetupObjective ### Description `SetupObjective` is a class that extends `ObjectiveTypeSetup`. It is used for setting up objectives in the Hytale Plugin API. ### Fields #### `CODEC` - **Type**: `BuilderCodec` - **Static**: `true` - **Final**: `true` - **Description**: The codec used for serializing and deserializing `SetupObjective` objects. #### `objectiveId` - **Type**: `String` - **Protected**: `true` - **Description**: The unique identifier for the objective. ### Constructors #### `SetupObjective()` - **Public**: `true` - **Description**: Creates a new instance of `SetupObjective`. ### Methods #### `getObjectiveIdToStart()` - **Public**: `true` - **Returns**: `String` - **Description**: Returns the objective ID to start. #### `setup(Set, UUID, UUID, Store)` - **Public**: `true` - **Parameters**: - `Set`: A set of UUIDs. - `UUID`: A UUID. - `UUID`: Another UUID. - `Store`: An entity store. - **Returns**: `Objective` - **Description**: Sets up the objective with the provided parameters. #### `toString()` - **Public**: `true` - **Returns**: `String` - **Description**: Returns a string representation of the `SetupObjective` object. #### `lambda$static$2()` - **Private Static**: `true` - **Returns**: `LateValidator` - **Description**: Internal method for static initialization. #### `lambda$static$1(SetupObjective)` - **Private Static**: `true` - **Parameters**: - `SetupObjective`: The `SetupObjective` instance. - **Returns**: `String` - **Description**: Internal method for static initialization. #### `lambda$static$0(SetupObjective, String)` - **Private Static**: `true` - **Parameters**: - `SetupObjective`: The `SetupObjective` instance. - `String`: A string value. - **Description**: Internal method for static initialization. ``` -------------------------------- ### AccessControlModule Initialization and Lifecycle Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/AccessControlModule.html These protected methods manage the lifecycle of the AccessControlModule. 'setup' is for initial configuration, 'start' for beginning operations, and 'shutdown' for cleanup. ```java protected void setup() protected void start() protected void shutdown() ``` -------------------------------- ### Get Roll Speed Modifiers Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/MovementConfig.html Retrieves the speed modifiers for starting and exiting a roll. These values influence the player's speed during the roll animation and its transition. ```java public float getRollStartSpeedModifier() public float getRollExitSpeedModifier() ``` -------------------------------- ### Set Up With All Roles (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html This method is responsible for setting up the system with all available roles. It's a private utility method likely used during initialization or configuration phases. It has no input parameters. ```Java private void setUpWithAllRoles() ``` -------------------------------- ### PluginState Enum Fields - Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginState.html Defines the static final fields representing the different states of a Hytale plugin. These states include NONE, SETUP, START, ENABLED, SHUTDOWN, and DISABLED. ```Java public static final PluginState NONE; public static final PluginState SETUP; public static final PluginState START; public static final PluginState ENABLED; public static final PluginState SHUTDOWN; public static final PluginState DISABLED; ``` -------------------------------- ### StaminaModule Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/StaminaModule.html Details the methods available in the StaminaModule class, including setup, retrieving sprint regeneration delay resource type, handling gameplay config loading, and getting the module instance. ```Java protected void setup(); public ResourceType getSprintRegenDelayResourceType(); protected static void onGameplayConfigsLoaded(LoadedAssetsEvent>); public static StaminaModule get(); ``` -------------------------------- ### Initialization and Configuration Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningContext.html Methods for common initialization and retrieving configuration details. ```APIDOC ## POST /api/init/common ### Description Performs common initialization tasks. ### Method POST ### Endpoint /api/init/common ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **status** (string) - Indicates the operation was successful. #### Response Example { "status": "Common initialization completed successfully" } ``` ```APIDOC ## GET /api/config/execution-context ### Description Retrieves the current execution context. ### Method GET ### Endpoint /api/config/execution-context ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example None ### Response #### Success Response (200) - **context** (ExecutionContext) - The current execution context object. #### Response Example { "context": { "field1": "value1", "field2": "value2" } } ``` -------------------------------- ### ShopPlugin Lifecycle Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ShopPlugin.html Contains protected methods for managing the lifecycle of the ShopPlugin. These include setup, start, and shutdown, which are called at appropriate times during the plugin's execution to initialize, run, and clean up shop-related services. ```java protected void setup() protected void start() protected void shutdown() ``` -------------------------------- ### Objective Setup and Task Management Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/Objective.html Documents methods related to setting up and managing tasks within an Objective. This includes methods for initial setup, setting up current tasks, and checking task set completion, all of which interact with a Store containing EntityStore. ```java public boolean setup(Store) ``` ```java public boolean setupCurrentTasks(Store) ``` ```java public boolean checkTaskSetCompletion(Store) ``` -------------------------------- ### LocalSpawnSetupSystem Class Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/LocalSpawnSetupSystem.html Documentation for the LocalSpawnSetupSystem class, which extends RefSystem. ```APIDOC ## LocalSpawnSetupSystem ### Description `LocalSpawnSetupSystem` is a class that extends `RefSystem` and is used for managing local spawn setups within the Hytale server. ### Class `com.hypixel.hytale.server.core.LocalSpawnSetupSystem` ### Fields #### private final `componentType` - **componentType** (`ComponentType`) - The component type associated with this system. ### Constructors #### public `LocalSpawnSetupSystem` - **componentType** (`ComponentType`) - Creates a new instance of `LocalSpawnSetupSystem`. ### Methods #### public `onEntityAdded` - **entity** (`Ref`) - The entity being added. - **reason** (`AddReason`) - The reason for adding the entity. - **store** (`Store`) - The store containing the entity. - **commandBuffer** (`CommandBuffer`) - The command buffer for entity operations. #### public `onEntityRemove` - **entity** (`Ref`) - The entity being removed. - **reason** (`RemoveReason`) - The reason for removing the entity. - **store** (`Store`) - The store containing the entity. - **commandBuffer** (`CommandBuffer`) - The command buffer for entity operations. #### public `getQuery` - Returns: `Query` - The query associated with this system. ``` -------------------------------- ### JavaPlugin - Plugin Entry Point Source: https://context7.com/henry-bonikowsky/hytale-docs/llms.txt The `JavaPlugin` class serves as the main entry point for Hytale server plugins. It extends `PluginBase` and grants access to registries, configuration, and lifecycle methods like `setup()`, `start()`, and `shutdown()`. Override these methods to initialize and manage your plugin's components. ```java package com.example.myplugin; import com.hypixel.hytale.server.core.plugin.JavaPlugin; import com.hypixel.hytale.server.core.plugin.JavaPluginInit; public class MyPlugin extends JavaPlugin { public MyPlugin(JavaPluginInit init) { super(init); } @Override protected void setup() { // Called during plugin initialization // Register commands, event listeners, and configurations here getLogger().info("MyPlugin is setting up!"); // Access plugin metadata String pluginName = getName(); Path dataDir = getDataDirectory(); // Check plugin state if (isEnabled()) { getLogger().info("Plugin " + pluginName + " is enabled"); } } @Override protected void start() { // Called when the server is ready // Start background tasks, connect to databases, etc. getLogger().info("MyPlugin has started!"); } @Override protected void shutdown() { // Called during server shutdown // Clean up resources, save data, etc. getLogger().info("MyPlugin is shutting down!"); } } ``` -------------------------------- ### BeaconSpawnController Spawn Management Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BeaconSpawnController.html Provides methods for managing spawn counts and states within the BeaconSpawnController. Includes methods to get the maximum active jobs, retrieve the number of spawns in the current round, set remaining spawns, add a spawn to the round, and check/set the round start status. ```java public int getMaxActiveJobs() ``` ```java public int getSpawnsThisRound() ``` ```java public void setRemainingSpawns(int remainingSpawns) ``` ```java public void addRoundSpawn() ``` ```java public boolean isRoundStart() ``` ```java public void setRoundStart(boolean roundStart) ``` -------------------------------- ### Start Plugin Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginManager.html Starts a plugin after it has been set up. This private method takes a PluginBase object and returns a boolean indicating if the start was successful. ```java private boolean start(PluginBase pluginBase) ``` -------------------------------- ### Setup NPC Loading Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/NPCPlugin.html Initializes the NPC loading process. This is a public method with no parameters and a void return type. ```java public void setupNPCLoading() ``` -------------------------------- ### LaunchPad Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/LaunchPad.html Documentation for the methods available on the LaunchPad class. ```APIDOC ## LaunchPad Methods ### Public Static Methods - **getComponentType()** (`com.hypixel.hytale.server.core.common.component.ComponentType`) - Returns the component type for `LaunchPad`. ### Public Instance Methods - **getVelocityX()** (`float`) - Returns the current velocity along the X-axis. - **getVelocityY()** (`float`) - Returns the current velocity along the Y-axis. - **getVelocityZ()** (`float`) - Returns the current velocity along the Z-axis. - **isPlayersOnly()** (`boolean`) - Returns `true` if the launch pad is restricted to players only, `false` otherwise. - **toString()** (`String`) - Returns a string representation of the `LaunchPad` object. - **clone()** (`Component`) - Creates and returns a clone of the `LaunchPad` component. - **clone()** (`Object`) throws `CloneNotSupportedException` - Overrides the default `Object.clone()` method. ``` -------------------------------- ### Setup and Update Tasks Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/Objective.html The `setupAndUpdateTasks()` method initializes and updates objective tasks. It requires an array of `ObjectiveTaskAsset` and a `Store` containing an `EntityStore`. This private method returns an array of `ObjectiveTask` objects. ```java private [ObjectiveTask](ObjectiveTask.html)[] setupAndUpdateTasks([ObjectiveTaskAsset](ObjectiveTaskAsset.html)[], [Store](Store.html)<[EntityStore](EntityStore.html)>) ``` -------------------------------- ### Handle Map and BlockType in Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html The lambda$setup$4 method is a private static void method that takes a Map and a BlockType as arguments. Its specific function is not detailed but likely involves block or map manipulation. ```java private static void lambda$setup$4(Map map, BlockType blockType) ``` -------------------------------- ### ShortBytePalette Get Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ShortBytePalette.html Offers methods to retrieve data from the ShortBytePalette. It includes a method to get a value at specific coordinates and another to get a value at a single index. ```java public short get(int, int) public short get(int) ``` -------------------------------- ### Handle LoadAssetEvent in Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html The lambda$setup$0 method is a private void method that processes the LoadAssetEvent. This indicates its involvement in the server's asset loading pipeline. ```java private void lambda$setup$0(LoadAssetEvent event) ``` -------------------------------- ### Setup Lambda Methods (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/NPCPlugin.html A collection of lambda methods used during the setup phase of the server. These methods return various internal types such as ValueStore, StateEvaluator, Timers, StepComponent, SpatialStructure, Conditions, ItemAttitudeGroups, and AttitudeGroups. ```Java private static [ValueStore](ValueStore.html) lambda$setup$10() ``` ```Java private static [StateEvaluator](StateEvaluator.html) lambda$setup$9() ``` ```Java private static [Timers](Timers.html) lambda$setup$8() ``` ```Java private static [StepComponent](StepComponent.html) lambda$setup$7() ``` ```Java private static [SpatialStructure](SpatialStructure.html) lambda$setup$6() ``` ```Java private static [Condition](Condition.html)[] lambda$setup$5(int) ``` ```Java private static [ItemAttitudeGroup](ItemAttitudeGroup.html)[] lambda$setup$4(int) ``` ```Java private static [AttitudeGroup](AttitudeGroup.html)[] lambda$setup$3(int) ``` -------------------------------- ### Handle AssetPackRegisterEvent in Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html The lambda$setup$1 method is a private void method responsible for handling the AssetPackRegisterEvent. It plays a role in the server's asset pack registration mechanism. ```java private void lambda$setup$1(AssetPackRegisterEvent event) ``` -------------------------------- ### DynamicLightSystems Class Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/DynamicLightSystems.html Documentation for the DynamicLightSystems class, including its constructors and methods. ```APIDOC ## DynamicLightSystems Class ### Description Represents the DynamicLightSystems class within the Hytale Plugin API. This class is part of the `com.hypixel.hytale.server.core.entity.dynamiclight` package. ### Method N/A (This is a class definition) ### Endpoint N/A (This is a class definition) ### Parameters N/A ### Request Example N/A ### Response #### Success Response (N/A) N/A #### Response Example N/A ## Constructors ### public DynamicLightSystems() #### Description Creates a new instance of `DynamicLightSystems`. #### Method Constructor #### Parameters None #### Request Example N/A #### Response ##### Success Response (N/A) N/A ##### Response Example N/A ## Methods No public methods are documented for this class. ``` -------------------------------- ### Set Collision Start Point Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/StandardPhysicsProvider.html Sets the starting point for collision detection. This is a void setter method. ```java public void setCollisionStart(double) ``` -------------------------------- ### Instruction and State Transition Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BuilderRole.html Methods for retrieving instruction lists and state transition controllers. ```APIDOC ## GET /api/instructions/list ### Description Retrieves the list of instructions for the entity. ### Method GET ### Endpoint /api/instructions/list ### Parameters #### Query Parameters - **builderSupport** (BuilderSupport) - Optional. Builder support object for context. ### Request Example None ### Response #### Success Response (200) - **instructionList** (List) - A list of instruction objects. #### Response Example ```json { "instructionList": [ {"type": "MoveTo", "target": "(10, 5, 20)"}, {"type": "Wait", "duration": 1.0} ] } ``` ## GET /api/instructions/interaction ### Description Retrieves the instruction for a specific interaction. ### Method GET ### Endpoint /api/instructions/interaction ### Parameters #### Query Parameters - **builderSupport** (BuilderSupport) - Optional. Builder support object for context. ### Request Example None ### Response #### Success Response (200) - **interactionInstruction** (Instruction) - The instruction object for the interaction. #### Response Example ```json { "interactionInstruction": {"type": "Attack", "target": "Player"} } ``` ## GET /api/instructions/death ### Description Retrieves the instruction executed upon the entity's death. ### Method GET ### Endpoint /api/instructions/death ### Parameters #### Query Parameters - **builderSupport** (BuilderSupport) - Optional. Builder support object for context. ### Request Example None ### Response #### Success Response (200) - **deathInstruction** (Instruction) - The instruction object for death. #### Response Example ```json { "deathInstruction": {"type": "PlayAnimation", "animationName": "death_ragdoll"} } ``` ## GET /api/state-transition/controller ### Description Retrieves the state transition controller for managing entity state changes. ### Method GET ### Endpoint /api/state-transition/controller ### Parameters #### Query Parameters - **builderSupport** (BuilderSupport) - Optional. Builder support object for context. ### Request Example None ### Response #### Success Response (200) - **stateTransitionController** (StateTransitionController) - The state transition controller object. #### Response Example ```json { "stateTransitionController": {"currentState": "IDLE", "transitions": [...]} } ``` ``` -------------------------------- ### LaunchPad Class Overview Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/LaunchPad.html Provides details about the LaunchPad class, its inheritance, and its role as a component. ```APIDOC ## LaunchPad Class ### Description `LaunchPad` is a class that extends `Object` and implements `Component` and `ChunkStore`. It represents a launch pad entity within the Hytale server core. ### Class Hierarchy - `java.lang.Object` - `com.hypixel.hytale.server.core.universe.world.meta.state.LaunchPad` implements `com.hypixel.hytale.server.core.common.component.Component`,`com.hypixel.hytale.server.core.universe.world.meta.state.ChunkStore` ### Fields #### Static Fields - **CODEC** (`com.hypixel.hytale.server.core.common.builder.BuilderCodec`) - A static final field representing the codec for building `LaunchPad` instances. - **MAX_VELOCITY** (`int`) - A static final integer defining the maximum allowed velocity. #### Instance Fields - **velocityX** (`float`) - The velocity of the launch pad along the X-axis. - **velocityY** (`float`) - The velocity of the launch pad along the Y-axis. - **velocityZ** (`float`) - The velocity of the launch pad along the Z-axis. - **playersOnly** (`boolean`) - A flag indicating whether the launch pad is only for players. ``` -------------------------------- ### PluginInit Class Overview Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginInit.html Overview of the PluginInit class, including its fields, constructors, and methods. ```APIDOC ## PluginInit Class ### Description The `PluginInit` class is a core component for initializing plugins within the Hytale server environment. It holds essential information about the plugin and its data directory. ### Fields * **pluginManifest** (`PluginManifest`) - Required - The manifest file for the plugin, containing metadata. * **dataDirectory** (`Path`) - Required - The directory where the plugin's data should be stored. ### Constructors * **PluginInit**(PluginManifest pluginManifest, Path dataDirectory) * Description: Creates a new instance of `PluginInit`. * Parameters: * `pluginManifest` (PluginManifest) - Required - The plugin's manifest. * `dataDirectory` (Path) - Required - The path to the plugin's data directory. ### Methods * **getPluginManifest**() * Description: Retrieves the plugin's manifest. * Returns: `PluginManifest` * **getDataDirectory**() * Description: Retrieves the plugin's data directory. * Returns: `Path` * **isInServerClassPath**() * Description: Checks if the plugin is currently loaded within the server's classpath. * Returns: `boolean` ``` -------------------------------- ### Lambda setup 0 Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/CollisionModule.html A private static lambda function used within setup. ```APIDOC ## private static SpatialStructure lambda$setup$0 ### Description A private static lambda function used within setup. ### Method private static ### Endpoint N/A (Method Signature) ### Parameters #### Path Parameters None #### Query Parameters None #### Request Body None ### Request Example ```java // Example usage (conceptual, internal to setup) SpatialStructure structure = lambda$setup$0(); ``` ### Response #### Success Response (SpatialStructure) - **return value** (SpatialStructure) - The SpatialStructure created by the lambda function. #### Response Example ```json // Conceptual return value { "type": "SpatialStructure" } ``` ``` -------------------------------- ### ObjectivePlayerSetupSystem Class Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ObjectivePlayerSetupSystem.html Details about the ObjectivePlayerSetupSystem class, its fields, constructors, and methods. ```APIDOC ## Class ObjectivePlayerSetupSystem ### Description `ObjectivePlayerSetupSystem` is a class that extends `RefSystem` and is part of the Hytale Plugin API. ### Fields - **objectiveHistoryComponentType** (`ComponentType`) - The `objectiveHistoryComponentType` field. - **playerComponentType** (`ComponentType`) - The `playerComponentType` field. - **uuidComponentType** (`ComponentType`) - The `uuidComponentType` field. - **query** (`Query`) - The `query` field. ### Constructors - **ObjectivePlayerSetupSystem**(ObjectiveHistoryComponentType, PlayerComponentType) Creates a new instance of `ObjectivePlayerSetupSystem`. ### Methods - **getQuery**(): `Query` Returns the query associated with this system. - **onEntityAdded**(Ref, AddReason, Store, CommandBuffer) Called when an entity is added to the system. - **onEntityRemove**(Ref, RemoveReason, Store, CommandBuffer) Called when an entity is removed from the system. ``` -------------------------------- ### Get Queued Packets Count (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PacketHandler.html Gets the number of packets currently in the queue. This public method returns an integer. ```Java public int getQueuedPacketsCount() ``` -------------------------------- ### Handle LoadedAssetsEvent in Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/I18nModule.html The lambda$setup$3 method is a private void method that handles the LoadedAssetsEvent. It is likely part of the server's asset loading and initialization process. ```java private void lambda$setup$3(LoadedAssetsEvent event) ``` -------------------------------- ### Start0 (Protected) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginBase.html Protected method for initial start operations. This method is called before the main start. ```Java protected void start0() ``` -------------------------------- ### SpawnSuppressionSystems Constructor Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawnSuppressionSystems.html Creates a new instance of the SpawnSuppressionSystems class. ```APIDOC ## SpawnSuppressionSystems() ### Description Creates a new instance of `SpawnSuppressionSystems`. ### Method `public` ### Endpoint N/A (Constructor) ### Parameters None ### Request Example N/A ### Response #### Success Response (200) - **SpawnSuppressionSystems** (object) - A new instance of the SpawnSuppressionSystems class. #### Response Example N/A ``` -------------------------------- ### Get Ticking Blocks Count - Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BlockSection.html Gets the current count of ticking blocks in the chunk. This public method returns an int. ```Java public int getTickingBlocksCount() ``` -------------------------------- ### Instruction and Steering Methods Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/Role.html Methods for retrieving and managing entity instructions and steering behaviors. ```APIDOC ## GET /entity/instruction/root ### Description Retrieves the root instruction for an entity. ### Method GET ### Endpoint /entity/instruction/root ### Parameters #### Query Parameters - **entityId** (string) - Required - The unique identifier of the entity. ### Response #### Success Response (200) - **instruction** (Instruction) - The root instruction object. #### Response Example { "instruction": { "type": "MoveTo", "target": { "x": 10, "y": 5, "z": 20 } } } ## GET /entity/instruction/interaction ### Description Retrieves the interaction instruction for an entity. ### Method GET ### Endpoint /entity/instruction/interaction ### Parameters #### Query Parameters - **entityId** (string) - Required - The unique identifier of the entity. ### Response #### Success Response (200) - **instruction** (Instruction) - The interaction instruction object. #### Response Example { "instruction": { "type": "InteractWith", "targetEntityId": "NPC_123" } } ## GET /entity/instruction/death ### Description Retrieves the death instruction for an entity. ### Method GET ### Endpoint /entity/instruction/death ### Parameters #### Query Parameters - **entityId** (string) - Required - The unique identifier of the entity. ### Response #### Success Response (200) - **instruction** (Instruction) - The death instruction object. #### Response Example { "instruction": { "type": "PlayAnimation", "animationName": "death_animation" } } ## GET /entity/steering/body ### Description Retrieves the body steering behavior of an entity. ### Method GET ### Endpoint /entity/steering/body ### Parameters #### Query Parameters - **entityId** (string) - Required - The unique identifier of the entity. ### Response #### Success Response (200) - **steering** (Steering) - The body steering object. #### Response Example { "steering": { "type": "Seek", "target": { "x": 5, "y": 2, "z": 15 } } } ## GET /entity/steering/head ### Description Retrieves the head steering behavior of an entity. ### Method GET ### Endpoint /entity/steering/head ### Parameters #### Query Parameters - **entityId** (string) - Required - The unique identifier of the entity. ### Response #### Success Response (200) - **steering** (Steering) - The head steering object. #### Response Example { "steering": { "type": "LookAt", "targetEntityId": "Player_456" } } ``` -------------------------------- ### Private Static Lambda Method: lambda$setup$3 Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/InteractionModule.html Represents the private static lambda method `lambda$setup$3`. It takes a String parameter and returns a RootInteraction. This method is likely part of the setup for root interactions. ```java private static RootInteraction lambda$setup$3(String arg) ``` -------------------------------- ### Beacon NPC Spawning Method (Java) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/SpawningPlugin.html The lambda$setup$1 method is a private static function that returns an array of BeaconNPCSpawn objects. Its specific implementation details and dependencies are not provided in this context. ```java private static BeaconNPCSpawn[] lambda$setup$1(int) ``` -------------------------------- ### Lambda for Setup (1) Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginManager.html A private lambda method used during the setup phase. It takes a PluginIdentifier and a PendingLoadPlugin. ```java private void lambda$setup$1(PluginIdentifier pluginIdentifier, PendingLoadPlugin pendingLoadPlugin) ``` -------------------------------- ### ChunkSpawningSystems Class Overview Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/ChunkSpawningSystems.html Provides an overview of the ChunkSpawningSystems class, its fields, constructors, and methods. ```APIDOC ## Class: ChunkSpawningSystems ### Description The `ChunkSpawningSystems` class is responsible for managing chunk spawning processes within the Hytale server. It contains static methods to handle the lifecycle of chunks, from being stopped to being started and processed. ### Fields - **LOGGER** (`HytaleLogger`): A static final logger instance for this class. - **QUERY** (`Query`): A static final query for retrieving `ChunkStore` objects. - **TICKING_QUERY** (`Query`): A static final query for retrieving ticking `ChunkStore` objects. ### Constructors - **ChunkSpawningSystems()** - Description: Creates a new instance of `ChunkSpawningSystems`. - Method: `public` ### Methods - **processStoppedChunk** - Description: Processes a chunk that has stopped spawning. - Method: `protected static` - Parameters: - `Ref`: Reference to the chunk store. - `Store`: The store containing chunk data. - `WorldSpawnData`: Data related to world spawning. - `ComponentType`: Component for chunk spawn data. - `CommandBuffer`: Command buffer for chunk operations. - Returns: `boolean` - **processStartedChunk** - Description: Processes a chunk that has started spawning. - Method: `protected static` - Parameters: - `Ref`: Reference to the chunk store. - `Store`: The store containing chunk data. - `WorldChunk`: Represents a world chunk. - `WorldSpawnData`: Data related to world spawning. - `ComponentType`: Component for chunk spawn data. - `ComponentType`: Component for spawned NPC data. - `CommandBuffer`: Command buffer for chunk operations. - Returns: `boolean` - **preprocessChunk** - Description: Preprocesses chunk data before spawning. - Method: `private static` - Parameters: - `ChunkSpawnData`: Data for chunk spawning. - `WorldChunk`: Represents a world chunk. - **preprocessColumn** - Description: Preprocesses column data for chunk spawning. - Method: `private static` - Parameters: - `ChunkSpawnData`: Data for chunk spawning. - `WorldChunk`: Represents a world chunk. - `int`: X-coordinate. - `int`: Z-coordinate. - **updateChunkCount** - Description: Updates the count of spawned chunks. - Method: `protected static` - Parameters: - `int`: The number of chunks to update. - `WorldSpawnData`: Data related to world spawning. ``` -------------------------------- ### Get Plugin Type Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/PluginBase.html Abstract method to get the PluginType. Implementations must define the type of the plugin. ```Java public abstract PluginType getType() ``` -------------------------------- ### NPCShopPlugin Setup Method - Hytale Plugin API Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/NPCShopPlugin.html This snippet defines the protected setup() method for the NPCShopPlugin class. This method is intended to be overridden by subclasses to perform specific initialization tasks for NPC shop functionalities. ```java protected void setup() { // Setup implementation } ``` -------------------------------- ### Get Ticking Blocks Count Copy - Java Source: https://github.com/henry-bonikowsky/hytale-docs/blob/main/docs/classes/BlockSection.html Gets a copy of the count of ticking blocks in the chunk. This public method returns an int. ```Java public int getTickingBlocksCountCopy() ```