Player (Rising World Plugin API)

```
public interface Player
```
Represents a player. This only applies to players which are currently connected to the server.

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addGuiElement(GuiElement guiElement)` Attaches a GUI element to the player's hud.
`void`	`addGuiElement(GuiElement guiElement, java.lang.String parent)` Attaches a GUI element to the player's screen.
`void`	`addWorldElement(WorldElement worldElement)` Adds the provided `WorldElement` to the player's world.
`void`	`ban(java.lang.String reason)` Bans the player permanently from the server.
`void`	`ban(java.lang.String reason, int duration)` Bans the player from the server for a given amount of time.
`void`	`connectToDiscord(java.lang.String url)` Connects the client to a Discord server, or more precisely, it opens the url to the Discord server in the web browser.
`void`	`connectToTeamSpeak(java.lang.String ip, int port, java.lang.String channel)` Connects the client to a TeamSpeak server, but only as long as TeamSpeak is installed on the client computer, and only if the client accepts to connect.
`void`	`createScreenshot(float sizeFactor, Callback<java.awt.image.BufferedImage> callback)` Creates a screenshot of the player screen and convert it into a BufferedImage.
`void`	`deleteAttribute(java.lang.String key)` Removes a player attribute.
`void`	`disableAreaSelectionTool()` Disables the "area selection tool" for this player.
`void`	`disableClientsideKeys(int... keys)` Disables certain keys for the client.
`void`	`disableGameMusic()` Disables the ingame music.
`void`	`enableAreaSelectionTool()` Enables the "area selection tool" for this player.
`void`	`enableClientsideKeys()` Re-enables all keys which have been disabled by calling `disableClientsideKeys(int...)`.
`void`	`enableClientsideKeys(int... keys)` Re-enables certain keys which have been disabled by calling `disableClientsideKeys(int...)`.
`void`	`enableGameMusic()` Enables the ingame music.
`void`	`executeConsoleCommand(java.lang.String command)` Executes a console command for this player.
`java.util.List<WorldElement>`	`getAllWorldElements()`
`void`	`getAreaSelectionData(Callback<Area> callback)` Gets the currently selected area.
`int`	`getArmor()` Gets the current armor level of the player.
`java.lang.Object`	`getAttribute(java.lang.String key)` Gets the value to which the specified key is mapped, or null if no attribute is stored for that key.
`Vector3i`	`getBlockPosition()` Gets a Vector3i containing the current block position (x, y and z) of the player within the current chunk.
`java.lang.String`	`getCardinalDirection()` Returns the cardinal direction of the player.
`Vector3i`	`getChunkPosition()` Gets a Vector3i containing the x, y and z coordinates of the current chunk the player is in.
`Clothes`	`getClothes()` Gets a `Clothes` object which contains the clothes the character is currently wearing.
`java.util.List<Area>`	`getCurrentAreas()` Gets a list of all Areas the player is currently in.
`int`	`getCurrentPlayTime()` Gets the amount of time the player is connected to the server.
`int`	`getDbID()` Gets the database ID of the player.
`Item`	`getEquippedItem()` Gets the currently equipped item (i.e. the item the player currently holds in his hands), or null if no item is equipped.
`float`	`getHeading()` Returns the heading/facing, i.e. the player rotation around the y axis (vertical axis) in radians.
`int`	`getHealth()` Gets the current health of the player.
`int`	`getHunger()` Gets the current hunger level of the player. 100 means the player is not hungry, 0 means the player is starving (i.e. the player looses health).
`int`	`getID()` Gets the current ID of this player.
`int`	`getIdleTime()` Gets the player idle time in seconds.
`Inventory`	`getInventory()` Gets the inventory of the player.
`java.lang.String`	`getIP()` Gets the ip of the player (only relevant in multiplayer).
`java.lang.String`	`getLanguage()` Gets the current ingame language of the player.
`long`	`getLastTimeOnline()` Gets a timestamp (i.e. the number of milliseconds since 00:00:00 UTC on January 1, 1970) when the player was online on this server most recently.
`int`	`getMaxArmor()` Gets the maximum armor level the player can have.
`int`	`getMaxHealth()` Gets the maximum health the player can have.
`Npc`	`getMount()` Gets the mount the player is currently riding on.
`java.lang.String`	`getName()` Gets the name of the player.
`void`	`getOption(java.lang.String setting, Callback<java.lang.String> callback)` Gets a setting from the client (a setting from his config.properties file).
`java.lang.String`	`getPermissionGroup()` Gets the current permission group name of the player.
`java.lang.Object`	`getPermissionValue(java.lang.String key)` Gets a particular permission value (usually boolean, int, String) from the current player permission.
`int`	`getPing()` Gets the current ping of the player, in other words, the amount of time (in milliseconds) that passes until a player packet arrives at the server.
`Vector3f`	`getPosition()` Gets a Vector3f containing the current global x, y and z coordinate of the player.
`int[]`	`getRegisteredKeys()` Gets all keys that are registered.
`Vector3f`	`getRespawnPosition()` Gets the estimated respawn position (i.e. the position the player will respawn once he died [or once he gets respawned forcefully]).
`Quaternion`	`getRotation()` Gets the current player rotation.
`int`	`getScreenResolutionX()` Gets the current screen width (horizontal resolution) the player set for his game.
`int`	`getScreenResolutionY()` Gets the current screen height (vertical resolution) the player set for his game.
`void`	`getScreenToWorldPosition(float x, float y, boolean relativeposition, Callback<Vector3f> callback)` Performs a raycast from the screen xy position.
`Skin`	`getSkin()` Gets a `Skin` object which represents the appearance of the character, i.e. gender, haircut, skin color, hair color etc.
`int`	`getStamina()` Gets the player stamina. 0 means the player is fully exhausted (so the player cannot sprint anymore), 100 is the max value.
`java.lang.String`	`getSystemLanguage()` Gets the current system language of the player.
`int`	`getTemperature()` Gets the current player temperature (in celsius).
`int`	`getThirst()` Gets the current thirst level of the player. 100 means the player is not thirsty, 0 means the player is dying of dehydration (i.e. the player looses health).
`int`	`getTotalPlayTime()` Gets the total amount of time the player has spent on this server (or more precisely, the amount of time the player has spent on this world).
`long`	`getUID()` Gets the globally unique ID of the player.
`Vector3f`	`getViewDirection()` Gets the current view direction of the player.
`int`	`getWetness()`
`boolean`	`hasAttribute(java.lang.String key)` Gets whether or not the provided attribute exists.
`boolean`	`hasBrokenBones()` Gets whether the player has broken bones or not.
`void`	`hideInventory()`
`void`	`hideJournal()` Hides the journal.
`void`	`hideMap()` Hides the ingame map.
`void`	`hideStorage()` Hides the chest/storage content.
`boolean`	`isAdmin()` Gets wheter or not the player is an admin (according to the server.properties file).
`boolean`	`isBleeding()` Gets whether the player is bleeding or not.
`boolean`	`isConnected()` Gets whether or not the player is (still) connected.
`boolean`	`isCreativeModeEnabled()` Gets whether or not creative mode is currently enabled.
`boolean`	`isCrouching()` Gets whether or not the player is currently crouching.
`boolean`	`isDead()` Gets whether or not the player is dead.
`boolean`	`isFishing()` Gets whether or not the player is currently fishing.
`boolean`	`isFlying()` Gets whether or not the player is currently flying (i.e. flymode enabled).
`boolean`	`isInCave()` Gets whether or not the player is inside a cave.
`boolean`	`isIndoor()` Gets whether or not the player is inside a building.
`boolean`	`isInLava()` Gets whether or not the player is currently in lava.
`boolean`	`isInVehicle()` Gets whether or not the player is currently inside a vehicle (either as driver or passenger).
`boolean`	`isInvisible()` Gets whether or not the player is invisible (i.e. if a plugin has set the player invisible).
`boolean`	`isInWater()` Gets whether or not the player is currently in water.
`boolean`	`isKeyRegistered(int key)` Checks if a particular key is already registered.
`boolean`	`isLaying()` Gets whether or not the player is currently laying in a bed, tent or shelter.
`boolean`	`isListeningForKeyInput()` Determines if the client does forward his key input to the server or not.
`boolean`	`isListeningForObjectInteractions()` Deprecated. Method is no longer used. Now interactions of players with objects (like furniture) are always forwarded to the server (and they are also cancellable), so this method returns always true
`boolean`	`isPlayingPiano()` Gets whether or not the player is currently playing a piano.
`boolean`	`isSitting()` Gets whether or not the player is currently sitting on a chair.
`boolean`	`isSleeping()` Gets whether or not this player is currently sleeping.
`boolean`	`isSpawned()` Gets whether or not the player is already spawned, i.e. if he's no longer in the loading screen.
`boolean`	`isSprinting()`
`boolean`	`isSteamVersion()` Gets whether or not the player uses the Steam version of the game.
`boolean`	`isUnderWater()` Gets whether or not the player is currently under water.
`boolean`	`isWalking()`
`void`	`kick(java.lang.String reason)` Kicks the player from the server.
`void`	`kill()` Kills the player instantly.
`void`	`moveTo(float x, float y, float z, float speed)` Moves the player (smoothly) to the target position.
`void`	`moveTo(Vector3f position, float speed)` Moves the player (smoothly) to the target position.
`int`	`playGameSound(java.lang.String name)` Plays an ingame sound effect at the position of the player which can only be heard by this player.
`int`	`playGameSound(java.lang.String name, Vector3f position)` Plays an ingame sound effect at the given world position which can only be heard by this player.
`int`	`playGameSound(java.lang.String name, Vector3f position, java.lang.String parameter, float parameterValue)` Plays an ingame sound effect at the given world position.
`int`	`playSound(SoundInformation sound)` Plays a custom 2D sound (i.e. it can be heard everywhere, but only by this player).
`int`	`playSound(SoundInformation sound, boolean loop, float volume, float pitch, float minDistance, float maxDistance, Vector3f position)` Plays a custom 3D sound at the given position.
`int`	`playSound(SoundInformation sound, Vector3f position)` Plays a custom 3D sound at the given position.
`void`	`raycast(int collisionType, Callback<RayCastResult> callback)` Performs a raycast from the player view position to the player view direction, i.e. from the cam position to the center of the screen (crosshair).
`void`	`raycast(Vector3f direction, int collisionType, Callback<RayCastResult> callback)` Performs a raycast from the player view position to the provided direction.
`void`	`raycastFromScreenPosition(float x, float y, boolean relativeposition, int collisionType, Callback<RayCastResult> callback)` Performs a raycast from the screen xy position.
`void`	`raycastFromWorldPosition(Vector3f position, Vector3f direction, int collisionType, Callback<RayCastResult> callback)` Performs a raycast from a world position.
`void`	`registerKeys(int... keys)` Defines the key inputs the client should forward to the server.
`void`	`removeAllGuiElements()` Removes all GUI elements that are attached to the player's hud.
`void`	`removeAllWorldElements()` Removes all `WorldElements` from the player's world.
`void`	`removeGuiElement(GuiElement guiElement)` Removes a GUI element from the player's hud.
`void`	`removeWorldElement(WorldElement worldElement)` Removes a `WorldElement` from the player's world.
`void`	`requestMapTileRaw(int x, int y, java.lang.String controlHash, Callback<byte[]> callback)` Requests a raw map tile from a client.
`void`	`respawn()` Respawns the player.
`void`	`respawn(Vector3f position, Quaternion rotation)` Respawns the player at the given position.
`void`	`sendTextMessage(java.lang.String message)` Sends a text message to the player's chat.
`void`	`sendYellMessage(java.lang.String message)` Displays a message with big letters in the middle of the screen of the player for a few seconds (depending on the length of the message).
`void`	`setAdmin(boolean set)` Gives admin rights to the player.
`void`	`setAreaSelectionData(Area area)` Sets an area for the "area selection tool" for this player, i.e. the selection tool will adapt to the position and size of the provided area.
`void`	`setAttribute(java.lang.String key, java.lang.Object value)` Stores an attribute for the player.
`void`	`setBleeding(boolean set)` Sets the bleeding state of the player.
`void`	`setBrokenBones(boolean set)` Sets the broken bone state of the player.
`void`	`setChunkAndBlockPosition(int cx, int cy, int cz, int bx, int by, int bz)` Sets the chunk and block position of the player (resulting in the total global position).
`void`	`setChunkAndBlockPosition(Vector3i chunkPosition, Vector3i blockPosition)` Sets the chunk and block position of the player (resulting in the total global position).
`void`	`setCreativeModeEnabled(boolean set)` Enables or disables creative mode for this player.
`void`	`setEquippedItem(int quickslot)` Changes the equipped item (i.e. the item the player currently holds in his hands).
`void`	`setFlying(boolean set)` Sets the flymode for the player.
`void`	`setGravity(float gravity)`
`void`	`setGuiElementVisible(GuiElement element, boolean visible)` Changes the visibility of the GUI element only for this player.
`void`	`setHealth(int health)` Sets the health of the player.
`void`	`setHunger(int hunger)` Sets the hunger level of the player. 100 means the player is not hungry, 0 means the player is starving (i.e. the player looses health).
`void`	`setInvisible(boolean set)` Sets the player invisible.
`void`	`setJumpSpeed(float jumpheight)` Sets the jump height for the player.
`void`	`setListenForKeyInput(boolean set)` Sets if the client should forward his key input to the server or not.
`void`	`setListenForObjectInteractions(boolean set)` Deprecated. Method is no longer used. Now interactions of players with objects (like furniture) are always forwarded to the server (and they are also cancellable). Calling this method has no effect.
`void`	`setMouseCursorCoordinates(float x, float y, boolean relative)` Moves the mouse cursor of the client to the specified xy coordinates.
`void`	`setMouseCursorVisible(boolean set)` Toggles the visibility of the mouse cursor.
`void`	`setName(java.lang.String name)` Changes the name of the player.
`void`	`setOption(java.lang.String setting, java.lang.Object value)` Sets the graphics/audio/game settings for the client.
`void`	`setPermissionGroup(java.lang.String groupName)` Sets the permission group of the player.
`void`	`setPermissionValue(java.lang.String key, java.lang.Object value)` Overrides a permission value.
`void`	`setPosition(float x, float y, float z)` Sets the global position of the player.
`void`	`setPosition(Vector3f position)` Sets the global position of the player.
`void`	`setRotation(float pitch, float yaw, float roll)` Sets the player rotation from euler angles.
`void`	`setRotation(Quaternion quaternion)` Sets the player rotation.
`void`	`setRunSpeed(float speed)` Sets the running speed for the player, i.e. the default movement speed.
`void`	`setSoundPitch(int soundID, float pitch)` Changes the pitch of a sound instance.
`void`	`setSoundPosition(int soundID, Vector3f position)` Changes the position of a sound.
`void`	`setSoundTimelinePosition(int soundID, float position, boolean relative)` Changes the track position / timeline position of the sound.
`void`	`setSoundVolume(int soundID, float volume)` Changes the volume of a sound instance.
`void`	`setSprintSpeed(float speed)` Sets the sprinting speed for the player, i.e. fast movement.
`void`	`setTemperature(int temperature)` Sets the player temperature (in celsius).
`void`	`setThirst(int thirst)` Sets the thirst level of the player. 100 means the player is not thirsty, 0 means the player is dying of dehydration (i.e. the player looses health).
`void`	`setViewDirection(float directionx, float directiony, float directionz)` Sets the view direction of the player.
`void`	`setViewDirection(Vector3f direction)` Sets the view direction of the player.
`void`	`setWalkSpeed(float speed)` Sets the walking speed for the player.
`void`	`setWetness(int wetness)`
`void`	`shake(float intensity, float duration)` Shakes the player screen, like an earthquake.
`void`	`showContextMenu(java.lang.String[] entries, Callback<java.lang.String> callback)` Shows a context menu with the given entries.
`void`	`showInventory()`
`void`	`showJournal()` Shows the journal.
`void`	`showMap(boolean ignoreMissingMapItem)` Brings up the ingame map.
`void`	`showMap(boolean ignoreMissingMapItem, Vector3f coordinates, boolean smoothScroll)` Brings up the ingame map.
`void`	`showStatusMessage(java.lang.String message, int duration)` Shows a status text message (centered, bottom of the screen).
`void`	`showStorage(int storageID)` Shows the content of a chest/storage.
`void`	`stopInput(boolean stopMovement, boolean stopActions)` Stops / aborts the current input actions.
`void`	`stopSound(int soundID)` Stops a sound effect.
`void`	`unregisterKeys(int... keys)` Unregisters a key (or multiple keys), so the client no longer forwards the input to the server.

Method Detail

getID
```
int getID()
```
Gets the current ID of this player. This ID will change the next time the player joins the server (or if the player leaves the server, another player might get this ID).

Returns:

the current player ID.

getUID

long getUID()

Gets the globally unique ID of the player. This ID will never change, even if the player joins another server. For Steam users, this method returns the SteamID64.

Returns:

the globally unique player ID as a 64 bit (long) value.

Example #1: Display the UID of the player

1	//the UID is a 64 bit number, so we have to use a long
2	long playerUID = player.getUID();
3
4	//check if player uses Steam, then the UID is his SteamID64
5	if(player.isSteamVersion()){
6	player.sendTextMessage("Your SteamID is " + playerUID);
7	}
8	//otherwise it's his standalone UID
9	else{
10	player.sendTextMessage("Your ID is " + playerUID);
11	}

Example #2: Check if player uses Steam and get a link to his profile

1	//check if player uses Steam
2	if(player.isSteamVersion()){
3	//get player UID (for Steam users, it's the SteamID64)
4	long uid = player.getUID();
5
6	//this is the url to his Steam profile:
7	String url = "http://steamcommunity.com/profiles/" + uid;
8	}

getDbID
```
int getDbID()
```
Gets the database ID of the player. This ID is only unique on the current world. If the player joins another server (or loads another world), he will get a different database ID.
The database ID is useful for database queries.

Returns:

the player database ID.

getName
```
java.lang.String getName()
```
Gets the name of the player.

Returns:

the player name.

setName
```
void setName(java.lang.String name)
```
Changes the name of the player.

Parameters:

name - the new player name.

getLastTimeOnline
```
long getLastTimeOnline()
```
Gets a timestamp (i.e. the number of milliseconds since 00:00:00 UTC on January 1, 1970) when the player was online on this server most recently.

Returns:

a timestamp (milliseconds).

getCurrentPlayTime
```
int getCurrentPlayTime()
```
Gets the amount of time the player is connected to the server.

Returns:

the current play time.

getTotalPlayTime
```
int getTotalPlayTime()
```
Gets the total amount of time the player has spent on this server (or more precisely, the amount of time the player has spent on this world).

Returns:

the total play time of this player (in seconds).

getPermissionGroup
```
java.lang.String getPermissionGroup()
```
Gets the current permission group name of the player.

Returns:

the player permission group name or null if no group is set.

setPermissionGroup
```
void setPermissionGroup(java.lang.String groupName)
```
Sets the permission group of the player.

Parameters:

groupName - the group name. Set null to remove the player from any permission group.

getPermissionValue

java.lang.Object getPermissionValue(java.lang.String key)

Gets a particular permission value (usually boolean, int, String) from the current player permission.

Parameters:

key - the name of the particular permission key.

Returns:

the permission value which belongs to the provided key, or null if the permission key does not exist.

Example: Check if the General->Keepinventory permission is set to true

1	Player player = getServer().getPlayer("R2D2");
2	boolean keepinv = (boolean)player.getPermissionValue("general_keepinventory");
3	if(keepinv) System.out.println("Player keeps inventory after death");
4	else System.out.println("Player loses inventory upon death");

setPermissionValue
```
void setPermissionValue(java.lang.String key,
                        java.lang.Object value)
```
Overrides a permission value. This does not change the permission group of the player, but grants him individual permissions.

Note that these changes are not permanent, i.e. if the player reconnects or if the player gets assigned to another permission group ("setplayergroup"), these changes will be reverted.

Parameters:

key - the permission key.

value - the value.

Example #1: Disable fly mode, irrespective of the actual permission group
1 Player player = getServer().getPlayer("C3PO");
2 player.setPermissionValue("general_fly", false);
Example #2: Increase the max amount of uploadable custom images to 20
1 Player player = getServer().getPlayer("Luke");
2 player.setPermissionValue("customimages_maxupload", 20);

isAdmin
```
boolean isAdmin()
```
Gets wheter or not the player is an admin (according to the server.properties file).

Returns:

true if the player is an admin, false if not.

setAdmin
```
void setAdmin(boolean set)
```
Gives admin rights to the player.

Parameters:

set - set true to give admin rights to the player, or false to revoke admin rights.

getInventory
```
Inventory getInventory()
```
Gets the inventory of the player.

Returns:

the inventory of the player.

getEquippedItem
```
Item getEquippedItem()
```
Gets the currently equipped item (i.e. the item the player currently holds in his hands), or null if no item is equipped.

Returns:

the equipped item, or null if no item is equipped.

setEquippedItem
```
void setEquippedItem(int quickslot)
```
Changes the equipped item (i.e. the item the player currently holds in his hands).

Parameters:

quickslot - the quickslot focus (hotbar) which holds the desired item.

sendTextMessage
```
void sendTextMessage(java.lang.String message)
```
Sends a text message to the player's chat. You can use color codes ([#RRGGBB], RR is the hex red color, GG the hex green color, BB the hex blue color) in the string to color a specific part of the text (or the whole text).

Parameters:

message - the message you want to send to the player.

Example #1: Send a regular text message
1 player.sendTextMessage("Your name is " + player.getName());
Example #2: Send a red text message
1 //Hex red color (RGB) is #FF0000
2 player.sendTextMessage("[#FF0000]This is a red text");
Example #3: Send a multicolor text message
1 //Hex red color is #FF0000, hex green color is #00FF00, hex blue color is #0000FF
2 player.sendTextMessage("[#FF0000]This part is red, [#00FF00]This part is green, [#0000FF]This part is blue");

sendYellMessage
```
void sendYellMessage(java.lang.String message)
```
Displays a message with big letters in the middle of the screen of the player for a few seconds (depending on the length of the message).

Parameters:

message - the message you want to display on the player's screen.

Example:
1 player.sendYellMessage("Server will shutdown in 5 minutes");

showStatusMessage
```
void showStatusMessage(java.lang.String message,
                       int duration)
```
Shows a status text message (centered, bottom of the screen). Status messages are used by the game to display certain information to the player, e.g. status of object placement, food consume info etc.

Parameters:

message - the message you want to show.

duration - the duration (seconds) how long the message will be displayed.

setOption
```
void setOption(java.lang.String setting,
               java.lang.Object value)
```
Sets the graphics/audio/game settings for the client. This only works for settings which are also accessible from the options menu.

Parameters:

setting - the name of the setting (see config.properties file).

value - the new value. Set null to reset this setting to default.

Example:
1 //Enable refractions
2 player.setSetting("graphic_refractions", true);

getOption

void getOption(java.lang.String setting,
               Callback<java.lang.String> callback)

Gets a setting from the client (a setting from his config.properties file). The returned setting is always a string, so you have to parse it accordingly. If the setting is not set (i.e. field in the config.properties file is blank), an empty string is returned. If the setting does not exist, null is returned.
Since the data is queried from the client, you do not get the result as a return value, instead you have to use a callback to receive the result.

Parameters:

setting - the setting you want to query, e.g. "input_interaction" or "graphic_fullscreen" etc.

callback - the Callback object. It will be called once the data has been retrieved from the player. The result will be passed as a string argument (empty string if setting is not set, null if setting does not exist).

Example #1: Check if player has the debug console enabled

1	player.getOption("game_debug_console", (String result) -> {
2	//The result is always a string, so we either have to parse it, or check the value directly
3	if(result.equalsIgnoreCase("true")){
4	System.out.println("Debug console is active!");
5	}
6	});

Example #2: Get player key mapping for inventory key, and use it for your own purposes (e.g. inventory extension)

1	player.getOption("input_inventory", (String s) -> {
2	//We have to convert the string to an integer key value,
3	//fortunately the "KeyInput" class has a static helper function for that
4	int key = KeyInput.fromString(s);
5
6	//Register the key for the player, so a "PlayerKeyEvent" event is
7	//triggered when the player presses his inventory key
8	player.registerKeys(key);
9	});

setAttribute
```
void setAttribute(java.lang.String key,
                  java.lang.Object value)
```
Stores an attribute for the player. You can store any type of object. Note that all attributes will be reset upon server restart.

Parameters:

key - the name of the attribute.

value - the value/object you want to store. Set null to remove the attribute.

getAttribute

java.lang.Object getAttribute(java.lang.String key)

Gets the value to which the specified key is mapped, or null if no attribute is stored for that key.

Parameters:

key - the name of the attribute.

Returns:

the attribute that is stored for that key, or null of the key does not exists.

Example:

1	String job = "Farmer";
2	player.setAttribute("Job", job);
3
4	//... somewhere else in your code ...
5
6	if(player.hasAttribute("Job")){
7	//Type-casting is necessary, since only an "Object" is returned
8	String playerJob = (String) player.getAttribute("Job");
9	}

hasAttribute
```
boolean hasAttribute(java.lang.String key)
```
Gets whether or not the provided attribute exists.

Parameters:

key - the name of the attribute.

Returns:

true if the attribute exists, false if not.

deleteAttribute
```
void deleteAttribute(java.lang.String key)
```
Removes a player attribute. Does nothing if the attribute doesn't exist.

Parameters:

key - the name of the attribute you want to delete.

getPosition
```
Vector3f getPosition()
```
Gets a Vector3f containing the current global x, y and z coordinate of the player.

Returns:

the global player position as a Vector3f (float).

setPosition
```
void setPosition(Vector3f position)
```
Sets the global position of the player.

Parameters:

position - A Vector3f (float) containing the global target position.

setPosition
```
void setPosition(float x,
                 float y,
                 float z)
```
Sets the global position of the player.

Parameters:

x - global x coordinate to set (horizontally).

y - global y coordinate to set (vertically).

z - global z coordinate to set (horizontally).

moveTo
```
void moveTo(Vector3f position,
            float speed)
```
Moves the player (smoothly) to the target position.

Parameters:

position - the target position.

speed - the speed (how long it should take to move the player to the target position).

moveTo
```
void moveTo(float x,
            float y,
            float z,
            float speed)
```
Moves the player (smoothly) to the target position.

Parameters:

x - the target x coordinate.

y - the target y coordinate.

z - the target z coordinate.

speed - the speed (how long it should take to move the player to the target position).

getChunkPosition
```
Vector3i getChunkPosition()
```
Gets a Vector3i containing the x, y and z coordinates of the current chunk the player is in.

Returns:

the chunk offset as a Vector3i (int).

getBlockPosition
```
Vector3i getBlockPosition()
```
Gets a Vector3i containing the current block position (x, y and z) of the player within the current chunk. X ranges from 0-15 (inclusive), Y ranges from 0-63 (inclusive), Z ranges from 0-15 (inclusive).

Returns:

the block position within the current chunk as a Vector3i (int).

setChunkAndBlockPosition
```
void setChunkAndBlockPosition(Vector3i chunkPosition,
                              Vector3i blockPosition)
```
Sets the chunk and block position of the player (resulting in the total global position).

Parameters:

chunkPosition - chunk offset as a Vector3i (int).

blockPosition - block position within the chunk as a Vector3i (int).

setChunkAndBlockPosition
```
void setChunkAndBlockPosition(int cx,
                              int cy,
                              int cz,
                              int bx,
                              int by,
                              int bz)
```
Sets the chunk and block position of the player (resulting in the total global position).

Parameters:

cx - x chunk offset.

cy - y chunk offset.

cz - z chunk offset.

bx - x block position within the chunk.

by - y block position within the chunk.

bz - z block position within the chunk.

getRotation
```
Quaternion getRotation()
```
Gets the current player rotation.

Returns:

the player rotation as a Quaternion.

setRotation
```
void setRotation(Quaternion quaternion)
```
Sets the player rotation.

Parameters:

quaternion - the quaternion which describes the desired rotation.

setRotation
```
void setRotation(float pitch,
                 float yaw,
                 float roll)
```
Sets the player rotation from euler angles.

Parameters:

pitch - the rotation around the x axis (left axis).

yaw - the rotation around the y axis (vertical/up axis), "heading".

roll - the rotation around the z axis (forward axis)

getViewDirection
```
Vector3f getViewDirection()
```
Gets the current view direction of the player.

Returns:

the view direction as a Vector3f (float).

setViewDirection

void setViewDirection(Vector3f direction)

Sets the view direction of the player. You can use this function to force the player to look into a certain direction.

Parameters:

direction - the new view direction as a Vector3f (float). Make sure to use a unit vector.

Example: How to let the player look to a certain point in the world

1	//Just a random point
2	Vector3f targetPoint = new Vector3f(10.0f, 50.0f, 20.0f);
3	//Get player position
4	Vector3f playerPos = player.getPosition();
5
6	//Vector math: target - startpoint = direction
7	targetPoint.subtractLocal(playerPos);
8
9	//Convert to unit vector (normalize), important for directions
10	targetPoint.normalizeLocal();
11
12	//"targetPoint" is the direction vector now
13	player.setViewDirection(targetPoint);

setViewDirection
```
void setViewDirection(float directionx,
                      float directiony,
                      float directionz)
```
Sets the view direction of the player. You can use this function to force the player to look into a certain direction.

Parameters:

directionx - y component of the new view direction vector.

directiony - y component of the new view direction vector.

directionz - z component of the new view direction vector.

getHeading
```
float getHeading()
```
Returns the heading/facing, i.e. the player rotation around the y axis (vertical axis) in radians. If the player looks exactly to north, 0 will be returned, if he looks to south, PI (180 degree) will be returned.

Returns:

the player heading/facing, i.e. the rotation around the y axis.

getCardinalDirection
```
java.lang.String getCardinalDirection()
```
Returns the cardinal direction of the player. If the player faces towards north, this function returns "N", if he faces towards east, it returns "E", if he faces towards north-east, it returns "NE" etc.

Returns:

the cardinal direction. Returns either "N", "NE", "E", "SE", "S", "SW", "W" or "NW"

getCurrentAreas
```
java.util.List<Area> getCurrentAreas()
```
Gets a list of all Areas the player is currently in. Do not modify this list!

Returns:

a list of all Areas the player is inside. Never null.

See Also:

Area, PlayerEnterAreaEvent, PlayerLeaveAreaEvent

Example: Check all areas the player is currently inside
1 List<Area> areas = player.getCurrentAreas();
2 for(Area area : areas){
3 //do something with the "area"
4 }

shake
```
void shake(float intensity,
           float duration)
```
Shakes the player screen, like an earthquake.

Parameters:

intensity - the intensity (default: 1.0f)

duration - the duration, in seconds.

Example: Simulate an earthquake for 10 seconds
1 //Intensity 1 (just try out some values)
2 player.shake(1.0f, 10.0f);

isSpawned
```
boolean isSpawned()
```
Gets whether or not the player is already spawned, i.e. if he's no longer in the loading screen.

Returns:

true if the player is fully spawned, false if he is still in the loading screen (loading the world or connecting to the server).

isFishing
```
boolean isFishing()
```
Gets whether or not the player is currently fishing.

Returns:

true if the player is fishing, false if not.

isInVehicle
```
boolean isInVehicle()
```
Gets whether or not the player is currently inside a vehicle (either as driver or passenger).

Returns:

true if the player is in a vehicle (e.g. boat, car, train etc), false if not.

isSprinting
```
boolean isSprinting()
```

isWalking
```
boolean isWalking()
```

isCrouching
```
boolean isCrouching()
```
Gets whether or not the player is currently crouching.

Returns:

true if the player is crouching, false if not.

isLaying
```
boolean isLaying()
```
Gets whether or not the player is currently laying in a bed, tent or shelter.

Returns:

true if the player is laying in a bed (or tent or shelter), false if not.

isSitting
```
boolean isSitting()
```
Gets whether or not the player is currently sitting on a chair.

Returns:

true if the player is sitting on a chair, false if not.

isPlayingPiano
```
boolean isPlayingPiano()
```
Gets whether or not the player is currently playing a piano.

Returns:

true if the player is currently playing a piano, false if not.

isInWater
```
boolean isInWater()
```
Gets whether or not the player is currently in water.

Returns:

true if the player is in water, false if not.

isUnderWater
```
boolean isUnderWater()
```
Gets whether or not the player is currently under water.

Returns:

true if the player is under water, false if not.

isInLava
```
boolean isInLava()
```
Gets whether or not the player is currently in lava.

Returns:

true if the player is in lava, false if not.

isIndoor
```
boolean isIndoor()
```
Gets whether or not the player is inside a building.

Returns:

true if the player is inside a building, false if not.

isInCave
```
boolean isInCave()
```
Gets whether or not the player is inside a cave. Note: If the player is inside a building in a cave, this function returns false.

Returns:

true if the player is currently inside a cave.

isSleeping

boolean isSleeping()

Gets whether or not this player is currently sleeping.

Returns:

true if the player is currently sleeping, false if not.

Example: Jump to next day if at least 50% of all players are sleeping

1	Server server = getServer();
2
3	//Create the timer
4	Timer sleepCheck = new Timer(5, 5, -1, () -> {
5	//We only proceed if the current time is between 10 p.m. (22) and 8 a.m. (8)
6	Time time = server.getGameTime();
7	if(time.getHours() >= 22 \|\| time.getHours() < 8){
8	//Calculate the threshold (50 percent of current player count)
9	int playerThreshold = server.getPlayerCount() / 2;
10
11	//Now we iterate through all players, check if they're sleeping, and
12	//increment a "sleeper" variable accordingly
13	int sleeper = 0;
14	for(Player p : server.getAllPlayers()){
15	if(p.isSleeping()) sleeper++;
16	}
17
18	//If the amount of sleeping players is greater or equal to our
19	//threshold, we will skip the night
20	if(sleeper >= playerThreshold){
21	//Set time to 8 a.m.
22	server.setGameTime(8, 0);
23
24	//Now we "force" all players to wake up by teleporting them to
25	//their position (this automatically resets the sleeping state).
26	//Since there is no "wake up" method, we have to use this "workaround"
27	for(Player p : server.getAllPlayers()){
28	//Only teleport the player if he was sleeping
29	if(p.isSleeping()){
30	p.setPosition(p.getPosition());
31	}
32	}
33	}
34	}
35	});
36
37	//Never forget to start the timer ;)
38	sleepCheck.start();

setCreativeModeEnabled
```
void setCreativeModeEnabled(boolean set)
```
Enables or disables creative mode for this player.

Parameters:

set - set true to enable creative mode, false to disable it.

isCreativeModeEnabled
```
boolean isCreativeModeEnabled()
```
Gets whether or not creative mode is currently enabled.

Returns:

true if creative mode is currently active, false if not.

getHealth
```
int getHealth()
```
Gets the current health of the player.

Returns:

the current health of the player.

getMaxHealth
```
int getMaxHealth()
```
Gets the maximum health the player can have.

Returns:

the maximum possible player health (usually 100).

setHealth
```
void setHealth(int health)
```
Sets the health of the player.

Parameters:

health - the new player health.

getArmor
```
int getArmor()
```
Gets the current armor level of the player.

Returns:

the current armor level of the player. Returns 0 if the player has no protection.

getMaxArmor
```
int getMaxArmor()
```
Gets the maximum armor level the player can have.

Returns:

the maximum possible armor level of the player.

getHunger
```
int getHunger()
```
Gets the current hunger level of the player. 100 means the player is not hungry, 0 means the player is starving (i.e. the player looses health).

Returns:

the current hunger level of the player.

Example: Automatically reset hunger of the player if it is below a certain value
1 if(player.getHunger() < 10){
2 player.setHunger(100);
3 }

setHunger
```
void setHunger(int hunger)
```
Sets the hunger level of the player. 100 means the player is not hungry, 0 means the player is starving (i.e. the player looses health).

Parameters:

hunger - the new hunger level (0-100).

getThirst
```
int getThirst()
```
Gets the current thirst level of the player. 100 means the player is not thirsty, 0 means the player is dying of dehydration (i.e. the player looses health).

Returns:

the current thirst level of the player (0-100).

Example: Automatically reset thirst of the player if it is below a certain value
1 if(player.getThirst() < 10){
2 player.setThirst(100);
3 }

setThirst
```
void setThirst(int thirst)
```
Sets the thirst level of the player. 100 means the player is not thirsty, 0 means the player is dying of dehydration (i.e. the player looses health).

Parameters:

thirst - the new thirst level.

hasBrokenBones
```
boolean hasBrokenBones()
```
Gets whether the player has broken bones or not.

Returns:

true if the player has broken bones, false if not.

Example: Heal broken bones if necessary
1 if(player.hasBrokenBones()){
2 player.setBrokenBones(false);
3 }

setBrokenBones
```
void setBrokenBones(boolean set)
```
Sets the broken bone state of the player.

Parameters:

set - set true to break the bones of the player, or false to heal the broken bones.

isBleeding
```
boolean isBleeding()
```
Gets whether the player is bleeding or not.

Returns:

true if the player is bleeding, false if not.

setBleeding
```
void setBleeding(boolean set)
```
Sets the bleeding state of the player.

Parameters:

set - set true if the player should be bleeding, or false to stop bleeding.

getStamina

int getStamina()

Gets the player stamina. 0 means the player is fully exhausted (so the player cannot sprint anymore), 100 is the max value.

Returns:

the player stamina (0-100).

Example: If player is exhausted, he cannot execute a certain command anymore

1	`@`EventMethod
2	public void onPlayerCommand(PlayerCommandEvent event){
3	Player player = event.getPlayer();
4
5	//Split the command
6	String[] cmd = event.getCommand().split(" ");
7
8	//Just an example command...
9	if(cmd[0].equals("/teleport")){
10	//Check player stamina, if < 10, abort
11	if(player.getStamina() < 10){
12	player.sendTextMessage("You are too exhausted to use this command! Take a rest!");
13	return;
14	}
15
16	//Otherwise execute the command
17	//...
18	}
19	}

getWetness
```
int getWetness()
```

setWetness
```
void setWetness(int wetness)
```

isFlying
```
boolean isFlying()
```
Gets whether or not the player is currently flying (i.e. flymode enabled).

Returns:

true if the player is currently flying, false if not.

setFlying
```
void setFlying(boolean set)
```
Sets the flymode for the player.

Parameters:

set - true to enable flymode, false if not (be careful when the player is currently in mid-air :D)

isDead
```
boolean isDead()
```
Gets whether or not the player is dead.

Returns:

true if the player is dead, false if not.

kill
```
void kill()
```
Kills the player instantly.

respawn
```
void respawn()
```
Respawns the player.

respawn
```
void respawn(Vector3f position,
             Quaternion rotation)
```
Respawns the player at the given position.

Parameters:

position - the respawn position. You can get the default player spawn

rotation - the respawn rotation. Use "null" if you want to use the default rotation.

getRespawnPosition
```
Vector3f getRespawnPosition()
```
Gets the estimated respawn position (i.e. the position the player will respawn once he died [or once he gets respawned forcefully]).

Returns:

the estimated respawn position as a Vector3f

getTemperature
```
int getTemperature()
```
Gets the current player temperature (in celsius). Note that this is not exactly the body temperature, instead this temperature value slowly adapts to the environment temperature (depending on various factors, e.g. clothing, weather etc).

Returns:

the current player temperature (in celsius).

setTemperature
```
void setTemperature(int temperature)
```
Sets the player temperature (in celsius). Please note that the player temperature will still slowly adapt the environment temperature.

Parameters:

temperature - the player temperature (in celsius). Value must be between -100 and 100 (inclusive).

isInvisible
```
boolean isInvisible()
```
Gets whether or not the player is invisible (i.e. if a plugin has set the player invisible).

Returns:

true if the player is invisible, false if not.

setInvisible
```
void setInvisible(boolean set)
```
Sets the player invisible.

Parameters:

set - true to set the player invisible, false to make him visible again.

getIdleTime
```
int getIdleTime()
```
Gets the player idle time in seconds.

Returns:

the player idle time in seconds.

getMount

Npc getMount()

Gets the mount the player is currently riding on. If the player is not riding on an npc at the moment, this function returns null.

Returns:

the mount the player is currently riding on, or null if the player is not riding on any mounts.

See Also:

Npc.getRider()

Example: Check if player is riding on a mount

1	//Get the mount (may be null)
2	Npc mount = player.getMount();
3
4	//Check if the player is actually riding on a mount
5	if(mount != null){
6	player.sendTextMessage("You're currently riding on a '" + npc.getName() + "' !");
7	}

getLanguage
```
java.lang.String getLanguage()
```
Gets the current ingame language of the player.

Returns:

the language as a string.

getSystemLanguage
```
java.lang.String getSystemLanguage()
```
Gets the current system language of the player.

Returns:

the language as a string.

isSteamVersion
```
boolean isSteamVersion()
```
Gets whether or not the player uses the Steam version of the game.

Returns:

true if the player uses the Steam version, false if he uses the Standalone version.

setWalkSpeed
```
void setWalkSpeed(float speed)
```
Sets the walking speed for the player. Default is 1.0

Parameters:

speed - the new walking speed.

setRunSpeed
```
void setRunSpeed(float speed)
```
Sets the running speed for the player, i.e. the default movement speed. Default is 1.0

Parameters:

speed - the new running speed.

setSprintSpeed
```
void setSprintSpeed(float speed)
```
Sets the sprinting speed for the player, i.e. fast movement. Default is 1.0

Parameters:

speed - the new sprinting speed.

setJumpSpeed
```
void setJumpSpeed(float jumpheight)
```
Sets the jump height for the player. Default is 1.0

Parameters:

jumpheight - the new jump height.

setGravity
```
void setGravity(float gravity)
```

getSkin

Skin getSkin()

Gets a Skin object which represents the appearance of the character, i.e. gender, haircut, skin color, hair color etc.

Returns:

a Skin object representing the visual appearance of the character.

Example #1: Set red skin color for player once he connects to the server

1	`@`EventMethod
2	public void onPlayerConnect(PlayerConnectEvent event){
3	Player player = event.getPlayer();
4
5	//Retrieve the skin object of the player
6	Skin skin = player.getSkin();
7
8	//Now set a red skin color (0xff0000), the skin gets updated automatically
9	skin.setSkinColor(0xff0000);
10	}

Example #2: Check gender of a player

1	//Get skin object of the player
2	Skin skin = player.getSkin();
3
4	//Check gender
5	if(skin.getGender() == Skin.Gender.Female){
6	//Player is female
7	}
8	else{
9	//Player isn't female, so it's male
10	}

getClothes

Clothes getClothes()

Gets a Clothes object which contains the clothes the character is currently wearing. The object is updated automatically when the player changes his clothes.

Returns:

a Clothes object representing the clothes of the character.

Example #1: Remove all player clothes

1	Clothes clothes = player.getClothes();
2	clothes.removeAll();

Example #2: Force player to wear an ushanka (headgear)

1	Clothes clothes = player.getClothes();
2
3	//Get ClothingDef of "ushanka"
4	Definitions.ClothingDefinition def = Definitions.getClothingDefinition("ushanka");
5
6	//Add ushanka to player clothes
7	clothes.add(def.getID());

showMap
```
void showMap(boolean ignoreMissingMapItem)
```
Brings up the ingame map. Usually this requires a map item to be present in the player equipment slots, however, this can be optionally ignored. If the ingame map is already visible, nothing happens.

Parameters:

ignoreMissingMapItem - true if the map should show up independent of whether or not a map item exists in the player equipment slots, false if it should only show up if the player actually has a map item.

See Also:

showMap(boolean, net.risingworld.api.utils.Vector3f, boolean), hideMap()

showMap

void showMap(boolean ignoreMissingMapItem,
             Vector3f coordinates,
             boolean smoothScroll)

Brings up the ingame map. Usually this requires a map item to be present in the player equipment slots, however, this can be optionally ignored. If the ingame map is already visible, only the coordinates get updated (or more precisely, the position the map shows).

Parameters:

ignoreMissingMapItem - true if the map should show up independent of whether or not a map item exists in the player equipment slots, false if it should only show up if the player actually has a map item.

coordinates - the map will scroll to this position automatically. Set null to scroll the map to the current player position.

smoothScroll - true to scroll the map smoothly to the target coordinates, false to update the map position instantly.

See Also:

showMap(boolean), hideMap()

Example: Show the map and move it to the position of another player

1	//get a player (a player we want to get the position from)
2	Player targetPlayer = getServer().getPlayer("UnknownPlayer");
3
4	//if target player really exists, get his position
5	if(targetPlayer != null){
6	Vector3f position = targetPlayer.getPosition();
7
8	//show map and move it to the target player position
9	player.showMap(true, position, false);
10	}

hideMap
```
void hideMap()
```
Hides the ingame map. If the map isn't visible at the moment, nothing happens.

See Also:

showMap(boolean), showMap(boolean, net.risingworld.api.utils.Vector3f, boolean)

showJournal
```
void showJournal()
```
Shows the journal.

hideJournal
```
void hideJournal()
```
Hides the journal. If the journal isn't visible at the moment, nothing happens.

showInventory
```
void showInventory()
```

hideInventory
```
void hideInventory()
```

showStorage
```
void showStorage(int storageID)
```
Shows the content of a chest/storage.

Parameters:

storageID - the storage ID

hideStorage
```
void hideStorage()
```
Hides the chest/storage content.

showContextMenu

void showContextMenu(java.lang.String[] entries,
                     Callback<java.lang.String> callback)

Shows a context menu with the given entries. Once the player selects an entry, the provided callback will be called (and the selected string will be passed as argument).

Parameters:

entries - the entries of the context menu, as a string array.

callback - the callback which will be called once the player selects an entry. The selected entry is provided as parameter (never null). If the player just closes the context menu (i.e. if he doesn't select anything), an empty string will be provided.

Example #1:

1	//Set up the entries for the context menu
2	String[] entries = new String[]{"Spawn NPC", "Spawn Vehicle", "Spawn Item"};
3
4	//Show the context menu and set up a callback to handle the player selection
5	player.showContextMenu(entries, (String entry) -> {
6	//The selected entry is provided as parameter
7	if(entry.equals(entries[0])){
8	//entry 1 selected ("Spawn NPC")
9	}
10	else if(entry.equals(entries[1])){
11	//entry 2 selected ("Spawn Vehicle")
12	}
13	else if(entry.equals(entries[2])){
14	//entry 3 selected ("Spawn Item")
15	}
16	});

Example #2: Show context menu and use the mouse cursor to select an entry

1	//Set up the entries for the context menu
2	String[] entries = new String[]{"Selection 1", "Selection 2"};
3
4	//Enable the mouse cursor
5	player.setMouseCursorVisible(true);
6
7	//Show the context menu and set up a callback to handle the player selection
8	player.showContextMenu(entries, (String entry) -> {
9	//Remember to disable the mouse cursor again
10	player.setMouseCursorVisible(false);
11	});

stopInput
```
void stopInput(boolean stopMovement,
               boolean stopActions)
```
Stops / aborts the current input actions. For example, if the player is currently digging with a pickaxe (by holding his left mouse button), and you call this method, the player will stop his actions. If he wants to continue to dig, he has to release his mouse button and press it again.

Parameters:

stopMovement - true if you want to stop movement input (e.g. WASD). If causes the character to stop (if he's currently moving).

stopActions - true if you want to stop interaction input, e.g. primary and secondary mouse buttons and interaction key (F by default).

registerKeys

void registerKeys(int... keys)

Defines the key inputs the client should forward to the server.

Parameters:

keys - all key codes the game should listen for.

See Also:

KeyInput

Example:

1	//Registers keys W, A, S and D
2	player.registerKeys(KeyInput.KEY_W, KeyInput.KEY_A, KeyInput_Key_S, KeyInput.KEY_D);
3
4	//Set listening to true, otherwise the client will not forward any input
5	player.setListenForKeyInput(true);

unregisterKeys
```
void unregisterKeys(int... keys)
```
Unregisters a key (or multiple keys), so the client no longer forwards the input to the server.

Parameters:

keys - the key codes you want to unregister

See Also:

KeyInput

isKeyRegistered
```
boolean isKeyRegistered(int key)
```
Checks if a particular key is already registered.

Parameters:

key - the key you want to check if it's registered.

Returns:

true if the key is registered, false if not.

See Also:

KeyInput

getRegisteredKeys
```
int[] getRegisteredKeys()
```
Gets all keys that are registered.

Returns:

an array (which will be created upon call) containing all key codes, or null if no keys are registered.

See Also:

KeyInput

setListenForKeyInput
```
void setListenForKeyInput(boolean set)
```
Sets if the client should forward his key input to the server or not.

Parameters:

set - true to forward the key inputs, false if not.

isListeningForKeyInput
```
boolean isListeningForKeyInput()
```
Determines if the client does forward his key input to the server or not.

Returns:

true if input will be forwarded to the server, false if not.

disableClientsideKeys

void disableClientsideKeys(int... keys)

Disables certain keys for the client. It doesn't matter if the key has any binding. This does not affect chat or console input. If you want to re-enable the keys again, you can call enableClientsideKeys(). Note: If a plugin registered a key (see registerKeys(int...), these key inputs won't be processed client side, but they will still be forwarded to the plugin.

Important: This method has nothing to do with registerKeys(int...) or setListenForKeyInput(boolean)

Parameters:

keys - the keys you want to disable.

See Also:

KeyInput

Example: Disable keys W, A, S, D

1	//Note: After disabling the keys, these inputs won't be processed by the
2	//client anymore. For example, if the client uses W, A, S, D as his movement
3	keys, he won't be able to move his character anymore.
4	player.disableClientsideKeys(KeyInput.KEY_W, KeyInput.KEY_A, KeyInput.KEY_S, KeyInput.KEY_D);

enableClientsideKeys
```
void enableClientsideKeys()
```
Re-enables all keys which have been disabled by calling disableClientsideKeys(int...).

Important: This method has nothing to do with registerKeys(int...) or setListenForKeyInput(boolean)

enableClientsideKeys
```
void enableClientsideKeys(int... keys)
```
Re-enables certain keys which have been disabled by calling disableClientsideKeys(int...). If you want to enable all keys again, call enableClientsideKeys() instead.

Important: This method has nothing to do with registerKeys(int...) or setListenForKeyInput(boolean)

Parameters:

keys - the keys you want to enable again.

See Also:

KeyInput

setMouseCursorVisible
```
void setMouseCursorVisible(boolean set)
```
Toggles the visibility of the mouse cursor. Useful if any custom gui interactions are needed.
If the cursor is set to visible, the player is unable to move anymore. You have to hide the cursor explicitly in order to unfreeze the player (in other words, the player has no chance to hide the cursor by himself).

Parameters:

set - true to show the mouse cursor, false to hide it.

setMouseCursorCoordinates
```
void setMouseCursorCoordinates(float x,
                               float y,
                               boolean relative)
```
Moves the mouse cursor of the client to the specified xy coordinates.
Note: This even works when the cursor isn't visible (so the cursor position will still be updated in the background).

Parameters:

x - the x target coordinate

y - the y target coordinate

relative - if set to true, relative target coordinates (0.0-1.0) will be used, otherwise the target coordinates will be treated as absolute coordinates.

executeConsoleCommand
```
void executeConsoleCommand(java.lang.String command)
```
Executes a console command for this player. The ingame console can be opened by pressing ` or ~ or # or ^ (depending on the keyboard layout).
Note that this function does not override any permissions, this means if the player is not allowed to execute a certain command, you cannot execute it with this function either (first you have to change the permissions in this case).

Parameters:

command - the command you want to execute. It's exactly the same as if the player typed this command into his console (he even get a response in the console).

Example: Toggle wireframe mode for a player
1 Player player = getServer().getPlayer("Steve");
2 player.executeConsoleCommand("wireframe");

isConnected
```
boolean isConnected()
```
Gets whether or not the player is (still) connected.

Returns:

true if the player is connected to the server, false if not.

getPing
```
int getPing()
```
Gets the current ping of the player, in other words, the amount of time (in milliseconds) that passes until a player packet arrives at the server. Only relevant in multiplayer.

Returns:

the current ping (ms) of the player.

getIP
```
java.lang.String getIP()
```
Gets the ip of the player (only relevant in multiplayer). When playing via Steam P2P, this function returns the SteamID64 of the player (e.g. "76561197970685866").

Returns:

a string containing the ip address of the player (or the SteamID64 when playing via Steam P2P, or an empty string when playing singleplayer).

kick
```
void kick(java.lang.String reason)
```
Kicks the player from the server. The provided reason is displayed on the screen of the kicked player.

Parameters:

reason - a string containing the reason why the player was kicked.

ban
```
void ban(java.lang.String reason)
```
Bans the player permanently from the server. The provided reason is displayed on the screen of the banned player.

Parameters:

reason - a string containing the reason why the player was banned.

ban
```
void ban(java.lang.String reason,
         int duration)
```
Bans the player from the server for a given amount of time. The provided reason is displayed on the screen of the banned player.

Parameters:

reason - a string containing the reason why the player was banned.

duration - the duration (in minutes) how long the player will be banned. Use '-1' to ban the player permanently.

Example: Ban a player for 3 days (==4320 minutes)
1 player.ban("Griefing and flaming", 4320);

enableAreaSelectionTool

void enableAreaSelectionTool()

Enables the "area selection tool" for this player. This enables the player to select an area. To stop the "area selection tool", you can call disableAreaSelectionTool(). If you want to retrieve the selection result (i.e. the selected area), you can call getAreaSelectionData(net.risingworld.api.callbacks.Callback) and provide a proper Callback object.
Example

Example: Enable area selection tool for a player when he types a command

1	`@`EventMethod
2	public void onCommand(PlayerCommandEvent event){
3	//split the command
4	String[] cmd = event.getCommand().split(" ");
5
6	//now check if the command starts with "/select", for example
7	if(cmd[0].equals("/select")){
8	//enable selection tool for player
9	event.getPlayer().enableAreaSelectionTool();
10	}
11	}

setAreaSelectionData
```
void setAreaSelectionData(Area area)
```
Sets an area for the "area selection tool" for this player, i.e. the selection tool will adapt to the position and size of the provided area.
This only works if the area selection tool is currently active (to enable it, call enableAreaSelectionTool())

Parameters:

area - the area you want to adapt the selected area to. Provide null to reset the selected area (this means the player has to set a new start and end position).

getAreaSelectionData

void getAreaSelectionData(Callback<Area> callback)

Gets the currently selected area. This only returns a proper Area if the "area selection tool" is currently enabled and if a start and end position is selected. Otherwise, null is returned.
Since all data needs to be queried from the client, this method uses a Callback.

Parameters:

callback - the Callback object. It will be called once the Area object has been retrieved from the player. The particular Area will be passed as argument (or null if no area was selected).

Example #1: Retrieve the selected area. Using lambda expression (Java 8))

1	player.getAreaSelectionData((Area result) -> {
2	//if result is null, player did not select an area
3	if(result == null){
4	System.out.println("No area received from player! :( ");
5	}
6	//otherwise you can access the "Area" object
7	else{
8	System.out.println("Area received: "+result); //prints the area data
9	}
10	});

Example #2: Same example as above, but without using lambda expression (instead pass "old style" anonymous class)

1	player.getAreaSelectionData(new Callback<Area>(){
2	`@`Override
3	public void onCall(Area result){
4	//if result is null, player did not select an area
5	if(result == null){
6	System.out.println("No area received from player!");
7	}
8	//otherwise you can access the "Area" object
9	else{
10	System.out.println("Area received: "+result);
11	}
12	}
13	});

disableAreaSelectionTool
```
void disableAreaSelectionTool()
```
Disables the "area selection tool" for this player. Does nothing if the "area selection tool" is currently not active.
Remember to get the currently selected Area by calling getAreaSelectionData(net.risingworld.api.callbacks.Callback) first, otherwise the selected area will be discarded.

See Also:

getAreaSelectionData(net.risingworld.api.callbacks.Callback), enableAreaSelectionTool()

setListenForObjectInteractions
```
void setListenForObjectInteractions(boolean set)
```
Deprecated. Method is no longer used. Now interactions of players with objects (like furniture) are always forwarded to the server (and they are also cancellable).
Calling this method has no effect.

Parameters:

set - N/A

isListeningForObjectInteractions
```
boolean isListeningForObjectInteractions()
```
Deprecated. Method is no longer used. Now interactions of players with objects (like furniture) are always forwarded to the server (and they are also cancellable), so this method returns always true

Returns:

always true

getScreenToWorldPosition

void getScreenToWorldPosition(float x,
                              float y,
                              boolean relativeposition,
                              Callback<Vector3f> callback)

Performs a raycast from the screen xy position. In other words, the game checks the nearest collision (with terrain, block, constructions etc) at the given screen position.
This method basically does the same as raycastFromScreenPosition(float, float, boolean, int, net.risingworld.api.callbacks.Callback), with the exception that it returns a Vector3f (the collision point) instead of a RayCastResult.

Since all data needs to be queried from the client, this method uses a Callback.

Please keep in mind that raycasting can have a noticeable impact on the client performance (framerate), so use it with caution!

Parameters:

x - the horizontal screen position (x).

y - the vertical screen position (y).

relativeposition - set to false to use absolute screen coordinates (i.e. pixel coordinates), or true to use relative screen coordinates (range between 0.0 and 1.0)

callback - the Callback object. It will be called once the Vector3f object has been retrieved from the player. The particular Vector3f will be passed as argument (or null if no collision was found, for example when the player looks towards the sky etc).

Example: Get collision point in the center of the player screen (crosshair position)

1	player.getScreenToWorldPosition(0.5f, 0.5f, true, (Vector3f collisionPoint) -> {
2	//if collisionPoint is null, no collision was found (maybe the player
3	//currently looks towards the sky etc)
4	if(collisionPoint != null){
5	System.out.println("Collision in front of player at: "+collisionPoint);
6	}
7	});

raycast

void raycast(int collisionType,
             Callback<RayCastResult> callback)

Performs a raycast from the player view position to the player view direction, i.e. from the cam position to the center of the screen (crosshair). The game checks the nearest collision (e.g. terrain, constructions etc, this can be specified with a bitmask).

Since all data needs to be queried from the client, this method uses a Callback.

Please keep in mind that raycasting can have a noticeable impact on the client performance (framerate), so use it with caution!

Parameters:

collisionType - the collision type (bitmask). This value specifies which collidables should be taken into account when performing the raycast. See CollisionType
Only use the collision types you actually need, since adding too many unnecessary collision types can be very expensive.

callback - the Callback object. It will be called once the RayCastResult object has been retrieved from the player. The particular RayCastResult will be passed as argument (or null if no collision was found, for example when the player looks towards the sky etc).

raycastFromWorldPosition(net.risingworld.api.utils.Vector3f, net.risingworld.api.utils.Vector3f, int, net.risingworld.api.callbacks.Callback)

Example #1: Find out if player looks at other players

1	player.raycast(CollisionType.PLAYERS, (RayCastResult result) -> {
2	//if result is null, no collision was found
3	if(result != null){
4	//check the distance of the collision
5	if(result.getDistance() < 10){
6	//if dist < 10 units show message
7	p.sendYellMessage("Do not look at other players!");
8	}
9	}
10	});

Example #2: Find collision point (on terrain, constructions or objects)

1	//get collision bitmask: terrain, constructions and objects
2	int collisionType = CollisionType.getBitmask(CollisionType.TERRAIN, CollisionType.CONSTRUCTIONS, CollisionType.OBJECTS);
3
4	//perform raycast
5	player.raycast(collisionType, (RayCastResult result) -> {
6	//if result is null, no collision was found
7	if(result != null){
8	//get the "contact point" (i.e. the position where the collision occurred)
9	Vector3f contact = result.getCollisionPoint();
10
11	//now do something with this information, e.g. create a model there, teleport the player etc.
12	player.sendTextMessage("Contact at " + contact);
13	}
14	});

raycast
```
void raycast(Vector3f direction,
             int collisionType,
             Callback<RayCastResult> callback)
```
Performs a raycast from the player view position to the provided direction. The game checks the nearest collision (e.g. terrain, constructions etc, this can be specified with a bitmask).

Since all data needs to be queried from the client, this method uses a Callback.

Please keep in mind that raycasting can have a noticeable impact on the client performance (framerate), so use it with caution!

Parameters:

direction - the direction of the ray. If you want to use the player view direction, you can call raycast(int, net.risingworld.api.callbacks.Callback) instead.

collisionType - the collision type (bitmask). This value specifies which collidables should be taken into account when performing the raycast. See CollisionType
Only use the collision types you actually need, since adding too many unnecessary collision types can be very expensive.

callback - the Callback object. It will be called once the RayCastResult object has been retrieved from the player. The particular RayCastResult will be passed as argument (or null if no collision was found, for example when the player looks towards the sky etc).

See Also:

raycast(int, net.risingworld.api.callbacks.Callback), raycastFromScreenPosition(float, float, boolean, int, net.risingworld.api.callbacks.Callback), raycastFromWorldPosition(net.risingworld.api.utils.Vector3f, net.risingworld.api.utils.Vector3f, int, net.risingworld.api.callbacks.Callback)

raycastFromScreenPosition
```
void raycastFromScreenPosition(float x,
                               float y,
                               boolean relativeposition,
                               int collisionType,
                               Callback<RayCastResult> callback)
```
Performs a raycast from the screen xy position. In other words, the game checks the nearest collision at the given screen position (e.g. terrain, constructions etc, this can be specified with a bitmask).

Since all data needs to be queried from the client, this method uses a Callback.

Please keep in mind that raycasting can have a noticeable impact on the client performance (framerate), so use it with caution!

Parameters:

x - the horizontal screen position (x).

y - the vertical screen position (y).

relativeposition - set to false to use absolute screen coordinates (i.e. pixel coordinates), or true to use relative screen coordinates (range between 0.0 and 1.0)

collisionType - the collision type (bitmask). This value specifies which collidables should be taken into account when performing the raycast. See CollisionType
Only use the collision types you actually need, since adding too many unnecessary collision types can be very expensive.

callback - the Callback object. It will be called once the RayCastResult object has been retrieved from the player. The particular RayCastResult will be passed as argument (or null if no collision was found, for example when the player looks towards the sky etc).

raycastFromWorldPosition
```
void raycastFromWorldPosition(Vector3f position,
                              Vector3f direction,
                              int collisionType,
                              Callback<RayCastResult> callback)
```
Performs a raycast from a world position. The game checks the nearest collision (e.g. terrain, constructions etc, this can be specified with a bitmask). The raycast is executed by the client (the player), so it can only take the world that's currently rendered into account (i.e. you can only perfom this raycast in the proximity of the player, depending on his view settings).

Since all data needs to be queried from the client, this method uses a Callback.

Please keep in mind that raycasting can have a noticeable impact on the client performance (framerate), so use it with caution!

Parameters:

position - the origin of the ray, i.e. where the world position you want to start the ray from.

direction - the direction of the ray.

collisionType - the collision type (bitmask). This value specifies which collidables should be taken into account when performing the raycast. See CollisionType
Only use the collision types you actually need, since adding too many unnecessary collision types can have a big impact on performance.

callback - the Callback object. It will be called once the RayCastResult object has been retrieved from the player. The particular RayCastResult will be passed as argument (or null if no collision was found, for example when the player looks towards the sky etc).

addGuiElement
```
void addGuiElement(GuiElement guiElement)
```
Attaches a GUI element to the player's hud. This GUI element is only visible for this player.

Parameters:

guiElement - the GUI element you want to attach.

addGuiElement
```
void addGuiElement(GuiElement guiElement,
                   java.lang.String parent)
```
Attaches a GUI element to the player's screen. This GUI element is only visible for this player.

Parameters:

guiElement - the GUI element you want to attach.

parent - the parent GUI element, or more precisely, the element where you want to attach this element to. Has no effect if this element is a child. Example parent names: "Inventory", "Crafting", "HudLayer", "LoadingLayer", "InGameMenu", "Crosshair", "Journal" etc.

removeGuiElement
```
void removeGuiElement(GuiElement guiElement)
```
Removes a GUI element from the player's hud. If the specified GUI element does not exist, nothing happens.

Parameters:

guiElement - the GUI element you want to remove.

removeAllGuiElements
```
void removeAllGuiElements()
```
Removes all GUI elements that are attached to the player's hud.

setGuiElementVisible
```
void setGuiElementVisible(GuiElement element,
                          boolean visible)
```
Changes the visibility of the GUI element only for this player. This calling this method ignores the current visibility state of the GUI element (see GuiElement.setVisible(boolean)). However, changes to the GUI element itself will restore the original visibility value of the GUI element.
Note: This does only work for GUI elements which have already been added to the player GUI by calling addGuiElement(net.risingworld.api.gui.GuiElement)

Parameters:

element - the GUI element.

visible - true to show the GUI element, false to hide it.

getScreenResolutionX
```
int getScreenResolutionX()
```
Gets the current screen width (horizontal resolution) the player set for his game.

Returns:

the screen width (e.g. 1920)

getScreenResolutionY
```
int getScreenResolutionY()
```
Gets the current screen height (vertical resolution) the player set for his game.

Returns:

the screen height (e.g. 1080)

addWorldElement
```
void addWorldElement(WorldElement worldElement)
```
Adds the provided WorldElement to the player's world. Only the player can see this object.

Parameters:

worldElement - The WorldElement you want to add to the player's world.

removeWorldElement
```
void removeWorldElement(WorldElement worldElement)
```
Removes a WorldElement from the player's world. If the specified element does not exist in the player's world, nothing happens.

Parameters:

worldElement - the WorldElement you want to remove.

removeAllWorldElements
```
void removeAllWorldElements()
```
Removes all WorldElements from the player's world.

getAllWorldElements

java.util.List<WorldElement> getAllWorldElements()

playSound
```
int playSound(SoundInformation sound)
```
Plays a custom 2D sound (i.e. it can be heard everywhere, but only by this player). This sound only plays once with default volume and pitch (1.0)
Note: Make sure you use a mono sound when playing it as a 2D sound.

Parameters:

sound - the SoundInformation object which refers to the custom sound file.

Returns:

an internal ID of this new sound instance. This may be relevant when playing a loop sound, then you can stop the sound by providing this ID.

playSound
```
int playSound(SoundInformation sound,
              Vector3f position)
```
Plays a custom 3D sound at the given position. This sound can only be heard by this player. This sound only plays once with default volume and pitch (1.0)

Parameters:

sound - the SoundInformation object which refers to the custom sound file.

position - the world position of the sound. Provide null if you want to play this sound as a 2D sound instead (this means the sound has no actual position and can be heard everywhere).

Returns:

an internal ID of this new sound instance. This may be relevant when playing a loop sound, then you can stop the sound by providing this ID.

playSound

int playSound(SoundInformation sound,
              boolean loop,
              float volume,
              float pitch,
              float minDistance,
              float maxDistance,
              Vector3f position)

Plays a custom 3D sound at the given position. This sound can only be heard by this player.

Parameters:

sound - the SoundInformation object which refers to the custom sound file.

loop - determines if this sound should play as a loop (i.e. it repeats indefinitely). If true, the sound will only stop when calling stopSound(int).

volume - the sound volume (default: 1.0)

pitch - the sound pitch (default: 1.0)

minDistance - the distance that the sound emitter will cease to continue growing louder at (the further you move to the center of the sound). Within the minimum distance, the sound stays at the constant loudest possible volume (default: 1.0)

maxDistance - the distance the sound becomes silent. The sound volume is interpolated between minDistance and maxDistance (default: 50.0). Sound uses a linear-square-rolloff (minDistance == full volume, maxDistance == silence).

position - the world position of the sound. Provide null if you want to play a 2D sound instead (this means the sound has no actual position and can be heard everywhere).

Returns:

an internal ID of this new sound instance. This may be relevant when playing a loop sound, then you can stop the sound by providing this ID.

Example: Play a loop sound for a wind mill

1	// load the "windmill.ogg" sound from the assets folder in the plugin directory
2	SoundInformation info = new SoundInformation(getPath() + "/assets/windmill.ogg");
3
4	// get the player we want to play the sound for
5	Server server = getServer();
6	Player player = server.getPlayer("Testplayer");
7
8	// play the sound as loop at a given position, with default volume (1f) and pitch (1f)
9	player.playSound(info, true, 1f, 1f, 10f, 100f, new Vector3f(250f, 75f, -42f));

playGameSound
```
int playGameSound(java.lang.String name)
```
Plays an ingame sound effect at the position of the player which can only be heard by this player. This can be used for notification sounds, for example. Here is an overview of a few sounds:

gui_click // Clicking sound in GUI message // Incoming private chat message trade_success // Sound when trading was successful item_switch //Switching the equipped item warning_proximity //Warning sound when too close to a block piano_1, piano_2, ... piano_61 //Piano sounds

Parameters:

name - the name of the sound effect.

Returns:

an internal ID of this new sound instance. This may be relevant when playing a loop sound, then you can stop the sound by providing this ID.

See Also:

playGameSound(java.lang.String, net.risingworld.api.utils.Vector3f)

Example: Play a warning sound
1 player.playGameSound("warning_proximity");

playGameSound

int playGameSound(java.lang.String name,
                  Vector3f position)

Plays an ingame sound effect at the given world position which can only be heard by this player.

Parameters:

name - the name of the sound effect.

position - the world position where the sound will be played.

Returns:

an internal ID of this new sound instance. This may be relevant when playing a loop sound, then you can stop the sound by providing this ID.

See Also:

playGameSound(java.lang.String)

Example #1: Play a bear idle sound at the player location

1	Vector3f playerPos = player.getPosition();
2	player.playGameSound("bear_idle", playerPos);
3	//there are also other bear sounds, like bear_attack, bear_hurt etc.

Example #2: Play a campfire loop sound at a specific position

1	//Position of the sound effect, in this case at -100, 40, 250
2	Vector3f pos = new Vector3f(-100, 40, 250);
3	//Play the sound effect. Calling the method returns an ID, use this
4	//ID if you want to stop the sound
5	int id = player.playGameSound("campfire_burning", pos);

playGameSound
```
int playGameSound(java.lang.String name,
                  Vector3f position,
                  java.lang.String parameter,
                  float parameterValue)
```
Plays an ingame sound effect at the given world position.

Parameters:

name - the name of the sound effect.

position - the world position where the sound will be played.

parameter - an optional sound parameter that can be set. Set null if you don't want to provide an parameter. Note that only certain sounds have parameters.

parameterValue - the parameter value (has no effect if parameter is set to null).

Returns:

an internal ID of this new sound instance. This may be relevant when playing a loop sound, then you can stop the sound by providing this ID.

See Also:

playGameSound(java.lang.String)

stopSound

void stopSound(int soundID)

Stops a sound effect. This is only necessary when playing a loop sound, for example.

Parameters:

soundID - the internal ID of the sound instance you want to stop.

Example:

1	//Play game sound at world origin (coordinates 0, 0, 0)
2	int id = player.playGameSound("water_stream", Vector3f.ZERO);
3	//...
4	//...
5	//Stop the sound if you don't want it to play anymore
6	player.stopSound(id);

setSoundPosition
```
void setSoundPosition(int soundID,
                      Vector3f position)
```
Changes the position of a sound. Only works if the sound isn't a 2D sound.

Parameters:

soundID - the internal ID of the sound instance.

position - the new world position.

setSoundVolume
```
void setSoundVolume(int soundID,
                    float volume)
```
Changes the volume of a sound instance.
Only works for custom sounds!

Parameters:

soundID - the internal ID of the sound instance.

volume - the new sound volume (default: 1.0)

setSoundPitch
```
void setSoundPitch(int soundID,
                   float pitch)
```
Changes the pitch of a sound instance.
Only works for custom sounds!

Parameters:

soundID - the internal ID of the sound instance.

pitch - the new sound pitch (default: 1.0)

setSoundTimelinePosition
```
void setSoundTimelinePosition(int soundID,
                              float position,
                              boolean relative)
```
Changes the track position / timeline position of the sound.

Parameters:

soundID - the internal ID of the sound instance.

position - the new timeline position in seconds. If "relative" is true, use a value between 0 and 1.

relative - false to use absolute values (seconds), true to use a value relative to the total length of the sound (0-1).

enableGameMusic
```
void enableGameMusic()
```
Enables the ingame music. This only has an effect if disableGameMusic() has been called previously.

disableGameMusic

void disableGameMusic()

Disables the ingame music. This stops the currently playing (if any) music track and prevents the game from playing another music track until enableGameMusic() was called. This does not affect the main theme (which can be heared only in main menu and during the loading screen).

Example: Disable default game music and play custom music track every 10 minutes instead. Note: This is a basic example! It would be cooler if you load several music tracks, store them in a list, and pick a random one when the timer triggers

1	//Create a new SoundInformation object which refers to the sound track
2	SoundInformation soundInfo = new SoundInformation(getPath() + "/music/myTheme.mp3");
3
4	//Enable streaming - this is highly recommended for big sound files like music
5	soundInfo.setStreamed(true);
6
7
8	//... somewhere in your event listener ...
9
10
11	//We grab the PlayerSpawnEvent, which is called when the player is fully
12	//connected to the server
13	`@`EventMethod
14	public void onPlayerSpawn(PlayerSpawnEvent evt){
15	Player player = evt.getPlayer();
16
17	//Disable the default game music for the player
18	player.disableGameMusic();
19
20	//Create a timer which plays the music every 10 minutes, with initial delay of 1 minute.
21	//Note: Since we want to access the timer reference from within the task (the Runnable),
22	//we first have to set a null task, then assign the Runnable in an additional step
23	//(otherwise you will run into a "variable might not have been initialized" error)
24	final Timer timer = new Timer(600, 60, -1, null);
25	timer.setTask(() -> {
26	//If player is connected, we play the custom music track for him (provide "null" as position in order to play it as 2D sound)
27	if(player.isConnected()){
28	player.playSound(soundInfo, false, 1.0f, 1.0f, 10f, 100f, null);
29	}
30	//...otherwise, if the player isn't connected anymore, we kill this timer
31	else{
32	timer.kill();
33	}
34	});
35
36	//Remember to start the timer
37	timer.start();
38	}

connectToTeamSpeak
```
void connectToTeamSpeak(java.lang.String ip,
                        int port,
                        java.lang.String channel)
```
Connects the client to a TeamSpeak server, but only as long as TeamSpeak is installed on the client computer, and only if the client accepts to connect.

Please note: This does only work if the client uses Windows!

Parameters:

ip - the target ip address of the TeamSpeak server.

port - the target port of the TeamSpeak server.

channel - the target channel the client should join on connect. To join a subchannel, you have to use a slash (e.g. "channel/subchannel").

Example:
1 //Connect to IP 127.0.0.1, port 9987, channel "EntranceHall"
2 player.connectToTeamSpeak("127.0.0.1", 9987, "EntranceHall");

connectToDiscord
```
void connectToDiscord(java.lang.String url)
```
Connects the client to a Discord server, or more precisely, it opens the url to the Discord server in the web browser.

Parameters:

url - the url to the Discord server, for example "https://discord.gg/ay21koSP" or "https://discordapp.com/invite/example" etc.

Example:
1 player.connectToDiscord("https://discord.gg/abcdef123");

createScreenshot
```
void createScreenshot(float sizeFactor,
                      Callback<java.awt.image.BufferedImage> callback)
```
Creates a screenshot of the player screen and convert it into a BufferedImage.

Parameters:

sizeFactor - the size factor of the image (1.0f is original width/height, 0.5f is half widht/height etc).

callback - this callback will be called once the screenshot has been uploaded to the server. The screenshot is passed as BufferedImage obejct. Uploading the screenshot may take a few seconds depending on the bandwidth, traffic and screenshot size.

requestMapTileRaw
```
void requestMapTileRaw(int x,
                       int y,
                       java.lang.String controlHash,
                       Callback<byte[]> callback)
```
Requests a raw map tile from a client. When calling this method, the client reads the bytes of the map tile file and sends them to the server. Keep in mind that this data is always compressed, so you have to decompress it before working with it (see Utils.ByteUtils#decompress(byte[])). The bytes represent an 8 bit RGBA image.

A map tile always represents 3x3 chunks. Map tiles are arranged like this (x|y):
[2|2] [1|2] [0|2] [-1|2] [-2|2]
[2|1] [1|1] [0|1] [-1|1] [-2|1]
[2|0] [1|0] [0|0] [-1|0] [-2|0]
[2|-1] [1|-1] [0|-1] [-1|-1] [-2|-1]
[2|-2] [1|-2] [0|-2] [-1|-2] [-2|-2]

Warning: Do not use the byte array with an ImageInformation object, since the map tile data use a different format! If you want to work with the byte array, you can turn it into a BufferedImage by calling Utils.ImageUtils#rawMapTileToBufferedImage(byte[]) after decompressing the array.

Parameters:

x - the x coordinate of the map tile (horizontal, from right to left).

y - the y coordinate of the map tile (vertical).

controlHash - optional md5 control hash. Compares the client side byte[] with this hash and only transfers the bytes to the server if the hash does not match. Provide null to disable this check.

callback - this callback will be called once the map tile data has been uploaded to the server. The map tile data will be passed as raw byte array. If the map tile does not exist (i.e. if this part of the map hasn't been explored by the player yet), null is passed instead. Same happens if a controlHash is set and the client side hash matches the server side hash.

1	Player player = getServer().getPlayer("C3PO");
2	player.setPermissionValue("general_fly", false);

1	Player player = getServer().getPlayer("Luke");
2	player.setPermissionValue("customimages_maxupload", 20);

1	//Hex red color (RGB) is #FF0000
2	player.sendTextMessage("[#FF0000]This is a red text");

1	//Hex red color is #FF0000, hex green color is #00FF00, hex blue color is #0000FF
2	player.sendTextMessage("[#FF0000]This part is red, [#00FF00]This part is green, [#0000FF]This part is blue");

1	//Enable refractions
2	player.setSetting("graphic_refractions", true);

1	List<Area> areas = player.getCurrentAreas();
2	for(Area area : areas){
3	//do something with the "area"
4	}

1	//Intensity 1 (just try out some values)
2	player.shake(1.0f, 10.0f);

1	if(player.hasBrokenBones()){
2	player.setBrokenBones(false);
3	}

1	Player player = getServer().getPlayer("Steve");
2	player.executeConsoleCommand("wireframe");

1	//Connect to IP 127.0.0.1, port 9987, channel "EntranceHall"
2	player.connectToTeamSpeak("127.0.0.1", 9987, "EntranceHall");

1	if(player.getHunger() < 10){
2	player.setHunger(100);
3	}

1	if(player.getThirst() < 10){
2	player.setThirst(100);
3	}

Interface Player

Method Summary

Method Detail

getID

getUID

getDbID

getName

setName

getLastTimeOnline

getCurrentPlayTime

getTotalPlayTime

getPermissionGroup

setPermissionGroup

getPermissionValue

setPermissionValue

isAdmin

setAdmin

getInventory

getEquippedItem

setEquippedItem

sendTextMessage

sendYellMessage

showStatusMessage

setOption

getOption

setAttribute

getAttribute

hasAttribute

deleteAttribute

getPosition

setPosition

setPosition

moveTo

moveTo

getChunkPosition

getBlockPosition

setChunkAndBlockPosition

setChunkAndBlockPosition

getRotation

setRotation

setRotation

getViewDirection

setViewDirection

setViewDirection

getHeading

getCardinalDirection

getCurrentAreas

shake

isSpawned

isFishing

isInVehicle

isSprinting

isWalking

isCrouching

isLaying

isSitting

isPlayingPiano

isInWater

isUnderWater

isInLava

isIndoor

isInCave

isSleeping

setCreativeModeEnabled

isCreativeModeEnabled

getHealth

getMaxHealth

setHealth

getArmor

getMaxArmor

getHunger

setHunger

getThirst

setThirst

hasBrokenBones

setBrokenBones

isBleeding

setBleeding

getStamina

getWetness