DisguiseAPI

```
public interface DisguiseAPI
```
The API to hook into iDisguise. The following code returns an instance:
Bukkit.getServicesManager().getRegistration(DisguiseAPI.class).getProvider();

Since:

2.1.3

Author:

RobinGrether

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`canSeeThrough(org.bukkit.OfflinePlayer player)`	Indicates whether a given player can see through disguises.
`boolean`	`disguise(org.bukkit.entity.LivingEntity livingEntity, Disguise disguise)`	Disguise a living entity. Calling `disguise(livingEntity, disguise)` is equivalent to calling `disguise(livingEntity, disguise, true)`. This function must only be accessed synchronously.
`boolean`	`disguise(org.bukkit.entity.LivingEntity livingEntity, Disguise disguise, boolean fireEvent)`	Disguise a living entity. This function must only be accessed synchronously.
`boolean`	`disguise(org.bukkit.entity.Player player, Disguise disguise)`	Disguise a player. Calling `disguise(player, disguise)` is equivalent to calling `disguise(player, disguise, true)`. This function must only be accessed synchronously.
`boolean`	`disguise(org.bukkit.entity.Player player, Disguise disguise, boolean fireEvent)`	Disguise a player. This function must only be accessed synchronously.
`boolean`	`disguise(org.bukkit.OfflinePlayer offlinePlayer, Disguise disguise)`	Disguise an offline player. Calling `disguise(offlinePlayer, disguise)` is equivalent to calling `disguise(offlinePlayer, disguise, true)`. This function must only be accessed synchronously.
`boolean`	`disguise(org.bukkit.OfflinePlayer offlinePlayer, Disguise disguise, boolean fireEvent)`	Disguise an offline player. This function must only be accessed synchronously.
`Disguise`	`getDisguise(org.bukkit.entity.LivingEntity livingEntity)`	Get a copy of a living entity's current disguise.
`Disguise`	`getDisguise(org.bukkit.entity.Player player)`	Get a copy of a player's current disguise.
`Disguise`	`getDisguise(org.bukkit.OfflinePlayer offlinePlayer)`	Get a copy of an offline player's current disguise.
`java.util.Set<java.lang.Object>`	`getDisguisedEntities()`	Get a Set of all disguised players (online and offline) and entities. Each element of this Set is an instance of either OfflinePlayer or LivingEntity.
`int`	`getNumberOfDisguisedPlayers()`	Get the number of online players who are disguised.
`Sounds`	`getSoundsForEntity(DisguiseType type)`	Gets the `Sounds` for a specific entity type.
`boolean`	`hasPermission(org.bukkit.entity.Player player, Disguise disguise)`	Indicates whether a given player has the required permissions to carry the given disguise.
`boolean`	`hasPermission(org.bukkit.entity.Player player, DisguiseType type)`	Indicates whether a given player has the required permissions to disguise as the given disguise type. This function will always return `false` for `DisguiseType.PLAYER`.
`boolean`	`isDisguised(org.bukkit.entity.LivingEntity livingEntity)`	Indicates whether a living entity is disguised.
`boolean`	`isDisguised(org.bukkit.entity.Player player)`	Indicates whether a player is disguised.
`boolean`	`isDisguised(org.bukkit.OfflinePlayer offlinePlayer)`	Indicates whether an offline player is disguised.
`boolean`	`isDisguisedTo(org.bukkit.entity.LivingEntity livingEntity, org.bukkit.entity.Player observer)`	Indicates whether a living entity is disguised and the disguise is visible to a given observer. Calling this function is similar to: `api.isDisguised(livingEntity) && api.getDisguise(livingEntity).isVisibleTo(observer)`
`boolean`	`isDisguisedTo(org.bukkit.entity.Player player, org.bukkit.entity.Player observer)`	Indicates whether a player is disguised and the disguise is visible to a given observer. Calling this function is similar to: `api.isDisguised(player) && api.getDisguise(player).isVisibleTo(observer)`
`boolean`	`isDisguisedTo(org.bukkit.OfflinePlayer offlinePlayer, org.bukkit.entity.Player observer)`	Indicates whether an offline player is disguised and the disguise is visible to a given observer. Calling this function is similar to: `api.isDisguised(offlinePlayer) && api.getDisguise(offlinePlayer).isVisibleTo(observer)`
`boolean`	`isSoundsEnabled()`	Indicates whether the disguised players' sounds are currently replaced.
`void`	`setSeeThrough(org.bukkit.OfflinePlayer player, boolean seeThrough)`	Sets whether a given player can see through disguises.
`void`	`setSoundsEnabled(boolean enabled)`	Sets whether the disguised players' sounds are replaced.
`boolean`	`setSoundsForEntity(DisguiseType type, Sounds sounds)`	Sets the `Sounds` for a specific entity type.
`boolean`	`undisguise(org.bukkit.entity.LivingEntity livingEntity)`	Undisguise a living entity. Calling `undisguise(livingEntity)` is equivalent to calling `undisguise(livingEntity, true)`. This function must only be accessed synchronously.
`boolean`	`undisguise(org.bukkit.entity.LivingEntity livingEntity, boolean fireEvent)`	Undisguise a living entity. This function must only be accessed synchronously.
`boolean`	`undisguise(org.bukkit.entity.Player player)`	Undisguise a player. Calling `undisguise(player)` is equivalent to calling `undisguise(player, true)`. This function must only be accessed synchronously.
`boolean`	`undisguise(org.bukkit.entity.Player player, boolean fireEvent)`	Undisguise a player. This function must only be accessed synchronously.
`boolean`	`undisguise(org.bukkit.OfflinePlayer offlinePlayer)`	Undisguise an offline player. Calling `undisguise(offlinePlayer)` is equivalent to calling `undisguise(offlinePlayer, true)`. This function must only be accessed synchronously.
`boolean`	`undisguise(org.bukkit.OfflinePlayer offlinePlayer, boolean fireEvent)`	Undisguise an offline player. This function must only be accessed synchronously.
`void`	`undisguiseAll()`	Undisguise everyone (includes online and offline players as well as entities). This function must only be accessed synchronously.

- Method Detail
  - disguise
```
boolean disguise(org.bukkit.OfflinePlayer offlinePlayer,
                 Disguise disguise)
```
    Disguise an offline player.
    Calling disguise(offlinePlayer, disguise) is equivalent to calling disguise(offlinePlayer, disguise, true).
    
    This function must only be accessed synchronously.
    
    Returns:
    
    false, if another plugin denies the disguise
    
    Since:
    
    5.1.1
  - disguise
```
boolean disguise(org.bukkit.entity.Player player,
                 Disguise disguise)
```
    Disguise a player.
    Calling disguise(player, disguise) is equivalent to calling disguise(player, disguise, true).
    
    This function must only be accessed synchronously.
    
    Returns:
    
    false, if another plugin denies the disguise
    
    Since:
    
    5.7.1
  - disguise
```
boolean disguise(org.bukkit.entity.LivingEntity livingEntity,
                 Disguise disguise)
```
    Disguise a living entity.
    Calling disguise(livingEntity, disguise) is equivalent to calling disguise(livingEntity, disguise, true).
    
    This function must only be accessed synchronously.
    
    Returns:
    
    false, if another plugin denies the disguise
    
    Since:
    
    5.7.1
  - disguise
```
boolean disguise(org.bukkit.OfflinePlayer offlinePlayer,
                 Disguise disguise,
                 boolean fireEvent)
```
    Disguise an offline player.
    
    This function must only be accessed synchronously.
    
    Parameters:
    
    fireEvent - whether an event (OfflinePlayerDisguiseEvent or DisguiseEvent) shall be fired
    
    Returns:
    
    false, if another plugin denies the disguise
    
    Since:
    
    5.1.1
  - disguise
```
boolean disguise(org.bukkit.entity.Player player,
                 Disguise disguise,
                 boolean fireEvent)
```
    Disguise a player.
    
    This function must only be accessed synchronously.
    
    Parameters:
    
    fireEvent - whether an event (DisguiseEvent) shall be fired
    
    Returns:
    
    false, if another plugin denies the disguise
    
    Since:
    
    5.7.1
  - disguise
```
boolean disguise(org.bukkit.entity.LivingEntity livingEntity,
                 Disguise disguise,
                 boolean fireEvent)
```
    Disguise a living entity.
    
    This function must only be accessed synchronously.
    
    Parameters:
    
    fireEvent - whether an event (EntityDisguiseEvent) shall be fired
    
    Returns:
    
    false, if another plugin denies the disguise
    
    Since:
    
    5.7.1
  - undisguise
```
boolean undisguise(org.bukkit.OfflinePlayer offlinePlayer)
```
    Undisguise an offline player.
    Calling undisguise(offlinePlayer) is equivalent to calling undisguise(offlinePlayer, true).
    
    This function must only be accessed synchronously.
    
    Returns:
    
    false, if another plugin denies the undisguise
    
    Since:
    
    5.1.1
  - undisguise
```
boolean undisguise(org.bukkit.entity.Player player)
```
    Undisguise a player.
    Calling undisguise(player) is equivalent to calling undisguise(player, true).
    
    This function must only be accessed synchronously.
    
    Returns:
    
    false, if another plugin denies the undisguise
    
    Since:
    
    5.7.1
  - undisguise
```
boolean undisguise(org.bukkit.entity.LivingEntity livingEntity)
```
    Undisguise a living entity.
    Calling undisguise(livingEntity) is equivalent to calling undisguise(livingEntity, true).
    
    This function must only be accessed synchronously.
    
    Returns:
    
    false, if another plugin denies the undisguise
    
    Since:
    
    5.7.1
  - undisguise
```
boolean undisguise(org.bukkit.OfflinePlayer offlinePlayer,
                   boolean fireEvent)
```
    Undisguise an offline player.
    
    This function must only be accessed synchronously.
    
    Parameters:
    
    fireEvent - whether an event (OfflinePlayerUndisguiseEvent or UndisguiseEvent) shall be fired
    
    Returns:
    
    false, if another plugin denies the undisguise
    
    Since:
    
    5.1.1
  - undisguise
```
boolean undisguise(org.bukkit.entity.Player player,
                   boolean fireEvent)
```
    Undisguise a player.
    
    This function must only be accessed synchronously.
    
    Parameters:
    
    fireEvent - whether an event (UndisguiseEvent) shall be fired
    
    Returns:
    
    false, if another plugin denies the undisguise
    
    Since:
    
    5.7.1
  - undisguise
```
boolean undisguise(org.bukkit.entity.LivingEntity livingEntity,
                   boolean fireEvent)
```
    Undisguise a living entity.
    
    This function must only be accessed synchronously.
    
    Parameters:
    
    fireEvent - whether an event (EntityUndisguiseEvent) shall be fired
    
    Returns:
    
    false, if another plugin denies the undisguise
    
    Since:
    
    5.7.1
  - undisguiseAll
```
void undisguiseAll()
```
    Undisguise everyone (includes online and offline players as well as entities).
    
    This function must only be accessed synchronously.
    
    Since:
    
    2.1.3
  - isDisguised
```
boolean isDisguised(org.bukkit.OfflinePlayer offlinePlayer)
```
    Indicates whether an offline player is disguised.
    
    Since:
    
    5.1.1
  - isDisguised
```
boolean isDisguised(org.bukkit.entity.Player player)
```
    Indicates whether a player is disguised.
    
    Since:
    
    2.1.3
  - isDisguised
```
boolean isDisguised(org.bukkit.entity.LivingEntity livingEntity)
```
    Indicates whether a living entity is disguised.
    
    Since:
    
    5.7.1
  - isDisguisedTo
```
boolean isDisguisedTo(org.bukkit.OfflinePlayer offlinePlayer,
                      org.bukkit.entity.Player observer)
```
    Indicates whether an offline player is disguised and the disguise is visible to a given observer.
    Calling this function is similar to: api.isDisguised(offlinePlayer) && api.getDisguise(offlinePlayer).isVisibleTo(observer)
    
    Parameters:
    
    offlinePlayer - the offline player to check
    
    observer - the observing player
    
    Returns:
    
    true, if and only if the offline player is disguised and the disguise is visible to the given observer
    
    Since:
    
    5.6.1
  - isDisguisedTo
```
boolean isDisguisedTo(org.bukkit.entity.Player player,
                      org.bukkit.entity.Player observer)
```
    Indicates whether a player is disguised and the disguise is visible to a given observer.
    Calling this function is similar to: api.isDisguised(player) && api.getDisguise(player).isVisibleTo(observer)
    
    Parameters:
    
    player - the player to check
    
    observer - the observing player
    
    Returns:
    
    true, if and only if the player is disguised and the disguise is visible to the given observer
    
    Since:
    
    5.7.1
  - isDisguisedTo
```
boolean isDisguisedTo(org.bukkit.entity.LivingEntity livingEntity,
                      org.bukkit.entity.Player observer)
```
    Indicates whether a living entity is disguised and the disguise is visible to a given observer.
    Calling this function is similar to: api.isDisguised(livingEntity) && api.getDisguise(livingEntity).isVisibleTo(observer)
    
    Parameters:
    
    livingEntity - the living entity to check
    
    observer - the observing player
    
    Returns:
    
    true, if and only if the living entity is disguised and the disguise is visible to the given observer
    
    Since:
    
    5.7.1
  - getDisguise
```
Disguise getDisguise(org.bukkit.OfflinePlayer offlinePlayer)
```
    Get a copy of an offline player's current disguise.
    
    Returns:
    
    a copy of the given offline player's disguise
    
    Since:
    
    5.1.1
  - getDisguise
```
Disguise getDisguise(org.bukkit.entity.Player player)
```
    Get a copy of a player's current disguise.
    
    Returns:
    
    a copy of the given player's disguise
    
    Since:
    
    2.1.3
  - getDisguise
```
Disguise getDisguise(org.bukkit.entity.LivingEntity livingEntity)
```
    Get a copy of a living entity's current disguise.
    
    Returns:
    
    a copy of the given living entity's disguise
    
    Since:
    
    5.7.1
  - getNumberOfDisguisedPlayers
```
int getNumberOfDisguisedPlayers()
```
    Get the number of online players who are disguised.
    
    Returns:
    
    the number of online players who are disguised
    
    Since:
    
    5.6.1
  - getSoundsForEntity
```
Sounds getSoundsForEntity(DisguiseType type)
```
    Gets the Sounds for a specific entity type.
    
    Parameters:
    
    type - the entity/disguise type
    
    Returns:
    
    the sounds for the given entity/disguise type
    
    Since:
    
    5.1.1
  - setSoundsForEntity
```
boolean setSoundsForEntity(DisguiseType type,
                           Sounds sounds)
```
    Sets the Sounds for a specific entity type.
    
    Parameters:
    
    type - the entity/disguise type
    
    sounds - the sounds
    
    Returns:
    
    true, if the sounds have been set
    
    Since:
    
    5.1.1
  - isSoundsEnabled
```
boolean isSoundsEnabled()
```
    Indicates whether the disguised players' sounds are currently replaced.
    
    Returns:
    
    true, if they are replaced
    
    Since:
    
    5.1.1
  - setSoundsEnabled
```
void setSoundsEnabled(boolean enabled)
```
    Sets whether the disguised players' sounds are replaced.
    
    Parameters:
    
    enabled - true, if they shall be replaced
    
    Since:
    
    5.1.1
  - hasPermission
```
boolean hasPermission(org.bukkit.entity.Player player,
                      DisguiseType type)
```
    Indicates whether a given player has the required permissions to disguise as the given disguise type.
    This function will always return false for DisguiseType.PLAYER.
    
    Parameters:
    
    player - the player
    
    type - the disguise type
    
    Returns:
    
    true, if and only if the player has the required permissions
    
    Since:
    
    5.5.4
  - hasPermission
```
boolean hasPermission(org.bukkit.entity.Player player,
                      Disguise disguise)
```
    Indicates whether a given player has the required permissions to carry the given disguise.
    
    Parameters:
    
    player - the player
    
    disguise - the disguise
    
    Returns:
    
    true, if and only if the player has all required permissions for the given disguise (including subtype permissions)
    
    Since:
    
    5.5.4
  - canSeeThrough
```
boolean canSeeThrough(org.bukkit.OfflinePlayer player)
```
    Indicates whether a given player can see through disguises.
    
    Parameters:
    
    player - the player
    
    Returns:
    
    true, if the player can see through disguises
    
    Since:
    
    5.6.4
  - setSeeThrough
```
void setSeeThrough(org.bukkit.OfflinePlayer player,
                   boolean seeThrough)
```
    Sets whether a given player can see through disguises.
    
    Parameters:
    
    player - the player
    
    seeThrough - true, if the player shall see through disguises
    
    Since:
    
    5.6.4
  - getDisguisedEntities
```
java.util.Set<java.lang.Object> getDisguisedEntities()
```
    Get a Set of all disguised players (online and offline) and entities.
    Each element of this Set is an instance of either OfflinePlayer or LivingEntity.
    
    Since:
    
    5.7.1

Interface DisguiseAPI

Method Summary

Method Detail

disguise

disguise

disguise

disguise

disguise

disguise

undisguise

undisguise

undisguise

undisguise

undisguise

undisguise

undisguiseAll

isDisguised

isDisguised

isDisguised

isDisguisedTo

isDisguisedTo

isDisguisedTo

getDisguise

getDisguise

getDisguise

getNumberOfDisguisedPlayers

getSoundsForEntity

setSoundsForEntity

isSoundsEnabled

setSoundsEnabled

hasPermission

hasPermission

canSeeThrough

setSeeThrough

getDisguisedEntities