net.risingworld.api.events.player

Class PlayerKeyEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.PlayerKeyEvent

public class PlayerKeyEvent
extends PlayerEvent

Called when a player presses or releases a key on his keyboard.
Please note that you have to register all keys that need to be forwarded to the server.

Example: Register keys and listen for key inputs

1	@EventMethod
2	public void onPlayerSpawn(PlayerSpawnEvent event){
3	Player player = event.getPlayer();
4
5	//Register keys 8, 9 and 0
6	player.registerKeys(KeyInput.KEY_8, KeyInput.KEY_9, KeyInput.KEY_0);
7
8	//Important: Set listen for key input to true, otherwise the PlayerKeyEvent will not be triggered
9	player.setListenForKeyInput(true);
10	}
11
12	@EventMethod
13	public void onKeyInput(PlayerKeyEvent event){
14	//We only want to process key presses (ignore key releases)
15	if(event.isPressed()){
16	//Check if 8 (KEY_8) is pressed
17	if(event.getKeyCode() == KeyInput.KEY_8){
18	//Do something, e.g. heal player
19	event.getPlayer().setHealth(100);
20	}
21	//Check if 9 (KEY_9) is pressed
22	else if(event.getKeyCode() == KeyInput.KEY_9){
23	//E.g. break player bones
24	event.getPlayer().setBrokenBones(true);
25	}
26	//Check if 0 (KEY_0) is pressed
27	else if(event.getKeyCode() == KeyInput.KEY_0){
28	//E.g. heal broken bones
29	event.getPlayer().setBrokenBones(false);
30	}
31	}
32	}

Constructor Summary

Constructors

Constructor and Description
PlayerKeyEvent(Player player, int key, boolean pressed)

Method Summary

Modifier and Type	Method and Description
int	getKeyCode() Gets the key code of the key that has been pressed by the player.
boolean	isPressed() Gets whether the key is pressed or released.

Methods inherited from class net.risingworld.api.events.player.PlayerEvent

getPlayer

Methods inherited from class java.lang.Object

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

Constructor Detail

PlayerKeyEvent

public PlayerKeyEvent(Player player,
                      int key,
                      boolean pressed)

Method Detail

getKeyCode

public int getKeyCode()

Gets the key code of the key that has been pressed by the player.

Returns:

the key code.

See Also:

KeyInput

isPressed

public boolean isPressed()

Gets whether the key is pressed or released.

Returns:

true if the key was pressed, false if it was released.