Added extra documentation to Level::setBlock()

This commit is contained in:
Shoghi Cervantes 2014-09-03 11:44:30 +02:00
parent e17ecf5795
commit 0eac084aa7

View File

@ -861,6 +861,13 @@ class Level implements ChunkManager, Metadatable{
* Sets on Vector3 the data from a Block object,
* does block updates and puts the changes to the send queue.
*
* If $direct is true, it'll send changes directly to players. if false, it'll be queued
* and the best way to send queued changes will be done in the next tick.
* This way big changes can be sent on a single chunk update packet instead of thousands of packets.
*
* If $update is true, it'll get the neighbour blocks (6 sides) and update them.
* If you are doing big changes, you might want to set this to false, then update manually.
*
* @param Vector3 $pos
* @param Block $block
* @param bool $direct