OpenSource/PaperMC
OpenSource/PaperMC
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-03-20 22:18:58 +01:00
Code Issues Projects Releases Packages Wiki Activity

Improve sendSignChange and related documentation

Browse source 
By: md_5 <git@md-5.net>
This commit is contained in:
Bukkit/Spigot 2023-06-14 18:36:11 +10:00
parent 738ff02e72
commit 54d5defe73
1 changed files with 13 additions and 4 deletions

17
paper-api/src/main/java/org/bukkit/entity/Player.java
View file

@ -638,10 +638,13 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
* a certain location. This will not actually change the world in any way.
* This method will use a sign at the location's block or a faked sign
* sent via
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.Material, byte)}.
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)}.
* <p>
* If the client does not have a sign at the given location it will
* display an error message to the user.
* <p>
* To change all attributes of a sign, including the back Side, use
* {@link #sendBlockUpdate(org.bukkit.Location, org.bukkit.block.TileState)}.
*
* @param loc the location of the sign
* @param lines the new text on the sign or null to clear it
@ -655,10 +658,13 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
* a certain location. This will not actually change the world in any way.
* This method will use a sign at the location's block or a faked sign
* sent via
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.Material, byte)}.
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)}.
* <p>
* If the client does not have a sign at the given location it will
* display an error message to the user.
* <p>
* To change all attributes of a sign, including the back Side, use
* {@link #sendBlockUpdate(org.bukkit.Location, org.bukkit.block.TileState)}.
*
* @param loc the location of the sign
* @param lines the new text on the sign or null to clear it
@ -674,10 +680,13 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
* a certain location. This will not actually change the world in any way.
* This method will use a sign at the location's block or a faked sign
* sent via
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.Material, byte)}.
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)}.
* <p>
* If the client does not have a sign at the given location it will
* display an error message to the user.
* <p>
* To change all attributes of a sign, including the back Side, use
* {@link #sendBlockUpdate(org.bukkit.Location, org.bukkit.block.TileState)}.
*
* @param loc the location of the sign
* @param lines the new text on the sign or null to clear it
@ -694,7 +703,7 @@ public interface Player extends HumanEntity, Conversable, OfflinePlayer, PluginM
* the given location. This will not actually change the world in any way.
* This method will use a TileState at the location's block or a faked TileState
* sent via
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.Material, byte)}.
* {@link #sendBlockChange(org.bukkit.Location, org.bukkit.block.data.BlockData)}.
* <p>
* If the client does not have an appropriate tile at the given location it
* may display an error message to the user.