mirror of https://github.com/PaperMC/Paper.git
185 lines
6.7 KiB
Diff
185 lines
6.7 KiB
Diff
From 0000000000000000000000000000000000000000 Mon Sep 17 00:00:00 2001
|
|
From: Aikar <aikar@aikar.co>
|
|
Date: Tue, 2 Jan 2018 00:31:08 -0500
|
|
Subject: [PATCH] Fill Profile Property Events
|
|
|
|
Allows plugins to populate profile properties from local sources to avoid calls out to Mojang API
|
|
to fill in textures for example.
|
|
|
|
If Mojang API does need to be hit, event fire so you can get the results.
|
|
|
|
This is useful for implementing a ProfileCache for Player Skulls
|
|
|
|
diff --git a/src/main/java/com/destroystokyo/paper/event/profile/FillProfileEvent.java b/src/main/java/com/destroystokyo/paper/event/profile/FillProfileEvent.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..c97ded9f9ef1c550cca7d0a3a3b09a85e5999cdf
|
|
--- /dev/null
|
|
+++ b/src/main/java/com/destroystokyo/paper/event/profile/FillProfileEvent.java
|
|
@@ -0,0 +1,79 @@
|
|
+/*
|
|
+ * Copyright (c) 2018 Daniel Ennis (Aikar) MIT License
|
|
+ *
|
|
+ * Permission is hereby granted, free of charge, to any person obtaining
|
|
+ * a copy of this software and associated documentation files (the
|
|
+ * "Software"), to deal in the Software without restriction, including
|
|
+ * without limitation the rights to use, copy, modify, merge, publish,
|
|
+ * distribute, sublicense, and/or sell copies of the Software, and to
|
|
+ * permit persons to whom the Software is furnished to do so, subject to
|
|
+ * the following conditions:
|
|
+ *
|
|
+ * The above copyright notice and this permission notice shall be
|
|
+ * included in all copies or substantial portions of the Software.
|
|
+ *
|
|
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
+ */
|
|
+
|
|
+package com.destroystokyo.paper.event.profile;
|
|
+
|
|
+import com.destroystokyo.paper.profile.PlayerProfile;
|
|
+import com.destroystokyo.paper.profile.ProfileProperty;
|
|
+import org.bukkit.event.Event;
|
|
+import org.bukkit.event.HandlerList;
|
|
+
|
|
+import java.util.Set;
|
|
+import org.jetbrains.annotations.ApiStatus;
|
|
+import org.jetbrains.annotations.NotNull;
|
|
+
|
|
+/**
|
|
+ * Fired once a profiles additional properties (such as textures) has been filled
|
|
+ */
|
|
+public class FillProfileEvent extends Event {
|
|
+
|
|
+ private static final HandlerList HANDLER_LIST = new HandlerList();
|
|
+
|
|
+ @NotNull private final PlayerProfile profile;
|
|
+
|
|
+ @ApiStatus.Internal
|
|
+ public FillProfileEvent(@NotNull PlayerProfile profile) {
|
|
+ super(!org.bukkit.Bukkit.isPrimaryThread());
|
|
+ this.profile = profile;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * @return The Profile that had properties filled
|
|
+ */
|
|
+ @NotNull
|
|
+ public PlayerProfile getPlayerProfile() {
|
|
+ return this.profile;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Same as .getPlayerProfile().getProperties()
|
|
+ *
|
|
+ * @see PlayerProfile#getProperties()
|
|
+ * @return The new properties on the profile.
|
|
+ */
|
|
+ @NotNull
|
|
+ public Set<ProfileProperty> getProperties() {
|
|
+ return this.profile.getProperties();
|
|
+ }
|
|
+
|
|
+ @NotNull
|
|
+ @Override
|
|
+ public HandlerList getHandlers() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+
|
|
+ @NotNull
|
|
+ public static HandlerList getHandlerList() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+}
|
|
diff --git a/src/main/java/com/destroystokyo/paper/event/profile/PreFillProfileEvent.java b/src/main/java/com/destroystokyo/paper/event/profile/PreFillProfileEvent.java
|
|
new file mode 100644
|
|
index 0000000000000000000000000000000000000000..e2a47c4af2c368a361e4a370a01111abe8e48062
|
|
--- /dev/null
|
|
+++ b/src/main/java/com/destroystokyo/paper/event/profile/PreFillProfileEvent.java
|
|
@@ -0,0 +1,81 @@
|
|
+/*
|
|
+ * Copyright (c) 2018 Daniel Ennis (Aikar) MIT License
|
|
+ *
|
|
+ * Permission is hereby granted, free of charge, to any person obtaining
|
|
+ * a copy of this software and associated documentation files (the
|
|
+ * "Software"), to deal in the Software without restriction, including
|
|
+ * without limitation the rights to use, copy, modify, merge, publish,
|
|
+ * distribute, sublicense, and/or sell copies of the Software, and to
|
|
+ * permit persons to whom the Software is furnished to do so, subject to
|
|
+ * the following conditions:
|
|
+ *
|
|
+ * The above copyright notice and this permission notice shall be
|
|
+ * included in all copies or substantial portions of the Software.
|
|
+ *
|
|
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
|
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
|
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
|
+ * LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
|
+ * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
|
+ * WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
+ */
|
|
+
|
|
+package com.destroystokyo.paper.event.profile;
|
|
+
|
|
+import com.destroystokyo.paper.profile.PlayerProfile;
|
|
+import com.destroystokyo.paper.profile.ProfileProperty;
|
|
+import org.bukkit.event.Event;
|
|
+import org.bukkit.event.HandlerList;
|
|
+
|
|
+import java.util.Collection;
|
|
+import org.jetbrains.annotations.ApiStatus;
|
|
+import org.jetbrains.annotations.NotNull;
|
|
+
|
|
+/**
|
|
+ * Fired when the server is requesting to fill in properties of an incomplete profile, such as textures.
|
|
+ * <p>
|
|
+ * Allows plugins to pre-populate cached properties and avoid a call to the Mojang API
|
|
+ */
|
|
+public class PreFillProfileEvent extends Event {
|
|
+
|
|
+ private static final HandlerList HANDLER_LIST = new HandlerList();
|
|
+
|
|
+ @NotNull private final PlayerProfile profile;
|
|
+
|
|
+ @ApiStatus.Internal
|
|
+ public PreFillProfileEvent(@NotNull PlayerProfile profile) {
|
|
+ super(!org.bukkit.Bukkit.isPrimaryThread());
|
|
+ this.profile = profile;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * @return The profile that needs its properties filled
|
|
+ */
|
|
+ @NotNull
|
|
+ public PlayerProfile getPlayerProfile() {
|
|
+ return this.profile;
|
|
+ }
|
|
+
|
|
+ /**
|
|
+ * Sets the properties on the profile, avoiding the call to the Mojang API
|
|
+ * Same as .getPlayerProfile().setProperties(properties);
|
|
+ *
|
|
+ * @see PlayerProfile#setProperties(Collection)
|
|
+ * @param properties The properties to set/append
|
|
+ */
|
|
+ public void setProperties(@NotNull Collection<ProfileProperty> properties) {
|
|
+ this.profile.setProperties(properties);
|
|
+ }
|
|
+
|
|
+ @NotNull
|
|
+ @Override
|
|
+ public HandlerList getHandlers() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+
|
|
+ @NotNull
|
|
+ public static HandlerList getHandlerList() {
|
|
+ return HANDLER_LIST;
|
|
+ }
|
|
+}
|