Player.setPlayerProfile API

This can be useful for changing name or skins after a player has logged in.
This commit is contained in:
Aikar 2018-03-18 12:28:55 -04:00
parent 2eaa723e96
commit 4447307899
5 changed files with 36 additions and 1 deletions

View file

@ -1380,8 +1380,10 @@ public final class Bukkit {
* @return the new PlayerProfile
* @throws IllegalArgumentException if both the unique id is
* <code>null</code> and the name is <code>null</code> or blank
* @deprecated use {@link #createProfile(UUID, String)}
*/
@NotNull
@Deprecated(since = "1.18.1") // Paper
public static PlayerProfile createPlayerProfile(@Nullable UUID uniqueId, @Nullable String name) {
return server.createPlayerProfile(uniqueId, name);
}
@ -1392,8 +1394,10 @@ public final class Bukkit {
* @param uniqueId the unique id
* @return the new PlayerProfile
* @throws IllegalArgumentException if the unique id is <code>null</code>
* @deprecated use {@link #createProfile(UUID)}
*/
@NotNull
@Deprecated(since = "1.18.1") // Paper
public static PlayerProfile createPlayerProfile(@NotNull UUID uniqueId) {
return server.createPlayerProfile(uniqueId);
}
@ -1405,8 +1409,10 @@ public final class Bukkit {
* @return the new PlayerProfile
* @throws IllegalArgumentException if the name is <code>null</code> or
* blank
* @deprecated use {@link #createProfile(String)}
*/
@NotNull
@Deprecated(since = "1.18.1") // Paper
public static PlayerProfile createPlayerProfile(@NotNull String name) {
return server.createPlayerProfile(name);
}

View file

@ -59,7 +59,7 @@ public interface OfflinePlayer extends ServerOperator, AnimalTamer, Configuratio
* @return the player's profile
*/
@NotNull
PlayerProfile getPlayerProfile();
com.destroystokyo.paper.profile.PlayerProfile getPlayerProfile(); // Paper
/**
* Checks if this player has had their profile banned.

View file

@ -1167,8 +1167,10 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
* @return the new PlayerProfile
* @throws IllegalArgumentException if both the unique id is
* <code>null</code> and the name is <code>null</code> or blank
* @deprecated use {@link #createProfile(UUID, String)}
*/
@NotNull
@Deprecated(since = "1.18.1") // Paper
PlayerProfile createPlayerProfile(@Nullable UUID uniqueId, @Nullable String name);
/**
@ -1177,8 +1179,10 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
* @param uniqueId the unique id
* @return the new PlayerProfile
* @throws IllegalArgumentException if the unique id is <code>null</code>
* @deprecated use {@link #createProfile(UUID)}
*/
@NotNull
@Deprecated(since = "1.18.1") // Paper
PlayerProfile createPlayerProfile(@NotNull UUID uniqueId);
/**
@ -1188,8 +1192,10 @@ public interface Server extends PluginMessageRecipient, net.kyori.adventure.audi
* @return the new PlayerProfile
* @throws IllegalArgumentException if the name is <code>null</code> or
* blank
* @deprecated use {@link #createProfile(String)}
*/
@NotNull
@Deprecated(since = "1.18.1") // Paper
PlayerProfile createPlayerProfile(@NotNull String name);
/**

View file

@ -3154,6 +3154,26 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
}
// Paper end
// Paper start - Player Profile API
/**
* Gets a copy of this players profile
*
* @return The players profile object
*/
com.destroystokyo.paper.profile.@NotNull PlayerProfile getPlayerProfile();
/**
* Changes the PlayerProfile for this player. This will cause this player
* to be re-registered to all clients that can currently see this player.
* <p>
* After executing this method, the player {@link java.util.UUID} won't
* be swapped, only their name and profile properties.
*
* @param profile The new profile to use
*/
void setPlayerProfile(com.destroystokyo.paper.profile.@NotNull PlayerProfile profile);
// Paper end - Player Profile API
// Spigot start
public class Spigot extends Entity.Spigot {

View file

@ -16,7 +16,9 @@ import org.jetbrains.annotations.Nullable;
* <p>
* New profiles can be created via
* {@link Server#createPlayerProfile(UUID, String)}.
* @deprecated see {@link com.destroystokyo.paper.profile.PlayerProfile}
*/
@Deprecated(since = "1.18.1") // Paper
public interface PlayerProfile extends Cloneable, ConfigurationSerializable {
/**
@ -25,6 +27,7 @@ public interface PlayerProfile extends Cloneable, ConfigurationSerializable {
* @return the player's unique id, or <code>null</code> if not available
*/
@Nullable
@Deprecated(since = "1.18.1") // Paper
UUID getUniqueId();
/**