VolatileEntities

VolatileEntities is an ECS-based framework for Hytale that lets you create and manage non-persistent or time-controlled entities, without leaving “garbage” in the world.

4.4 тысяч загрузок

Обновлён 8 дней назад

Библиотека Утилиты Разное Улучшение Качества Жизни

Описание

Нестабильные сущности

VolatileEntities - это фреймворк на основе ECS для Hytale, который позволяет создавать и управлять. непостоянный или контролируемый временем Сущности, не оставляя «мусора» в мире.

Он предназначен для:

дать вам мелкозернистый контроль над временем жизни объекта (расстояние, тайм-аут, отключение владельца и т. Д.),
автоматически очищает объекты на перезагрузке сервера,
И даже обеспечить очистку после того, как ваш плагин будет удален.

Ключевые особенности

Автоматическая непостоянство при перезапуске

Любой субъект с Нестабильный компонент автоматически удаляется на самом Первый тик после перезагрузки сервераБлагодаря:

тот Срок действия OnLoad флаг, обрабатываемый кодеком компонента (Нестабильный компонент.CODEC),
и VolatileTickSystem Это убивает «загруженные с диска» летучие объекты.

Это гарантирует, что нестабильные предприятия Никогда не переживайте перезагрузкуДаже если они были сохранены на диске.

Гибкая среда выполнения TTL (в то время как плагин работает)

использовать VolatileConfig и Нестабильная политикаВы можете точно контролировать, как долго предприятие должно жить во время выполнения:

IDLE_TIMEUT - деспаун после X клещей или секунд активности;
MAX_DISTANCE - деспаун, когда слишком далеко от связанного объекта,
LINKED_ENTITY_INVALID - деспаун, если связанное образование становится недействительным,
КУСТОМ - полностью настраиваемая логика деспауна через предикат на VolatileКонтекст.

Все они оцениваются по VolatileTickSystem Пока ваш плагин загружен.

Сочетание политики

Политика это Не исключая.

Одна волатильная организация может объединять несколько политик одновременно. Предприятие будет удалено, как только Любое политическое условие выполняется.

Например, организация может:

после 10 секунд бездействия (IDLE_TIMEUT),
Иль деспаун, если он движется слишком далеко от целиMAX_DISTANCE),
Или удаляется, когда его владелец отключается (Владелец_Дисконнект).

Это позволяет выражать сложные жизненные циклы без пользовательского кода.

VolatileEntities.builder()
.withinDistance (targetRef, 30f)
.idleTimeoutSeconds(10f)
.ownedBy(playerUuid)
.spawn (командный буфер);

Комбинация изменчивой политики (пример)

Этот пример показывает, как многократный Нестабильная политика Правила можно комбинировать Внутри одного VolatileConfig.

Политика это Не исключаяПредприятие может иметь несколько правил жизненного цикла одновременно.

Предприятие будет удалено, как только Любое политическое условие выполняется.

Пример: объект, связанный с другим объектом

VolatileConfig.VolatileConfigBuilder configBuilder = VolatileConfig.builder()
// Автоматически удалить объект, когда его кусок разгружается
.policy (VolatilePolicy.CHUNK_UNLOAD)

// Удалить немедленно, как только условие политики становится недействительным.
.removeOnInvalid (правда);

// Необязательно связывать эту изменчивую сущность с другой (например, толпой или NPC).
если (linkedEntity != null)
конфигуратор
.policy (неустойчивая политика). LINKED_ENTITY_INVALID
.linkedEntity (ссылка)
?

VolatileConfig config = configBuilder.builder();
возврат нового энергонезависимого компонента (конфигурации);

Абсолютный TTL с использованием Hytale `Компонент Despawn` (cunk unload/reload safe)

VolatileEntities интегрируется с ванилью Системы Hytale:

Компонент Despawn + Система Despawn TTL в режиме реального времени,
тот USE_DESPAWN_TTL Политика говорит Нестабильные объекты для TTL полностью обрабатывает то Компонент Despawn.

Это означает:

TTL основан на реальном времени.Ресурс времени- не клещей,
Частичные разгрузки / перезагрузки безопасны,
Если время деспауна уже в прошлом, когда кусок перезагружается, сущность немедленно удаляется.

Поэтому вы можете выбрать между:

время выполнения, только онлайн TTL ()IDLE_TIMEUTили
Абсолютный TTL который продолжает считать даже при разгрузке (USE_DESPAWN_TTL + Компонент Despawn).

Очистка после удаления плагина

Чтобы решить классическую проблему «сущностей, оставшихся после удаления мода», VolatileEntities использует шаблон сохранения жизни:

VolatileDespawnKeepAliveSystem Постоянно освежает ваниль Компонент Despawn нестабильные организации (кроме тех, которые используют) USE_DESPAWN_TTL),
Пока ваш плагин установлен, крайний срок деспауна постоянно выдвигается вперед.
Как только ваш плагин будет удален, в конечном итоге будет достигнут последний срок деспауна.

В этот момент ядро Hytale Система Despawn автоматически очищает Все оставшиеся нестабильныеДаже если вашего плагина больше нет.

Нет ручного сканирования мира. Никаких сирот.

Передовая политика

В дополнение к основным политикам ТТЛ эта структура поддерживает:

CHUNK_UNLOAD автоматически удалять летучие объекты, когда их кусок разгружается; (обрабатывается) VolatileCunkUnloadСистемаАн EntityEventSystem<ChunkUnload> Событие).
Владелец_Дисконнект маркировать или удалять нестабильные объекты, принадлежащие игроку, когда они отключаются; (обрабатывается) Разработчик:DisconnectListenerслушать PlayerDisconnect Событие).

В совокупности эти политики образуют надежный инструментарий жизненного цикла для временных организаций.

Типичные случаи использования

Используйте VolatileEntities для маркировки:

голограммы,
снаряды,
визуальные эффекты,
временные NPC,
вспомогательные или маркерные сущности

Они так же нестабильны, что:

Для перезапуска,
необязательно следовать правилам выполнения (тайм-аут, расстояние, владение, пользовательская логика),
и по-прежнему гарантированно будут очищены после удаления плагина.

Примеры использования

1) Маркировка существующей организации как неустойчивой (только для перезагрузки)

Если вы уже создали объект вручную (например, голограмму), вы можете просто прикрепить к нему Нестабильный компонент сделать его непостоянным.

holder.addComponent()
VolatileComponent.getComponentType(),
VolatileComponent.restartOnly()
);

Результат:

сущность живет до тех пор, пока работает сервер,
удаляется на первом клеще после перезапуска,
Очистка безопасности по-прежнему применяется.

2) Абсолютный ТТЛ (10 секунд в реальном времени)

Чтобы разорвать сущность после фиксированного количества реального времени, даже при разгрузке кусков, объедините Компонент Despawn с USE_DESPAWN_TTL:

holder.addComponent()
DespawnComponent.getComponentType(),
DespawnComponent.despawnInSeconds (время, 10f)
);

VolatileConfig cfg = VolatileConfig.builder()
.policy (VolatilePolicy.USE_DESPAWN_TTL)
.build();

holder.addComponent()
VolatileComponent.getComponentType(),
Новый летучий компонент (cfg)
);

Вот.

Hytale обрабатывает сам TTL,
Волатильные сущности не освежают время деспауна,
Перезапуск и удаление уборки по-прежнему гарантированы.

3) Отметить уже существующую организацию как неустойчивую

Вы можете отметить объект как неустойчивый после того, как он уже существует:

store.putComponent()
Реф.
VolatileComponent.getComponentType(),
VolatileComponent.restartOnly()
);

Не требуется никакой респауновской или ручной логики деспаунов.

API Reference (Быстрый обзор)

`Нестабильный компонент` Фабричные методы

RestartOnly() - Runtime-only, удалено при перезапуске
с Timeout (int ticks) / TimeoutSeconds (float seconds, int tickRate)
в пределах расстояния (Ref<EntityStore> целевой, поплавковое расстояние)
LinkedTo (Ref<EntityStore> target)
Разработчик: By(UUID PlayerUuid)
Использование DespawnTtl()

`VolatileConfig`

Предустановки и конструкторы для расширенного контроля:

chunkBound()
LinkedTo(ref)
Расстояние (ref, distance)
Разработчик:PlayerUuid
Timeout (тикс)
Использование DespawnTtl()
custom(ctx -> {...})

`VolatileEntities.builder()`

Для удобства API-интерфейс конструктора обеспечивает беглый способ создания летучих объектов:

VolatileEntities.builder()
.at (новый Vector3d (x, y, z))
.with (компонент). Новый MyComponent(...)
.withinDistance(targetRef, 50f)
.idleTimeoutSeconds(10f)
.spawn (командный буфер);

установка

Бросай. Нестабильные сущности JAR в папку плагинов вашего сервера.
Объявите зависимость в вашем манифесте плагина:

{
«Группа»: «Ender_Griefeur99»,
«Имя»: «MyPlugin»,
"Версия": "1.0.0",
"Главный": "fr.ender_griefeur99.myplugin.MyPlugin",
"ServerVersion": "*",
"IncludesAssetPack": ложный,
"Зависимость": {
"Ender_Griefeur99:VolatileEntities": "*"
?
?

Показать оригинальное описание (English)

VolatileEntities

VolatileEntities is an ECS-based framework for Hytale that lets you create and manage non-persistent or time-controlled entities, without leaving “garbage” in the world.

It is designed to:

give you fine-grained control over entity lifetime (distance, timeout, owner disconnect, etc.),
automatically clean up entities on server restart,
and even ensure cleanup after your plugin is uninstalled.

Key Features

Automatic non-persistence on restart

Any entity with a VolatileComponent is automatically removed on the very first tick after a server restart, thanks to:

the expiredOnLoad flag handled by the component’s codec (VolatileComponent.CODEC),
and the VolatileTickSystem that kills “loaded-from-disk” volatile entities.

This guarantees that volatile entities never survive a reboot, even if they were saved to disk.

Flexible runtime TTL (while the plugin is running)

Using VolatileConfig and VolatilePolicy, you can precisely control how long an entity should live at runtime:

IDLE_TIMEOUT – despawn after X ticks or seconds of activity,
MAX_DISTANCE – despawn when too far from a linked entity,
LINKED_ENTITY_INVALID – despawn if the linked entity becomes invalid,
CUSTOM – fully custom despawn logic via a predicate on VolatileContext.

All of these are evaluated by VolatileTickSystem while your plugin is loaded.

Policy combination

Policies are not exclusive.

A single volatile entity can combine multiple policies at the same time. The entity will be removed as soon as any policy condition is met.

For example, an entity can:

despawn after 10 seconds of inactivity (IDLE_TIMEOUT),
OR despawn if it moves too far from a target (MAX_DISTANCE),
OR be removed when its owner disconnects (OWNER_DISCONNECT).

This allows you to express complex lifecycles without custom code.

VolatileEntities.builder()
    .withinDistance(targetRef, 30f)
    .idleTimeoutSeconds(10f)
    .ownedBy(playerUuid)
    .spawn(commandBuffer);

Combining Volatile Policies (Example)

This example demonstrates how multiple VolatilePolicy rules can be combined inside a single VolatileConfig.

Policies are not exclusive: an entity can have several lifecycle rules applied at the same time.

The entity will be removed as soon as any policy condition is met.

Example: Chunk-bound entity linked to another entity

VolatileConfig.VolatileConfigBuilder configBuilder = VolatileConfig.builder()
        // Automatically remove the entity when its chunk unloads
        .policy(VolatilePolicy.CHUNK_UNLOAD)

        // Remove immediately as soon as a policy condition becomes invalid
        .removeOnInvalid(true);

// Optionally link this volatile entity to another one (e.g. a mob or NPC)
if (linkedEntity != null) {
        configBuilder
        .policy(VolatilePolicy.LINKED_ENTITY_INVALID)
        .linkedEntity(linkedEntity);
}

VolatileConfig config = configBuilder.build();
return new VolatileComponent(config);

Absolute TTL using Hytale’s `DespawnComponent` (chunk unload/reload safe)

VolatileEntities integrates cleanly with vanilla Hytale systems:

DespawnComponent + DespawnSystem handle absolute, real-time TTL,
the USE_DESPAWN_TTL policy tells VolatileEntities to delegate TTL handling entirely to DespawnComponent.

This means:

TTL is based on real time (TimeResource), not ticks,
chunk unloads / reloads are safe,
if the despawn time is already in the past when the chunk reloads, the entity is removed immediately.

You can therefore choose between:

runtime, online-only TTL (IDLE_TIMEOUT), or
absolute TTL that continues counting even while unloaded (USE_DESPAWN_TTL + DespawnComponent).

Cleanup after plugin uninstall

To solve the classic “entities left behind after removing a mod” problem, VolatileEntities uses a keep-alive pattern:

VolatileDespawnKeepAliveSystem continuously refreshes a vanilla DespawnComponent on volatile entities (except those using USE_DESPAWN_TTL),
while your plugin is installed, the despawn deadline is constantly pushed forward,
once your plugin is removed, the last despawn deadline is eventually reached.

At that point, Hytale’s core DespawnSystem automatically cleans up all remaining volatile entities, even though your plugin is no longer present.

No manual world scans. No orphaned entities.

Advanced policies

In addition to core TTL policies, the framework supports:

CHUNK_UNLOAD – automatically remove volatile entities when their chunk unloads (handled by VolatileChunkUnloadSystem, an EntityEventSystem<ChunkUnloadEvent>).
OWNER_DISCONNECT – mark or remove volatile entities owned by a player when they disconnect (handled by VolatileOwnerDisconnectListener, listening to PlayerDisconnectEvent).

Combined together, these policies form a robust lifecycle toolkit for temporary entities.

Typical Use Cases

Use VolatileEntities to mark:

holograms,
projectiles,
visual effects,
temporary NPCs,
helper or marker entities

as volatile, so that they:

despawn on restart,
optionally follow runtime rules (timeout, distance, ownership, custom logic),
and are still guaranteed to be cleaned up after plugin uninstall.

Usage Examples

1) Marking an existing entity as volatile (restart-only)

If you already spawn an entity manually (for example a hologram), you can simply attach a VolatileComponent to make it non-persistent.

holder.addComponent(
    VolatileComponent.getComponentType(),
    VolatileComponent.restartOnly()
);

Result:

the entity lives as long as the server runs,
it is removed on the first tick after a restart,
uninstall safety cleanup still applies.

2) Absolute TTL (10 seconds real-time)

To despawn an entity after a fixed amount of real time, even across chunk unloads, combine DespawnComponent with USE_DESPAWN_TTL:

holder.addComponent(
    DespawnComponent.getComponentType(),
    DespawnComponent.despawnInSeconds(time, 10f)
);

VolatileConfig cfg = VolatileConfig.builder()
    .policy(VolatilePolicy.USE_DESPAWN_TTL)
    .build();

holder.addComponent(
    VolatileComponent.getComponentType(),
    new VolatileComponent(cfg)
);

Here:

Hytale handles the TTL itself,
VolatileEntities does not refresh despawn time,
restart and uninstall cleanup are still guaranteed.

3) Mark an already existing entity as volatile

You can mark an entity as volatile after it already exists:

store.putComponent(
    ref,
    VolatileComponent.getComponentType(),
    VolatileComponent.restartOnly()
);

No respawn or manual despawn logic required.

API Reference (Quick Overview)

`VolatileComponent` – factory methods

restartOnly() – runtime-only, removed on restart
withTimeout(int ticks) / withTimeoutSeconds(float seconds, int tickRate)
withinDistance(Ref<EntityStore> target, float distance)
linkedTo(Ref<EntityStore> target)
ownedBy(UUID playerUuid)
useDespawnTtl()

`VolatileConfig`

Presets and builders for advanced control:

chunkBound()
linkedTo(ref)
withinDistance(ref, distance)
ownedBy(playerUuid)
withTimeout(ticks)
useDespawnTtl()
custom(ctx -> { ... })

`VolatileEntities.builder()`

For convenience, the builder API provides a fluent way to spawn volatile entities:

VolatileEntities.builder()
    .at(new Vector3d(x, y, z))
    .with(MyComponent.TYPE, new MyComponent(...))
    .withinDistance(targetRef, 50f)
    .idleTimeoutSeconds(10f)
    .spawn(commandBuffer);

Installation

Drop the VolatileEntities JAR into your server’s plugin folder.
Declare a dependency in your plugin manifest:

{
  "Group": "Ender_Griefeur99",
  "Name": "MyPlugin",
  "Version": "1.0.0",
  "Main": "fr.ender_griefeur99.myplugin.MyPlugin",
  "ServerVersion": "*",
  "IncludesAssetPack": false,
  "Dependencies": {
    "Ender_Griefeur99:VolatileEntities": "*"
  }
}

Последние версии

volatile-entities-1.0-SNAPSHOT.jar

Early Access 26.01.2026 43.8 КБ

Открыть на CurseForge Вернуться к списку

Информация

Авторы:

Ender_Griefeur99

Категории:

Библиотека Утилиты Разное Улучшение Качества Жизни

Версии игры:

Early Access

Создан: 26.01.2026

VolatileEntities

Описание

Нестабильные сущности

Ключевые особенности

Автоматическая непостоянство при перезапуске

Гибкая среда выполнения TTL (в то время как плагин работает)

Сочетание политики

Комбинация изменчивой политики (пример)

Пример: объект, связанный с другим объектом

Абсолютный TTL с использованием Hytale Компонент Despawn (cunk unload/reload safe)

Очистка после удаления плагина

Передовая политика

Типичные случаи использования

Примеры использования

1) Маркировка существующей организации как неустойчивой (только для перезагрузки)

2) Абсолютный ТТЛ (10 секунд в реальном времени)

3) Отметить уже существующую организацию как неустойчивую

API Reference (Быстрый обзор)

Нестабильный компонент Фабричные методы

VolatileConfig

VolatileEntities.builder()

установка

VolatileEntities

Key Features

Automatic non-persistence on restart

Flexible runtime TTL (while the plugin is running)

Policy combination

Combining Volatile Policies (Example)

Example: Chunk-bound entity linked to another entity

Absolute TTL using Hytale’s DespawnComponent (chunk unload/reload safe)

Cleanup after plugin uninstall

Advanced policies

Typical Use Cases

Usage Examples

1) Marking an existing entity as volatile (restart-only)

2) Absolute TTL (10 seconds real-time)

3) Mark an already existing entity as volatile

API Reference (Quick Overview)

VolatileComponent – factory methods

VolatileConfig

VolatileEntities.builder()

Installation

Последние версии

volatile-entities-1.0-SNAPSHOT.jar

Информация

Авторы:

Категории:

Версии игры:

Похожие моды

Абсолютный TTL с использованием Hytale `Компонент Despawn` (cunk unload/reload safe)

`Нестабильный компонент` Фабричные методы

`VolatileConfig`

`VolatileEntities.builder()`

Absolute TTL using Hytale’s `DespawnComponent` (chunk unload/reload safe)

`VolatileComponent` – factory methods

`VolatileConfig`

`VolatileEntities.builder()`