Deployed 00f3b63 to latest with MkDocs 1.6.1 and mike 2.1.3

EndstoneMC · Nov 10, 2024 · b09f0b7 · b09f0b7
1 parent 416b356
commit b09f0b7
Show file tree

Hide file tree

Showing 34 changed files with 10,099 additions and 404 deletions.
diff --git a/latest/assets/.doxy/reference/cpp/hashChanges.yaml b/latest/assets/.doxy/reference/cpp/hashChanges.yaml
@@ -1 +1 @@
-1b1b6060c0f0d98b99770e1fb12c4661e83f65a9
+043f75b99a75015193323d9be1ff4af2ced40dd4
diff --git a/latest/assets/.doxy/reference/cpp/reference/cpp/annotated.md b/latest/assets/.doxy/reference/cpp/reference/cpp/annotated.md
@@ -14,6 +14,7 @@ Here are the classes, structs, unions and interfaces with brief descriptions:
     * **class** [**ActorRemoveEvent**](classendstone_1_1ActorRemoveEvent.md) _Called when an_ [_**Actor**_](classendstone_1_1Actor.md) _is removed._    
     * **class** [**ActorSpawnEvent**](classendstone_1_1ActorSpawnEvent.md) _Called when an_ [_**Actor**_](classendstone_1_1Actor.md) _is spawned into a world._    
     * **class** [**ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md) _Called when a non-player entity is teleported from one location to another._     
+    * **class** [**BanList**](classendstone_1_1BanList.md) _A class that represents a ban list, containing bans of some target type._     
     * **class** [**Block**](classendstone_1_1Block.md) _Represents a block._     
     * **class** [**BlockBreakEvent**](classendstone_1_1BlockBreakEvent.md) _Called when a block is broken by a player._     
     * **class** [**BlockData**](classendstone_1_1BlockData.md) _Represents the data related to a live block._     

diff --git a/latest/assets/.doxy/reference/cpp/reference/cpp/ban__list_8h.md b/latest/assets/.doxy/reference/cpp/reference/cpp/ban__list_8h.md
@@ -0,0 +1,95 @@
+
+
+# File ban\_list.h
+
+
+
+[**FileList**](files.md) **>** [**ban**](dir_f1b1f2e9abb31749ef58cd98f22bcd78.md) **>** [**ban\_list.h**](ban__list_8h.md)
+
+[Go to the source code of this file](ban__list_8h_source.md)
+
+
+
+* `#include <vector>`
+* `#include <string>`
+* `#include <optional>`
+* `#include <chrono>`
+
+
+
+
+
+
+
+
+
+
+
+
+
+## Namespaces
+
+| Type | Name |
+| ---: | :--- |
+| namespace | [**endstone**](namespaceendstone.md) <br> |
+
+
+## Classes
+
+| Type | Name |
+| ---: | :--- |
+| class | [**BanList**](classendstone_1_1BanList.md) &lt;typename T&gt;<br>_A class that represents a ban list, containing bans of some target type._  |
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+------------------------------
+The documentation for this class was generated from the following file `include/endstone/ban/ban_list.h`
+
diff --git a/latest/assets/.doxy/reference/cpp/reference/cpp/ban__list_8h_source.md b/latest/assets/.doxy/reference/cpp/reference/cpp/ban__list_8h_source.md
@@ -0,0 +1,62 @@
+
+
+# File ban\_list.h
+
+[**File List**](files.md) **>** [**ban**](dir_f1b1f2e9abb31749ef58cd98f22bcd78.md) **>** [**ban\_list.h**](ban__list_8h.md)
+
+[Go to the documentation of this file](ban__list_8h.md)
+
+
+```C++
+// Copyright (c) 2024, The Endstone Project. (https://endstone.dev) All Rights Reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+#pragma once
+
+#include <vector>
+#include <string>
+#include <optional>
+#include <chrono>
+
+namespace endstone {
+
+template <typename T>
+class BanList {
+public:
+    virtual ~BanList() = default;
+
+    virtual BanEntry<T>* getBanEntry(T target) const = 0;
+
+    virtual BanEntry<T>& addBan(T target,
+                                std::optional<std::string> reason,
+                                std::optional<std::chrono::system_clock::time_point> expires,
+                                std::optional<std::string> source) = 0;
+
+    virtual BanEntry<T>& addBan(T target,
+                                std::optional<std::string> reason,
+                                std::optional<std::chrono::seconds> duration,
+                                std::optional<std::string> source) = 0;
+
+    virtual std::vector<BanEntry<T>*> getEntries() const = 0;
+
+    virtual bool isBanned(T target) const = 0;
+
+    virtual void removeBan(T target) = 0;
+};
+
+}  // namespace endstone
+
+```
+
+
diff --git a/latest/assets/.doxy/reference/cpp/reference/cpp/class_member_functions.md b/latest/assets/.doxy/reference/cpp/reference/cpp/class_member_functions.md
@@ -15,6 +15,7 @@
 * **ActorRemoveEvent** ([**endstone::ActorRemoveEvent**](classendstone_1_1ActorRemoveEvent.md))
 * **ActorSpawnEvent** ([**endstone::ActorSpawnEvent**](classendstone_1_1ActorSpawnEvent.md))
 * **ActorTeleportEvent** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md))
+* **addBan** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **addFlag** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **addPlayer** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **allowChangesFrom** ([**endstone::Command**](classendstone_1_1Command.md))
@@ -122,6 +123,8 @@
 * **getSource** ([**endstone::ActorKnockbackEvent**](classendstone_1_1ActorKnockbackEvent.md))
 * **getFrom** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md), [**endstone::PlayerTeleportEvent**](classendstone_1_1PlayerTeleportEvent.md))
 * **getTo** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md), [**endstone::PlayerTeleportEvent**](classendstone_1_1PlayerTeleportEvent.md))
+* **getBanEntry** ([**endstone::BanList**](classendstone_1_1BanList.md))
+* **getEntries** ([**endstone::BanList**](classendstone_1_1BanList.md), [**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getData** ([**endstone::Block**](classendstone_1_1Block.md), [**endstone::BlockState**](classendstone_1_1BlockState.md))
 * **getRelative** ([**endstone::Block**](classendstone_1_1Block.md))
 * **getType** ([**endstone::Block**](classendstone_1_1Block.md), [**endstone::BlockData**](classendstone_1_1BlockData.md), [**endstone::BlockState**](classendstone_1_1BlockState.md), [**endstone::Dimension**](classendstone_1_1Dimension.md), [**endstone::ItemStack**](classendstone_1_1ItemStack.md), [**endstone::Packet**](classendstone_1_1Packet.md), [**endstone::ServerLoadEvent**](classendstone_1_1ServerLoadEvent.md), [**endstone::SpawnParticleEffectPacket**](classendstone_1_1SpawnParticleEffectPacket.md))
@@ -245,7 +248,6 @@
 * **getPendingTasks** ([**endstone::Scheduler**](classendstone_1_1Scheduler.md))
 * **getEntry** ([**endstone::Score**](classendstone_1_1Score.md))
 * **getObjective** ([**endstone::Score**](classendstone_1_1Score.md), [**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
-* **getEntries** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getObjectives** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getObjectivesByCriteria** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getScores** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
@@ -309,6 +311,7 @@
 * **isInWater** ([**endstone::Actor**](classendstone_1_1Actor.md))
 * **isOnGround** ([**endstone::Actor**](classendstone_1_1Actor.md))
 * **isCancellable** ([**endstone::ActorDeathEvent**](classendstone_1_1ActorDeathEvent.md), [**endstone::ActorKnockbackEvent**](classendstone_1_1ActorKnockbackEvent.md), [**endstone::ActorRemoveEvent**](classendstone_1_1ActorRemoveEvent.md), [**endstone::ActorSpawnEvent**](classendstone_1_1ActorSpawnEvent.md), [**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md), [**endstone::BlockBreakEvent**](classendstone_1_1BlockBreakEvent.md), [**endstone::BlockPlaceEvent**](classendstone_1_1BlockPlaceEvent.md), [**endstone::BroadcastMessageEvent**](classendstone_1_1BroadcastMessageEvent.md), [**endstone::Event**](classendstone_1_1Event.md), [**endstone::PlayerChatEvent**](classendstone_1_1PlayerChatEvent.md), [**endstone::PlayerCommandEvent**](classendstone_1_1PlayerCommandEvent.md), [**endstone::PlayerDeathEvent**](classendstone_1_1PlayerDeathEvent.md), [**endstone::PlayerInteractActorEvent**](classendstone_1_1PlayerInteractActorEvent.md), [**endstone::PlayerInteractEvent**](classendstone_1_1PlayerInteractEvent.md), [**endstone::PlayerJoinEvent**](classendstone_1_1PlayerJoinEvent.md), [**endstone::PlayerKickEvent**](classendstone_1_1PlayerKickEvent.md), [**endstone::PlayerLoginEvent**](classendstone_1_1PlayerLoginEvent.md), [**endstone::PlayerQuitEvent**](classendstone_1_1PlayerQuitEvent.md), [**endstone::PlayerTeleportEvent**](classendstone_1_1PlayerTeleportEvent.md), [**endstone::PluginDisableEvent**](classendstone_1_1PluginDisableEvent.md), [**endstone::PluginEnableEvent**](classendstone_1_1PluginEnableEvent.md), [**endstone::ScriptMessageEvent**](classendstone_1_1ScriptMessageEvent.md), [**endstone::ServerCommandEvent**](classendstone_1_1ServerCommandEvent.md), [**endstone::ServerListPingEvent**](classendstone_1_1ServerListPingEvent.md), [**endstone::ServerLoadEvent**](classendstone_1_1ServerLoadEvent.md), [**endstone::ThunderChangeEvent**](classendstone_1_1ThunderChangeEvent.md), [**endstone::WeatherChangeEvent**](classendstone_1_1WeatherChangeEvent.md))
+* **isBanned** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **isValid** ([**endstone::Block**](classendstone_1_1Block.md))
 * **isVisible** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **isRegistered** ([**endstone::Command**](classendstone_1_1Command.md))
@@ -403,6 +406,7 @@
 ## r
 
 * **removeScoreboardTag** ([**endstone::Actor**](classendstone_1_1Actor.md))
+* **removeBan** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **removeAll** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **removeFlag** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **removePlayer** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
@@ -582,6 +586,7 @@
 * **~ActorRemoveEvent** ([**endstone::ActorRemoveEvent**](classendstone_1_1ActorRemoveEvent.md))
 * **~ActorSpawnEvent** ([**endstone::ActorSpawnEvent**](classendstone_1_1ActorSpawnEvent.md))
 * **~ActorTeleportEvent** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md))
+* **~BanList** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **~Block** ([**endstone::Block**](classendstone_1_1Block.md))
 * **~BlockBreakEvent** ([**endstone::BlockBreakEvent**](classendstone_1_1BlockBreakEvent.md))
 * **~BlockData** ([**endstone::BlockData**](classendstone_1_1BlockData.md))

diff --git a/latest/assets/.doxy/reference/cpp/reference/cpp/class_members.md b/latest/assets/.doxy/reference/cpp/reference/cpp/class_members.md
@@ -16,6 +16,7 @@
 * **ActorRemoveEvent** ([**endstone::ActorRemoveEvent**](classendstone_1_1ActorRemoveEvent.md))
 * **ActorSpawnEvent** ([**endstone::ActorSpawnEvent**](classendstone_1_1ActorSpawnEvent.md))
 * **ActorTeleportEvent** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md))
+* **addBan** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **addFlag** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **addPlayer** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **Aqua** ([**endstone::ColorFormat**](structendstone_1_1ColorFormat.md))
@@ -182,6 +183,8 @@
 * **getSource** ([**endstone::ActorKnockbackEvent**](classendstone_1_1ActorKnockbackEvent.md))
 * **getFrom** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md), [**endstone::PlayerTeleportEvent**](classendstone_1_1PlayerTeleportEvent.md))
 * **getTo** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md), [**endstone::PlayerTeleportEvent**](classendstone_1_1PlayerTeleportEvent.md))
+* **getBanEntry** ([**endstone::BanList**](classendstone_1_1BanList.md))
+* **getEntries** ([**endstone::BanList**](classendstone_1_1BanList.md), [**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getData** ([**endstone::Block**](classendstone_1_1Block.md), [**endstone::BlockState**](classendstone_1_1BlockState.md))
 * **getRelative** ([**endstone::Block**](classendstone_1_1Block.md))
 * **getType** ([**endstone::Block**](classendstone_1_1Block.md), [**endstone::BlockData**](classendstone_1_1BlockData.md), [**endstone::BlockState**](classendstone_1_1BlockState.md), [**endstone::Dimension**](classendstone_1_1Dimension.md), [**endstone::ItemStack**](classendstone_1_1ItemStack.md), [**endstone::Packet**](classendstone_1_1Packet.md), [**endstone::ServerLoadEvent**](classendstone_1_1ServerLoadEvent.md), [**endstone::SpawnParticleEffectPacket**](classendstone_1_1SpawnParticleEffectPacket.md))
@@ -308,7 +311,6 @@
 * **getPendingTasks** ([**endstone::Scheduler**](classendstone_1_1Scheduler.md))
 * **getEntry** ([**endstone::Score**](classendstone_1_1Score.md))
 * **getObjective** ([**endstone::Score**](classendstone_1_1Score.md), [**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
-* **getEntries** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getObjectives** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getObjectivesByCriteria** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
 * **getScores** ([**endstone::Scoreboard**](classendstone_1_1Scoreboard.md))
@@ -377,6 +379,7 @@
 * **isInWater** ([**endstone::Actor**](classendstone_1_1Actor.md))
 * **isOnGround** ([**endstone::Actor**](classendstone_1_1Actor.md))
 * **isCancellable** ([**endstone::ActorDeathEvent**](classendstone_1_1ActorDeathEvent.md), [**endstone::ActorKnockbackEvent**](classendstone_1_1ActorKnockbackEvent.md), [**endstone::ActorRemoveEvent**](classendstone_1_1ActorRemoveEvent.md), [**endstone::ActorSpawnEvent**](classendstone_1_1ActorSpawnEvent.md), [**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md), [**endstone::BlockBreakEvent**](classendstone_1_1BlockBreakEvent.md), [**endstone::BlockPlaceEvent**](classendstone_1_1BlockPlaceEvent.md), [**endstone::BroadcastMessageEvent**](classendstone_1_1BroadcastMessageEvent.md), [**endstone::Event**](classendstone_1_1Event.md), [**endstone::PlayerChatEvent**](classendstone_1_1PlayerChatEvent.md), [**endstone::PlayerCommandEvent**](classendstone_1_1PlayerCommandEvent.md), [**endstone::PlayerDeathEvent**](classendstone_1_1PlayerDeathEvent.md), [**endstone::PlayerInteractActorEvent**](classendstone_1_1PlayerInteractActorEvent.md), [**endstone::PlayerInteractEvent**](classendstone_1_1PlayerInteractEvent.md), [**endstone::PlayerJoinEvent**](classendstone_1_1PlayerJoinEvent.md), [**endstone::PlayerKickEvent**](classendstone_1_1PlayerKickEvent.md), [**endstone::PlayerLoginEvent**](classendstone_1_1PlayerLoginEvent.md), [**endstone::PlayerQuitEvent**](classendstone_1_1PlayerQuitEvent.md), [**endstone::PlayerTeleportEvent**](classendstone_1_1PlayerTeleportEvent.md), [**endstone::PluginDisableEvent**](classendstone_1_1PluginDisableEvent.md), [**endstone::PluginEnableEvent**](classendstone_1_1PluginEnableEvent.md), [**endstone::ScriptMessageEvent**](classendstone_1_1ScriptMessageEvent.md), [**endstone::ServerCommandEvent**](classendstone_1_1ServerCommandEvent.md), [**endstone::ServerListPingEvent**](classendstone_1_1ServerListPingEvent.md), [**endstone::ServerLoadEvent**](classendstone_1_1ServerLoadEvent.md), [**endstone::ThunderChangeEvent**](classendstone_1_1ThunderChangeEvent.md), [**endstone::WeatherChangeEvent**](classendstone_1_1WeatherChangeEvent.md))
+* **isBanned** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **isValid** ([**endstone::Block**](classendstone_1_1Block.md))
 * **isVisible** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **Italic** ([**endstone::ColorFormat**](structendstone_1_1ColorFormat.md))
@@ -559,6 +562,7 @@
 
 * **removeScoreboardTag** ([**endstone::Actor**](classendstone_1_1Actor.md))
 * **raw\_knockback\_** ([**endstone::ActorKnockbackEvent**](classendstone_1_1ActorKnockbackEvent.md))
+* **removeBan** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **removeAll** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **removeFlag** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
 * **removePlayer** ([**endstone::BossBar**](classendstone_1_1BossBar.md))
@@ -784,6 +788,7 @@
 * **~ActorRemoveEvent** ([**endstone::ActorRemoveEvent**](classendstone_1_1ActorRemoveEvent.md))
 * **~ActorSpawnEvent** ([**endstone::ActorSpawnEvent**](classendstone_1_1ActorSpawnEvent.md))
 * **~ActorTeleportEvent** ([**endstone::ActorTeleportEvent**](classendstone_1_1ActorTeleportEvent.md))
+* **~BanList** ([**endstone::BanList**](classendstone_1_1BanList.md))
 * **~Block** ([**endstone::Block**](classendstone_1_1Block.md))
 * **~BlockBreakEvent** ([**endstone::BlockBreakEvent**](classendstone_1_1BlockBreakEvent.md))
 * **~BlockData** ([**endstone::BlockData**](classendstone_1_1BlockData.md))