refactor: spectators system #1645

mehah · 2023-09-27T20:19:49Z

This refactoring consists of:

1- Improved caching algorithm
2- Applied pipeline concept
3- Use of vector_set instead of hashset.

code sample:

// [OLD]
SpectatorHashSet spectators;
getSpectators(spectators, Position(x, y, z), ...);
for(const auto spec: spectators) {}

// [NEW]

// Get All Creatures
Spectators().find<Creature>(Position(x, y, z), ...);

// Get All Players
Spectators().find<Player>(Position(x, y, z), ...);

// Method Filter
// Note: This method returns a new instance of spectators
{
  auto spectators = Spectators().find<Creature>(Position(x, y, z), ...);
  
  // Get All Npcs from spectators variable
  auto npcSpectators = spectators.filter<Npc>();
  
  // Get All Players from spectators variable
  auto playerSpectators = spectators.filter<Player>();
}

// Pipeline Code
{
  auto spectators = Spectators()
    .find<Creature>({100, 200, 100})
    .find<Player>({110, 210, 110})
    .find<Creature>({99, 101, 50});
  
  for(const auto spec : spectators) {}
  for(const auto spec : spectators.filter<Monster>()) {}
  for(const auto spec : spectators.filter<Npc>()) {}
}

[BENCHMARK] (Set SPECTATORS_USE_HASHSET if you want to benchmark with 'hashset'.)

Vector

Hashset

[BENCHMARK CODE]

void Map::moveCreature(Creature &creature, Tile &newTile, bool forceTeleport /* = false*/) {
	.
	.
	.
	auto spectators = Spectators()
				  .find<Creature>(oldPos, true)
				  .find<Creature>(newPos, true);

	const int64_t start = OTSYS_TIME();

	for (int_fast32_t i = -1; ++i < 999999;) {
		for (const auto spec : Spectators()
						.find<Creature>(oldPos, true)
						.find<Creature>(newPos, true)) { }
	}

	g_logger().info("Benchmark std::vector({}) | cache enabled: {}ms", spectators.size(), static_cast<double>(OTSYS_TIME() - start) / 1000.f);
	.
	.
	.
}