net.risingworld.api.events.player.gui

Class PlayerSelectFileEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.player.PlayerEvent

net.risingworld.api.events.player.gui.PlayerSelectFileEvent

public class PlayerSelectFileEvent
extends PlayerEvent

Called when a player selects a file in the GuiFileBrowser element. Note that the biggest supported file size is 2³¹-1 bytes. In general it's recommendable to not upload too large files.

Constructor Summary

Constructors

Constructor and Description
PlayerSelectFileEvent(Player player, GuiFileBrowser fileBrowser, java.lang.String filename, java.lang.String path, int bytes, java.lang.String md5)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getChecksum() Gets the MD5 checksum of the file.
GuiFileBrowser	getFileBrowserElement() Gets the file browser element.
java.lang.String	getFilename() Gets the name of the file (with extension), e.g.
int	getFilesize() Gets the size of the file (in bytes).
java.lang.String	getPath() Gets the (client side) path to the file, e.g.
void	requestFileUpload(java.lang.String targetDirectory, Callback<java.io.File> callback) Requests the client to upload the file to the server.

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

PlayerSelectFileEvent

public PlayerSelectFileEvent(Player player,
                             GuiFileBrowser fileBrowser,
                             java.lang.String filename,
                             java.lang.String path,
                             int bytes,
                             java.lang.String md5)

Method Detail

getFileBrowserElement

public GuiFileBrowser getFileBrowserElement()

Gets the file browser element.

Returns:

the file browser element.

getFilename

public java.lang.String getFilename()

Gets the name of the file (with extension), e.g. "image.png"

Returns:

the name of the file.

getPath

public java.lang.String getPath()

Gets the (client side) path to the file, e.g. "C:/Games/Rising World/Blueprints/test.blueprint"

Returns:

the file path (on the client side, i.e. on the players machine).

getFilesize

public int getFilesize()

Gets the size of the file (in bytes). Max file size is 2³¹-1 bytes, bigger files are not supported.

Returns:

the file size.

getChecksum

public java.lang.String getChecksum()

Gets the MD5 checksum of the file. This is useful to verify the data integrity.

Returns:

the MD5 checksum of the file.

requestFileUpload

public void requestFileUpload(java.lang.String targetDirectory,
                              Callback<java.io.File> callback)

Requests the client to upload the file to the server. Once the upload finishes (or fails), the according Callback will be called.

Parameters:

targetDirectory - the target directory (where the file will be uploaded to).

callback - the Callback object. It will be called once the file upload completes (or fails). The resulting File object will be passed as argument (or null if the upload failed).

Example: Request a model file and use it as ModelInformation

1	GuiFileBrowser fileBrowser = ...;
2	fileBrowser.setFileExtensionFilter("obj", "blend");
3
4	//Now find a player (so you can attach the file browser to his screen)
5	Player player = getServer().getPlayer("Guybrush");
6
7	//Attach the file browser to the screen of the player
8	player.addGuiElement(fileBrowser);
9
10	// SOMEWHERE IN YOUR EVENT LISTENER
11
12	@EventMethod
13	public void onPlayerSelectFile(PlayerSelectFileEvent event){
14	//Check if this event belongs to our file browser
15	if(event.getFileBrowserElement() == fileBrowser){
16	Player p = event.getPlayer();
17
18	//We could check if the file extension is correct, although this
19	//is not necessary, since we already set an extension filter to
20	//our file browser
21	if(event.getFilename().endsWith(".obj") || event.getFilename().endsWith(".blend")){
22
23	//Now we can request the client to upload the file to the server.
24	//We set up an individual target folder for this player in our
25	//particular plugin directory.
26	//Since the file upload takes some time, we have to use a Callback. In
27	//this Callback we put our whole file handling (i.e. what happens when
28	//the upload completes)
29	event.requestFileUpload(getPath() + "/UserModels/" + p.getName(), (File file) -> {
30	//If file does not exist or is null, cancel
31	if(file == null || !file.exists()){
32	System.out.println("File does not exist!");
33	return;
34	}
35
36	//Use this file as ModelInformation
37	ModelInformation modelInfo = new ModelInformation(file);
38
39	//Now you could use the ModelInformation for a World3DModel, for example
40	World3DModel model = new World3DModel(...);
41
42	//do something with the model
43	});
44	}
45	}
46	}