SteamWar/FastAsyncWorldEdit
9
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Refactor 'Fawe' javadoc for better readibility

Browse Source 
Signed-off-by: Alexander Brandes <mc.cache@web.de>
This commit is contained in:
Alexander Brandes
2024-11-24 18:46:57 +01:00
parent 57cfa42e64
commit 3bd5b956c5
1 changed files with 22 additions and 28 deletions
Download Patch File Download Diff File Expand all files Collapse all files

46
worldedit-core/src/main/java/com/fastasyncworldedit/core/Fawe.java
View File

@ -46,40 +46,34 @@ import java.util.concurrent.TimeUnit;
/** /**
* [ WorldEdit action ] * [ WorldEdit action ]
* | * <br>
* \|/
* [ EditSession ] - The change is processed (area restrictions, change limit, block type) * [ EditSession ] - The change is processed (area restrictions, change limit, block type)
* | * <br>
* \|/
* [ Block change ] - A block change from some location * [ Block change ] - A block change from some location
* | * <br>
* \|/
* [ Set Queue ] - The SetQueue manages the implementation specific queue * [ Set Queue ] - The SetQueue manages the implementation specific queue
* | * <br>
* \|/
* [ Fawe Queue] - A queue of chunks - check if the queue has the chunk for a change * [ Fawe Queue] - A queue of chunks - check if the queue has the chunk for a change
* | * <br>
* \|/
* [ Fawe Chunk Implementation ] - Otherwise create a new FaweChunk object which is a wrapper around the Chunk object * [ Fawe Chunk Implementation ] - Otherwise create a new FaweChunk object which is a wrapper around the Chunk object
* | * <br>
* \|/
* [ Execution ] - When done, the queue then sets the blocks for the chunk, performs lighting updates and sends the chunk packet to the clients * [ Execution ] - When done, the queue then sets the blocks for the chunk, performs lighting updates and sends the chunk packet to the clients
* <p> * <p>
* Why it's faster: * Why it's faster:
* - The chunk is modified directly rather than through the API * <br> The chunk is modified directly rather than through the API
* \ Removes some overhead, and means some processing can be done async * - Removes some overhead, and means some processing can be done async
* - Lighting updates are performed on the chunk level rather than for every block * <br> Lighting updates are performed on the chunk level rather than for every block
* \ e.g., A blob of stone: only the visible blocks need to have the lighting calculated * - e.g., A blob of stone: only the visible blocks need to have the lighting calculated
* - Block changes are sent with a chunk packet * <br> Block changes are sent with a chunk packet
* \ A chunk packet is generally quicker to create and smaller for large world edits * - A chunk packet is generally quicker to create and smaller for large world edits
* - No physics updates * <br> No physics updates
* \ Physics updates are slow, and are usually performed on each block * - Physics updates are slow, and are usually performed on each block
* - Block data shortcuts * <br> Block data shortcuts
* \ Some known blocks don't need to have the data set or accessed (e.g., air is never going to have data) * - Some known blocks don't need to have the data set or accessed (e.g., air is never going to have data)
* - Remove redundant extents * <br> Remove redundant extents
* \ Up to 11 layers of extents can be removed * - Up to 11 layers of extents can be removed
* - History bypassing * <br> History bypassing
* \ FastMode bypasses history and means blocks in the world don't need to be checked and recorded * - FastMode bypasses history and means blocks in the world don't need to be checked and recorded
*/ */
public class Fawe { public class Fawe {