Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Rubydesic committed Jun 27, 2022
1 parent d18544d commit 07c8d6b
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions ARCHITECTURE.MD
Original file line number Diff line number Diff line change
Expand Up @@ -25,3 +25,20 @@ Each ship is allocated a portion of the world called a ChunkClaim. A Minecraft
chunk is composed of 16 blocks, a ChunkClaim is composed of 512 chunks.
ChunkClaims are unique across dimensions, which means a ship in the Overworld
could not have the same ChunkClaim as a ship in the Nether.

## Ship Class Types

What class should I use if I want to represent a ship?

```mermaid
flowchart LR
side{Which Side?} --> |Client*| ShipObjectClient
side --> |Server| server-loaded{Loaded?}
side --> |Either| either-loaded{Loaded?}
server-loaded --> |Yes| ShipObjectServer
server-loaded --> |Maybe| ShipData
either-loaded --> |Yes| ShipObject
either-loaded --> |Maybe| ShipDataCommon
```

* No such thing as an unloaded ship on the client

0 comments on commit 07c8d6b

Please sign in to comment.