Asset Editor Events
Package: com.hypixel.hytale.builtin.asseteditor.event
Events related to the in-game asset editor. These are primarily for development tools and editor integration.
EditorClientEvent (Abstract Base)
Section titled “EditorClientEvent (Abstract Base)”Abstract base class for most asset editor events.
Class: com.hypixel.hytale.builtin.asseteditor.event.EditorClientEvent<KeyType>
| Property | Value |
|---|---|
| Implements | IEvent<KeyType> |
| Abstract | Yes |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client associated with this event |
AssetEditorClientDisconnectEvent
Section titled “AssetEditorClientDisconnectEvent”Fired when an asset editor client disconnects.
Class: com.hypixel.hytale.builtin.asseteditor.event.AssetEditorClientDisconnectEvent
| Property | Value |
|---|---|
| Extends | EditorClientEvent<Void> |
| Async | No |
| Cancellable | No |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client that disconnected |
getDisconnectReason() | PacketHandler.DisconnectReason | Returns the reason for disconnection |
When Fired
Section titled “When Fired”Fired when a client using the asset editor disconnects from the server.
AssetEditorAssetCreatedEvent
Section titled “AssetEditorAssetCreatedEvent”Fired when an asset is created in the editor.
Class: com.hypixel.hytale.builtin.asseteditor.event.AssetEditorAssetCreatedEvent
| Property | Value |
|---|---|
| Extends | EditorClientEvent<String> |
| Async | No |
| Cancellable | No |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client that created the asset |
getAssetType() | String | Returns the type of asset being created |
getAssetPath() | Path | Returns the file path where the asset will be saved |
getData() | byte[] | Returns the raw asset data |
getButtonId() | String | Returns the ID of the button that triggered creation |
When Fired
Section titled “When Fired”Fired when a new asset is created through the asset editor.
AssetEditorSelectAssetEvent
Section titled “AssetEditorSelectAssetEvent”Fired when an asset is selected in the editor.
Class: com.hypixel.hytale.builtin.asseteditor.event.AssetEditorSelectAssetEvent
| Property | Value |
|---|---|
| Extends | EditorClientEvent<Void> |
| Async | No |
| Cancellable | No |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client selecting the asset |
getAssetType() | String | Returns the type of the newly selected asset |
getAssetFilePath() | AssetPath | Returns the path of the newly selected asset |
getPreviousAssetType() | String | Returns the type of the previously selected asset |
getPreviousAssetFilePath() | AssetPath | Returns the path of the previously selected asset |
When Fired
Section titled “When Fired”Fired when a user selects an asset in the editor interface.
AssetEditorActivateButtonEvent
Section titled “AssetEditorActivateButtonEvent”Fired when a button is activated in the editor.
Class: com.hypixel.hytale.builtin.asseteditor.event.AssetEditorActivateButtonEvent
| Property | Value |
|---|---|
| Extends | EditorClientEvent<String> |
| Async | No |
| Cancellable | No |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client that activated the button |
getButtonId() | String | Returns the ID of the activated button |
When Fired
Section titled “When Fired”Fired when a user clicks a button in the asset editor UI.
AssetEditorRequestDataSetEvent
Section titled “AssetEditorRequestDataSetEvent”Fired when data is requested from the editor. This is an async event that allows handlers to populate results.
Class: com.hypixel.hytale.builtin.asseteditor.event.AssetEditorRequestDataSetEvent
| Property | Value |
|---|---|
| Implements | IAsyncEvent<String> |
| Async | Yes |
| Cancellable | No |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client requesting the data |
getDataSet() | String | Returns the name of the requested dataset |
getResults() | String[] | Returns the current results array |
setResults(String[]) | void | Sets the results to return to the client |
When Fired
Section titled “When Fired”Fired when the asset editor requests a dataset from the server.
AssetEditorFetchAutoCompleteDataEvent
Section titled “AssetEditorFetchAutoCompleteDataEvent”Fired when autocomplete data is requested. This is an async event that allows handlers to populate autocomplete suggestions.
Class: com.hypixel.hytale.builtin.asseteditor.event.AssetEditorFetchAutoCompleteDataEvent
| Property | Value |
|---|---|
| Implements | IAsyncEvent<String> |
| Async | Yes |
| Cancellable | No |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client requesting autocomplete |
getDataSet() | String | Returns the dataset to search for completions |
getQuery() | String | Returns the current query string to autocomplete |
getResults() | String[] | Returns the current autocomplete suggestions |
setResults(String[]) | void | Sets the autocomplete suggestions to return |
When Fired
Section titled “When Fired”Fired when the editor requests autocomplete suggestions for a field.
AssetEditorUpdateWeatherPreviewLockEvent
Section titled “AssetEditorUpdateWeatherPreviewLockEvent”Fired when weather preview lock state changes.
Class: com.hypixel.hytale.builtin.asseteditor.event.AssetEditorUpdateWeatherPreviewLockEvent
| Property | Value |
|---|---|
| Extends | EditorClientEvent<Void> |
| Async | No |
| Cancellable | No |
Methods
Section titled “Methods”| Method | Return Type | Description |
|---|---|---|
getEditorClient() | EditorClient | Returns the editor client toggling the lock |
isLocked() | boolean | Returns whether weather preview is now locked |
When Fired
Section titled “When Fired”Fired when the weather preview lock state is toggled in the editor.
These events are primarily used for development and modding tools. Most plugin developers won’t need to interact with these events unless building custom editor integrations.