c02909e2c8
## Summary Two small additive changes a derived spawner needs. - **`BaseSpawner.OnTick()` is now `virtual`.** A subclass that gates spawning on external state (time windows, event triggers) must gate *timer* spawns without gating the manual `Spawn()` API, and `OnTick` is the only place the two paths differ: it is the timer callback and `Spawn()` is both what it calls and what commands and scripts call. Cost: one virtual dispatch on the existing timer callback; no change to stock behaviour. - **`group` in the JSON DTO.** `BaseSpawner.Group` (all dead, then respawn) is binary-persisted but was missing from `SpawnerDto`, so it did not survive export/import. Added to the abstract record after `spawnLocationIsHome`, assigned in `ApplyDto` after `InitSpawn` (which resets it), and exported by the three stock `ToDto` implementations. ## Test plan - [x] A derived spawner overriding `OnTick` with a closed gate: `OnTick()` spawns nothing; manual `Spawn()` still spawns and does not pass through `OnTick`. - [x] DTO round trip with `Group = true` carries `group` and restores it on `ToSpawner()`. - [x] `UOContent.Tests` full suite green. - [ ] CI
114 lines
4 KiB
C#
114 lines
4 KiB
C#
/*************************************************************************
|
|
* ModernUO *
|
|
* Copyright 2019-2026 - ModernUO Development Team *
|
|
* Email: hi@modernuo.com *
|
|
* File: BaseSpawner.Dto.cs *
|
|
* *
|
|
* This program is free software: you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation, either version 3 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* You should have received a copy of the GNU General Public License *
|
|
* along with this program. If not, see <http://www.gnu.org/licenses/>. *
|
|
*************************************************************************/
|
|
|
|
using System;
|
|
|
|
namespace Server.Engines.Spawners;
|
|
|
|
public abstract partial class BaseSpawner
|
|
{
|
|
/// <summary>Applies the common DTO fields to this freshly-created spawner (import path).</summary>
|
|
internal void ApplyDto(SpawnerDto dto)
|
|
{
|
|
_guid = dto.Guid == Guid.Empty ? Guid.NewGuid() : dto.Guid;
|
|
|
|
if (!string.IsNullOrEmpty(dto.Name))
|
|
{
|
|
Name = dto.Name;
|
|
}
|
|
|
|
// Compact homeRange -> spawnBounds (Map not available yet; use the DTO location).
|
|
if (dto.HomeRange >= 0)
|
|
{
|
|
SpawnBounds = BoundsFromHomeRange(dto.Location, dto.HomeRange);
|
|
}
|
|
|
|
InitSpawn(dto.Count, dto.MinDelay, dto.MaxDelay, dto.Team, SpawnBounds);
|
|
|
|
_group = dto.Group;
|
|
_walkingRange = dto.WalkingRange;
|
|
_spawnLocationIsHome = dto.SpawnLocationIsHome;
|
|
_spawnPositionMode = dto.SpawnPositionMode;
|
|
_maxSpawnAttempts = dto.MaxSpawnAttempts;
|
|
|
|
if (dto.EntryView != null)
|
|
{
|
|
AdoptEntries(dto.EntryView);
|
|
}
|
|
}
|
|
|
|
/// <summary>The square spawn bounds a homeRange radius represents (centered on the location).</summary>
|
|
protected static Rectangle3D BoundsFromHomeRange(Point3D location, int homeRange)
|
|
{
|
|
int z;
|
|
int depth;
|
|
if (homeRange == 0)
|
|
{
|
|
z = location.Z;
|
|
depth = 0;
|
|
}
|
|
else
|
|
{
|
|
z = -128;
|
|
depth = 256;
|
|
}
|
|
|
|
return new Rectangle3D(
|
|
location.X - homeRange,
|
|
location.Y - homeRange,
|
|
z,
|
|
homeRange * 2 + 1,
|
|
homeRange * 2 + 1,
|
|
depth
|
|
);
|
|
}
|
|
|
|
protected string DtoName
|
|
{
|
|
get
|
|
{
|
|
var name = Name;
|
|
return string.IsNullOrEmpty(name) || name == DefaultName ? null : name;
|
|
}
|
|
}
|
|
|
|
// ToDto helpers for values whose export form differs from the public property. (Guid/MinDelay/
|
|
// MaxDelay/Team/SpawnLocationIsHome match their property and are referenced directly in ToDto.)
|
|
|
|
// Raw field; the public WalkingRange is computed (falls back to HomeRange).
|
|
protected int DtoWalkingRange => _walkingRange;
|
|
|
|
// Abandoned is a transient runtime state, not persisted -> map to Automatic (omitted).
|
|
protected SpawnPositionMode DtoSpawnPositionMode =>
|
|
_spawnPositionMode == SpawnPositionMode.Abandoned ? SpawnPositionMode.Automatic : _spawnPositionMode;
|
|
|
|
// Runtime treats 0 as DefaultMaxSpawnAttempts -> map the default to 0 (omitted).
|
|
protected int DtoMaxSpawnAttempts => _maxSpawnAttempts == DefaultMaxSpawnAttempts ? 0 : _maxSpawnAttempts;
|
|
|
|
// The radius if SpawnBounds is exactly what it reconstructs (lossless square); otherwise -1.
|
|
protected int DtoHomeRange
|
|
{
|
|
get
|
|
{
|
|
if (SpawnBounds == default || !IsHomeRangeStyle)
|
|
{
|
|
return -1;
|
|
}
|
|
|
|
var homeRange = HomeRange;
|
|
return SpawnBounds == BoundsFromHomeRange(Location, homeRange) ? homeRange : -1;
|
|
}
|
|
}
|
|
}
|