SBDevelopment/MapReflectionAPI
3
0
Fork 0
Code Issues 2 Pull requests 1 Activity Actions

Added multi frame info to readme

Browse source
This commit is contained in:
Stijn Bannink 2022-12-15 19:53:01 +01:00 • committed by GitHub
parent bb27360255
commit 8db25d4776
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 35 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

39
README.md
View file

@ -23,13 +23,13 @@ First, include the API using Maven:
Then, use our API. Below is an example. Then, use our API. Below is an example.
```java ```java
//Wrap image //--- Wrap image ---
MapWrapper wrapper = MapReflectionAPI.getMapManager().wrapImage(ImageIO.read(new File("image.png"))); MapWrapper wrapper = MapReflectionAPI.getMapManager().wrapImage(ImageIO.read(new File("image.png")));
MapController controller = wrapper.getController(); MapController controller = wrapper.getController();
final Player p = Bukkit.getPlayer("SBDeveloper"); final Player p = Bukkit.getPlayer("SBDeveloper");
//Add viewer //--- Add viewer ---
try { try {
controller.addViewer(p); controller.addViewer(p);
} catch (MapLimitExceededException e) { } catch (MapLimitExceededException e) {
@ -38,14 +38,45 @@ try {
} }
controller.sendContent(p); controller.sendContent(p);
//Show in frame //--- Show in frame ---
ItemFrame frame = ...; //This is your ItemFrame. ItemFrame frame = ...; //This is your ItemFrame.
controller.showInFrame(p, frame, true); controller.showInFrame(p, frame, true);
//Or show in hand //--- Or show in hand ---
controller.showInHand(p, true); controller.showInHand(p, true);
``` ```
It's also possible to split one image onto multiple itemframes. For example using the following code.
```java
//--- Wrap image ---
MapWrapper wrapper = MapReflectionAPI.getMapManager().wrapImage(ImageIO.read(new File("image.png")));
MapController controller = wrapper.getController();
final Player p = Bukkit.getPlayer("SBDeveloper");
//--- Add viewer ---
try {
controller.addViewer(p);
} catch (MapLimitExceededException e) {
e.printStackTrace();
return;
}
controller.sendContent(p);
//--- Show in frames ---
//These are your itemframes
ItemFrame leftTopFrame = ...;
ItemFrame leftBottomFrame = ...;
ItemFrame rightTopFrame = ...;
ItemFrame rightBottomFrame = ...;
ItemFrame[][] frames = {
{leftBottomFrame, leftTopFrame},
{rightBottomFrame, rightTopFrame}
};
controller.showInFrames(p, frames, true);
```
More information can be found on the [JavaDoc](https://sbdevelopment.tech/javadoc/mapreflectionapi/). More information can be found on the [JavaDoc](https://sbdevelopment.tech/javadoc/mapreflectionapi/).
## Credits: ## Credits: