com.destroystokyo.paper.event.profile

Class PreLookupProfileEvent

java.lang.Object

org.bukkit.event.Event

com.destroystokyo.paper.event.profile.PreLookupProfileEvent

public class PreLookupProfileEvent
extends Event

Allows a plugin to intercept a Profile Lookup for a Profile by name At the point of event fire, the UUID and properties are unset. If a plugin sets the UUID, and optionally the properties, the API call to look up the profile may be skipped. No guarantees are made about thread execution context for this event. If you need to know, check event.isAsync()

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Constructor Summary

Constructors

Constructor and Description
PreLookupProfileEvent(String name)

Method Summary

Modifier and Type	Method and Description
void	addProperties(com.google.common.collect.Multimap<String,com.mojang.authlib.properties.Property> properties) Deprecated. will be removed with 1.13
static HandlerList	getHandlerList()
HandlerList	getHandlers()
String	getName()
com.google.common.collect.Multimap<String,com.mojang.authlib.properties.Property>	getProperties() Deprecated. will be removed with 1.13
UUID	getUUID() If this value is left null by the completion of the event call, then the server will trigger a call to the Mojang API to look up the UUID (Network Request), and subsequently, fire a LookupProfileEvent
void	setProperties(com.google.common.collect.Multimap<String,com.mojang.authlib.properties.Property> properties) Deprecated. will be removed with 1.13
void	setUUID(UUID uuid) Sets the UUID for this player name.
static com.mojang.authlib.GameProfileRepository	wrapProfileRepository(com.mojang.authlib.GameProfileRepository orig) Deprecated. will be removed with 1.13

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PreLookupProfileEvent

public PreLookupProfileEvent(@Nonnull
                             String name)

Method Detail

getName

@Nonnull
public String getName()

Returns:

Name of the profile

getUUID

@Nullable
public UUID getUUID()

If this value is left null by the completion of the event call, then the server will trigger a call to the Mojang API to look up the UUID (Network Request), and subsequently, fire a LookupProfileEvent

Returns:

The UUID of the profile if it has already been provided by a plugin

setUUID

public void setUUID(@Nullable
                    UUID uuid)

Sets the UUID for this player name. This will skip the initial API call to find the players UUID. However, if Profile Properties are needed by the server, you must also set them or else an API call will still be made.

Parameters:

uuid - the UUID to set on the GameProfile or null to reset

getProperties

@Deprecated
 @Nonnull
public com.google.common.collect.Multimap<String,com.mojang.authlib.properties.Property> getProperties()

Deprecated. will be removed with 1.13

Get the properties for this profile

Returns:

the property map to attach to the new GameProfile

setProperties

@Deprecated
public void setProperties(com.google.common.collect.Multimap<String,com.mojang.authlib.properties.Property> properties)

Deprecated. will be removed with 1.13

Completely replaces all Properties with the new provided properties

Parameters:

properties - the properties to set on the new profile

addProperties

@Deprecated
public void addProperties(com.google.common.collect.Multimap<String,com.mojang.authlib.properties.Property> properties)

Deprecated. will be removed with 1.13

Adds additional properties, without removing the original properties

Parameters:

properties - the properties to add to the existing properties

getHandlers

public HandlerList getHandlers()

Specified by:

getHandlers in class Event

getHandlerList

public static HandlerList getHandlerList()

wrapProfileRepository

@Deprecated
public static com.mojang.authlib.GameProfileRepository wrapProfileRepository(com.mojang.authlib.GameProfileRepository orig)

Deprecated. will be removed with 1.13

Wraps the Profile Repository so we can intercept all lookups