NucleusAFKService (nucleus-api 1.14.6-S7.1 API)

```
public interface NucleusAFKService
```
Allows plugins to see a player's AFK status.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods Deprecated Methods
Modifier and Type	Method and Description
`boolean`	`canBeKicked(org.spongepowered.api.entity.living.player.User user)` Returns whether a `User` can be kicked for inactivity.
`boolean`	`canGoAFK(org.spongepowered.api.entity.living.player.User user)` Returns whether the `User` in question can go AFK.
`default AutoCloseable`	`disableTrackingFor(org.spongepowered.api.entity.living.player.Player player)` Deprecated. Use `disableTrackingForPlayer(Player, int)` instead.
`default AutoCloseable`	`disableTrackingFor(org.spongepowered.api.entity.living.player.Player player, int ticks)` Deprecated. Use `disableTrackingForPlayer(Player, int)` instead.
`default NoExceptionAutoClosable`	`disableTrackingForPlayer(org.spongepowered.api.entity.living.player.Player player)` Disables activity tracking for the specified `Player` for the next tick.
`NoExceptionAutoClosable`	`disableTrackingForPlayer(org.spongepowered.api.entity.living.player.Player player, int ticks)` Disables activity tracking for the specified `Player` for up to the number of ticks specified.
`Collection<org.spongepowered.api.entity.living.player.Player>`	`getAfk()` Returns a collection of players who are currently AFK.
`void`	`invalidateCachedPermissions()` Invalidates cached permissions, used to resync a player's exemption status.
`boolean`	`isAFK(org.spongepowered.api.entity.living.player.Player player)` Returns whether a player is AFK
`Instant`	`lastActivity(org.spongepowered.api.entity.living.player.Player player)` Returns the last recorded active moment of the player.
`boolean`	`setAFK(org.spongepowered.api.event.cause.Cause cause, org.spongepowered.api.entity.living.player.Player player, boolean isAfk)` Sets a player's AFK status, if the player can go AFK.
`Optional<Duration>`	`timeForInactivity(org.spongepowered.api.entity.living.player.User user)` Returns how long the specified `User` has to be inactive before going AFK.
`Optional<Duration>`	`timeForKick(org.spongepowered.api.entity.living.player.User user)` Returns how long the specified `User` has to be inactive before being kicked.
`default Duration`	`timeSinceLastActivity(org.spongepowered.api.entity.living.player.Player player)` Returns the `Duration` since last recorded active moment of the player.
`void`	`updateActivityForUser(org.spongepowered.api.entity.living.player.Player player)` Forces an activity tracking update for a `Player`, such that Nucleus thinks that the player has recently been active and resets their AFK timer.

- Method Detail
  - canGoAFK
```
boolean canGoAFK(org.spongepowered.api.entity.living.player.User user)
```
    Returns whether the User in question can go AFK.
    
    Parameters:
    
    user - The User in question
    
    Returns:
    
    Whether or not the player can go AFK.
  - getAfk
```
Collection<org.spongepowered.api.entity.living.player.Player> getAfk()
```
    Returns a collection of players who are currently AFK.
    
    Returns:
    
    A Collection of Players
  - isAFK
```
boolean isAFK(org.spongepowered.api.entity.living.player.Player player)
```
    Returns whether a player is AFK
    
    Parameters:
    
    player - The player in question.
    
    Returns:
    
    Whether the player is AFK.
  - setAFK
```
boolean setAFK(org.spongepowered.api.event.cause.Cause cause,
               org.spongepowered.api.entity.living.player.Player player,
               boolean isAfk)
```
    Sets a player's AFK status, if the player can go AFK.
    
    Parameters:
    
    cause - The cause for going AFK. The root cause must be a PluginContainer.
    
    player - The player to set the status of.
    
    isAfk - Whether the player should go AFK.
    
    Returns:
    
    true if successful, otherwise false, usually because the player is exempt from going AFK.
  - canBeKicked
```
boolean canBeKicked(org.spongepowered.api.entity.living.player.User user)
```
    Returns whether a User can be kicked for inactivity.
    
    Parameters:
    
    user - The User in question.
    
    Returns:
    
    Whether the player can be kicked.
  - lastActivity
```
Instant lastActivity(org.spongepowered.api.entity.living.player.Player player)
```
    Returns the last recorded active moment of the player.
    
    Parameters:
    
    player - The player in question
    
    Returns:
    
    The Instant
  - timeSinceLastActivity
```
default Duration timeSinceLastActivity(org.spongepowered.api.entity.living.player.Player player)
```
    Returns the Duration since last recorded active moment of the player.
    
    Parameters:
    
    player - The player in question
    
    Returns:
    
    The Instant
  - timeForInactivity
```
Optional<Duration> timeForInactivity(org.spongepowered.api.entity.living.player.User user)
```
    Returns how long the specified User has to be inactive before going AFK.
    
    Parameters:
    
    user - The User in question.
    
    Returns:
    
    The Duration, or Optional.empty() if the player cannot go AFK.
  - timeForKick
```
Optional<Duration> timeForKick(org.spongepowered.api.entity.living.player.User user)
```
    Returns how long the specified User has to be inactive before being kicked.
    
    Parameters:
    
    user - The User in question.
    
    Returns:
    
    The Duration, or Optional.empty() if the player cannot go AFK.
  - invalidateCachedPermissions
```
void invalidateCachedPermissions()
```
    Invalidates cached permissions, used to resync a player's exemption status.
  - updateActivityForUser
```
void updateActivityForUser(org.spongepowered.api.entity.living.player.Player player)
```
    Forces an activity tracking update for a Player, such that Nucleus thinks that the player has recently been active and resets their AFK timer.
    
    Parameters:
    
    player - The player to update the activity of.
  - disableTrackingFor
```
@Deprecated
default AutoCloseable disableTrackingFor(org.spongepowered.api.entity.living.player.Player player)
```
    Deprecated. Use disableTrackingForPlayer(Player, int) instead.
    
    Disables activity tracking for the specified Player for the next tick. See disableTrackingFor(Player, int) for more information on how to use this method.
    
    Parameters:
    
    player - Player to disable tracking for.
    
    Returns:
    
    The AutoCloseable that will re-enable the tracking when done.
    
    See Also:
    
    disableTrackingFor(Player, int)
  - disableTrackingForPlayer
```
default NoExceptionAutoClosable disableTrackingForPlayer(org.spongepowered.api.entity.living.player.Player player)
```
    Disables activity tracking for the specified Player for the next tick. See disableTrackingFor(Player, int) for more information on how to use this method.
    
    Parameters:
    
    player - Player to disable tracking for.
    
    Returns:
    
    The AutoCloseable that will re-enable the tracking when done.
    
    See Also:
    
    disableTrackingFor(Player, int)
  - disableTrackingFor
```
@Deprecated
default AutoCloseable disableTrackingFor(org.spongepowered.api.entity.living.player.Player player,
                                                     int ticks)
```
    Deprecated. Use disableTrackingForPlayer(Player, int) instead.
    Disables activity tracking for the specified Player for up to the number of ticks specified.
    This method returns an AutoCloseable, and as such, the recommended way of using this method is using "try with resources":
```
     try (AutoClosable dummy = disableTrackingFor(player, 1)){
         // perform actions here, most likely something like:
         player.setLocation(location);

         // Any actions here will not disable the AFK timer.
     }

     // any actions here that move the player will be tracked again.
 
```
    This pattern isn't strictly required, as the AutoCloseable will close itself after the specified number of ticks. However, it's prudent to consider the following:
    - This method will reset the tracking on the main thread. This means if you use this async (though usually, you wouldn't do so), you will possibly find that the tracking will re-enable before the task finishes on the defaults. Minimise the amount of time the activity tracking must be disabled, and consider increasing the tick count slightly.
    - There is no need to increase the tick parameter on the main thread. Consider using disableTrackingFor(Player) for a sane default.
    If you do not use "try with resources", call the close method upon completion to reactivate tracking.
    Parameters:
    
    player - The Player to disable tracking for.
    
    ticks - The number of ticks to disable tracking for.
    
    Returns:
    
    The AutoCloseable that will re-enable the tracking when done.
  - disableTrackingForPlayer
```
NoExceptionAutoClosable disableTrackingForPlayer(org.spongepowered.api.entity.living.player.Player player,
                                                 int ticks)
```
    Disables activity tracking for the specified Player for up to the number of ticks specified.
    This method returns an AutoCloseable, and as such, the recommended way of using this method is using "try with resources":
```
     try (AutoClosable dummy = disableTrackingFor(player, 1)){
         // perform actions here, most likely something like:
         player.setLocation(location);

         // Any actions here will not disable the AFK timer.
     }

     // any actions here that move the player will be tracked again.
 
```
    This pattern isn't strictly required, as the AutoCloseable will close itself after the specified number of ticks. However, it's prudent to consider the following:
    - This method will reset the tracking on the main thread. This means if you use this async (though usually, you wouldn't do so), you will possibly find that the tracking will re-enable before the task finishes on the defaults. Minimise the amount of time the activity tracking must be disabled, and consider increasing the tick count slightly.
    - There is no need to increase the tick parameter on the main thread. Consider using disableTrackingFor(Player) for a sane default.
    If you do not use "try with resources", call the close method upon completion to reactivate tracking.
    Parameters:
    
    player - The Player to disable tracking for.
    
    ticks - The number of ticks to disable tracking for.
    
    Returns:
    
    The AutoCloseable that will re-enable the tracking when done.

Interface NucleusAFKService

Method Summary

Method Detail

canGoAFK

getAfk

isAFK

setAFK

canBeKicked

lastActivity

timeSinceLastActivity

timeForInactivity

timeForKick

invalidateCachedPermissions

updateActivityForUser

disableTrackingFor

disableTrackingForPlayer

disableTrackingFor

disableTrackingForPlayer